Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 17 extensions are included in analyses: ts, sh, py, md, json, js, gitignore, svg, npmignore, yml, txt, bat, ps1, gitattributes, eslintignore, npmrc, yaml
- 8 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (43 files).
- exclude files with path like ".*/bin/.*" (Binaries for distribution) (24 files).
- exclude files with path like ".*/git[-]history[.]txt" (Git history) (1 file).
- exclude files with path like ".*/git[-][a-zA-Z0-9_]+[.]txt" (Git data exports for sokrates analyses) (0 files).
- exclude files with path like ".*/[Pp]ackages\/.+\.\d+\/.*" (NuGet) (12 files).
- exclude files with path like ".*/docs/.*" (Documentation) (8 files).
- exclude files with path like ".*[.]txt" (Text files) (4 files).
- exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
- The source code folder contains 559 files:
- 411 files are included in analyses.
- 148 files are excluded from analyses:
Overview of Analyzed Files
Basic stats on analyzed files
Intro
For analysis purposes we separate files in scope into several categories: main, test, generated, deployment and build, and other.
- The main category contains all manually created source code files that are being used in the production.
- Files in the main category are used as input for other analyses: logical decomposition, concerns, duplication, file size, unit size, and conditional complexity.
- Test source code files are used only for testing of the product. These files are normally not deployed to production.
- Build and deployment source code files are used to configure or support build and deployment process.
- Generated source code files are automatically generated files that have not been manually changed after generation.
- While a source code folder may contain a number of files, we are primarily interested in the source code files that are being written and maintained by developers.
- Files containing binaries, documentation, or third-party libraries, for instance, are excluded from analysis. The exception are third-party libraries that have been changed by developers.
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
- The following criteria are used to filter files:
- files with paths like ".*".
- 155 files match defined criteria (13,598 lines of code, 100.0% vs. main code):
- 136 *.ts files (12,482 lines of code)
- 3 *.py files (600 lines of code)
- 3 *.ps1 files (293 lines of code)
- 12 *.js files (207 lines of code)
- 1 *.yaml files (16 lines of code)
- " *.ts" is biggest, containing 91.79% of code.
- " *.yaml" is smallest, containing 0.12% of code.
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
- The following criteria are used to filter files:
- files with paths like ".*/[Tt]est/.*".
- files with paths like ".*[.][Tt]est[.].*".
- files with paths like ".*[.]test[.].*".
- files with paths like ".*/test_.*".
- files with paths like ".*/[Tt]ests/.*".
- files with paths like ".*[-]test[-].*".
- files with any line of content like ".*/simpletest/.*".
- 76 files match defined criteria (25,526 lines of code, 187.7% vs. main code):
- 71 *.ts files (24,869 lines of code)
- 2 *.py files (528 lines of code)
- 3 *.sh files (129 lines of code)
- " *.ts" is biggest, containing 97.43% of code.
- " *.sh" is smallest, containing 0.51% of code.
Build and Deployment Code
Source code used to configure or support build and deployment process.
- The following criteria are used to filter files:
- files with paths like ".*[.]sh".
- files with paths like ".*/package[.]json".
- files with paths like ".*[.]git[a-z]+".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*[.]bat".
- files with paths like ".*/[.]gitattributes".
- 62 files match defined criteria (1,977 lines of code, 14.5% vs. main code):
- 61 *.sh files (1,975 lines of code)
- 1 *.bat files (2 lines of code)
- " *.sh" is biggest, containing 99.9% of code.
- " *.bat" is smallest, containing 0.1% of code.
Other Code
- The following criteria are used to filter files:
- files with paths like ".*[.]md".
- files with paths like ".*/README[.][a-z0-9]+".
- files with paths like ".*[.]npmrc".
- files with paths like ".*[.]json".
- files with paths like ".*/[.]npmignore".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*/[Ee]xamples/.*".
- files with paths like ".*[.]txt".
- files with paths like ".*/[.]eslintignore".
- 118 files match defined criteria (7,403 lines of code, 54.4% vs. main code):
- 24 *.md files (2,819 lines of code)
- 35 *.py files (1,792 lines of code)
- 35 *.json files (1,477 lines of code)
- 15 *.ts files (1,262 lines of code)
- 4 *.bat files (44 lines of code)
- 5 *.sh files (9 lines of code)
- " *.md" is biggest, containing 38.08% of code.
- " *.sh" is smallest, containing 0.12% of code.
Analyzers
Info about analyzers used for source code examinations.
- *.ts files are analyzed with TypeScriptAnalyzer:
- All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
- Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
- Unit size analysis
- Conditional complexity analysis
- No dependency analysis
- *.py files are analyzed with PythonAnalyzer:
- All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
- Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
- Unit size analysis
- Conditional complexity analysis
- Basic heuristic dependency analysis
- *.ps1 files are analyzed with DefaultLanguageAnalyzer:
- All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
- Basic code cleaning (empty lines removed for LOC calculations and duplication calculations)
- No unit size analysis
- No conditional complexity analysis
- No dependency analysis
- *.js files are analyzed with JavaScriptAnalyzer:
- All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
- Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
- Unit size analysis
- Conditional complexity analysis
- No dependency analysis
- *.yaml files are analyzed with YamlAnalyzer:
- All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
- Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
- No unit size analysis
- No conditional complexity analysis
- No dependency analysis
2022-01-31 15:17