Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 18 extensions are included in analyses: ts, md, json, yaml, bash, npmignore, feature, yml, txt, js, sh, xml, gitignore, properties, gitattributes, dockerignore, npmrc, io
- 7 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (35 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 ".*/docs/.*" (Documentation) (50 files).
- exclude files with path like ".*\.d\.ts" (Typescript definition files) (16 files).
- exclude files with path like ".*[.]txt" (Text files) (7 files).
- exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
- The source code folder contains 1,210 files:
- 1,046 files are included in analyses.
- 164 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 ".*".
- 723 files match defined criteria (57,747 lines of code, 100.0% vs. main code):
- 539 *.ts files (32,204 lines of code)
- 104 *.yaml files (16,785 lines of code)
- 63 *.bash files (5,007 lines of code)
- 13 *.yml files (3,280 lines of code)
- 4 *.js files (471 lines of code)
- " *.ts" is biggest, containing 55.77% of code.
- " *.js" is smallest, containing 0.82% 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 ".*[-]tests/.*".
- files with paths like ".*[.]feature".
- files with paths like ".*[.]spec[.]ts".
- files with paths like ".*_test[.].*".
- files with paths like ".*/[Tt]est/.*".
- files with any line of content like ".*/simpletest/.*".
- 99 files match defined criteria (10,712 lines of code, 18.5% vs. main code):
- 70 *.ts files (7,934 lines of code)
- 24 *.feature files (2,682 lines of code)
- 5 *.yaml files (96 lines of code)
- " *.ts" is biggest, containing 74.07% of code.
- " *.yaml" is smallest, containing 0.9% of code.
Generated Code
Automatically generated files, not manually changed after generation.
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 ".*/package[.]json".
- files with paths like ".*[.]git[a-z]+".
- files with paths like ".*/[.]gitattributes".
- files with paths like ".*[.]sh".
- files with paths like ".*/docker[-]compose[.]yaml".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*/package[-]lock[.]json".
- 6 files match defined criteria (383 lines of code, 0.7% vs. main code):
- 5 *.sh files (367 lines of code)
- 1 *.yaml files (16 lines of code)
- " *.sh" is biggest, containing 95.82% of code.
- " *.yaml" is smallest, containing 4.18% 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 ".*[.]txt".
- files with paths like ".*[.]json".
- files with paths like ".*[.]npmrc".
- files with paths like ".*/[.]npmignore".
- files with paths like ".*[.]properties".
- files with paths like ".*/[.]dockerignore".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*/LICENSE[.][a-z0-9]+".
- 218 files match defined criteria (11,503 lines of code, 19.9% vs. main code):
- 125 *.json files (8,176 lines of code)
- 91 *.md files (3,280 lines of code)
- 2 *.properties files (47 lines of code)
- " *.json" is biggest, containing 71.08% of code.
- " *.properties" is smallest, containing 0.41% 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
- *.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
- *.bash files are analyzed with ShellAnalyzer:
- 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
- *.yml 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
- *.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
2022-01-31 15:37