Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 15 extensions are included in analyses: json, ts, js, md, yml, txt, plist, gitignore, npmignore, properties, svg, gradle, vscodeignore, bat, tsx
- 7 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (26 files).
- exclude files with path like ".*\.d\.ts" (Typescript definition files) (13 files).
- exclude files with path like ".*/docs/.*" (Documentation) (3 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 ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
- exclude files with path like ".*[.]txt" (Text files) (6 files).
- The source code folder contains 716 files:
- 649 files are included in analyses.
- 67 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 ".*".
- 160 files match defined criteria (18,556 lines of code, 100.0% vs. main code):
- 154 *.ts files (17,894 lines of code)
- 6 *.js files (662 lines of code)
- " *.ts" is biggest, containing 96.43% of code.
- " *.js" is smallest, containing 3.57% 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 ".*/[Tt]est/.*".
- files with paths like ".*[.][Tt]est[.].*".
- files with paths like ".*[.]test[.].*".
- files with any line of content like ".*/simpletest/.*".
- 114 files match defined criteria (14,195 lines of code, 76.5% vs. main code):
- 96 *.ts files (13,254 lines of code)
- 16 *.js files (833 lines of code)
- 1 *.gradle files (90 lines of code)
- 1 *.tsx files (18 lines of code)
- " *.ts" is biggest, containing 93.37% of code.
- " *.tsx" is smallest, containing 0.13% 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 ".*[.]git[a-z]+".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*/package[.]json".
- files with paths like ".*/package[-]lock[.]json".
- files with paths like ".*[.]bat".
- files with paths like ".*[.]gradle".
- 1 file matches defined criteria (1 lines of code, 0.0% vs. main code). All matches are in *.bat files.
Other Code
- The following criteria are used to filter files:
- files with paths like ".*[.]json".
- files with paths like ".*[.]md".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*/[.]npmignore".
- files with paths like ".*/[.]vscodeignore".
- files with paths like ".*[.]txt".
- files with paths like ".*/LICENSE[.][a-z0-9]+".
- files with paths like ".*/README[.][a-z0-9]+".
- files with paths like ".*[.]plist".
- files with paths like ".*[.]properties".
- 374 files match defined criteria (29,130 lines of code, 157.0% vs. main code):
- 356 *.json files (27,642 lines of code)
- 9 *.md files (1,164 lines of code)
- 7 *.plist files (322 lines of code)
- 2 *.properties files (2 lines of code)
- " *.json" is biggest, containing 94.89% of code.
- " *.properties" is smallest, containing 0.01% 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
- *.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-30 13:22