Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 16 extensions are included in analyses: ts, html, md, json, js, css, npmignore, ps1, svg, gitignore, gltf, dockerignore, gitattributes, txt, editorconfig, eslintignore
- 7 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (20 files).
- exclude files with path like ".*/docs/.*" (Documentation) (217 files).
- exclude files with path like ".*\.d\.ts" (Typescript definition files) (1 file).
- 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) (0 files).
- The source code folder contains 598 files:
- 319 files are included in analyses.
- 279 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 ".*".
- 200 files match defined criteria (15,013 lines of code, 100.0% vs. main code):
- 195 *.ts files (14,746 lines of code)
- 1 *.html files (231 lines of code)
- 4 *.ps1 files (36 lines of code)
- " *.ts" is biggest, containing 98.22% of code.
- " *.ps1" is smallest, containing 0.24% 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]ests/.*".
- files with any line of content like ".*/simpletest/.*".
- 69 files match defined criteria (5,889 lines of code, 39.2% vs. main code):
- 68 *.ts files (5,888 lines of code)
- 1 *.html files (1 lines of code)
- " *.ts" is biggest, containing 99.98% of code.
- " *.html" is smallest, containing 0.02% of code.
Generated Code
Automatically generated files, not manually changed after generation.
- The following criteria are used to filter files:
- files with paths like ".*/package[-]lock[.]json".
- files with paths like ".*/src/gen/.*".
- 7 files match defined criteria (17,606 lines of code, 117.3% vs. main code):
- 6 *.json files (17,330 lines of code)
- 1 *.ts files (276 lines of code)
- " *.json" is biggest, containing 98.43% of code.
- " *.ts" is smallest, containing 1.57% of code.
Other Code
- The following criteria are used to filter files:
- files with paths like ".*[.]json".
- files with paths like ".*/[.]dockerignore".
- files with paths like ".*[.]editorconfig".
- files with paths like ".*/[.]eslintignore".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*[.]md".
- files with paths like ".*/README[.][a-z0-9]+".
- files with paths like ".*[.]svg".
- files with paths like ".*/[.]npmignore".
- files with paths like ".*[.]txt".
- 49 files match defined criteria (19,918 lines of code, 132.7% vs. main code):
- 22 *.json files (17,840 lines of code)
- 25 *.md files (1,889 lines of code)
- 2 *.svg files (189 lines of code)
- " *.json" is biggest, containing 89.57% of code.
- " *.svg" is smallest, containing 0.95% 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
- *.html files are analyzed with HtmlAnalyzer:
- 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
- Advanced 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
2022-01-30 22:29