Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 21 extensions are included in analyses: json, ts, txt, md, svg, js, cpp, yml, cfg, cmake, gitignore, c, h, gitattributes, ps1, psm1, vscodeignore, bat, sh, editorconfig, eslintignore
- 7 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (55 files).
- exclude files with path like ".*/docs/.*" (Documentation) (13 files).
- exclude files with path like ".*/bin/.*" (Binaries for distribution) (2 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) (21 files).
- The source code folder contains 767 files:
- 651 files are included in analyses.
- 116 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 ".*".
- 61 files match defined criteria (17,158 lines of code, 100.0% vs. main code):
- 56 *.ts files (16,317 lines of code)
- 2 *.js files (387 lines of code)
- 1 *.psm1 files (335 lines of code)
- 1 *.ps1 files (76 lines of code)
- 1 *.yml files (43 lines of code)
- " *.ts" is biggest, containing 95.1% of code.
- " *.yml" is smallest, containing 0.25% 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 ".*[-]tests/.*".
- files with paths like ".*[.]test[.].*".
- files with paths like ".*/test_.*".
- files with any line of content like ".*/simpletest/.*".
- 91 files match defined criteria (4,795 lines of code, 27.9% vs. main code):
- 61 *.ts files (4,538 lines of code)
- 11 *.cpp files (207 lines of code)
- 8 *.cfg files (30 lines of code)
- 9 *.cmake files (13 lines of code)
- 1 *.h files (4 lines of code)
- 1 *.c files (3 lines of code)
- " *.ts" is biggest, containing 94.64% of code.
- " *.c" is smallest, containing 0.06% 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 ".*[.]git[a-z]+".
- files with paths like ".*/[.]gitattributes".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*/package[.]json".
- files with paths like ".*[.]bat".
- files with paths like ".*[.]sh".
- files with paths like ".*([.]|/)webpack([.]|/).*".
- 1 file matches defined criteria (58 lines of code, 0.3% vs. main code). All matches are in *.js files.
Other Code
- The following criteria are used to filter files:
- files with paths like ".*[.]json".
- files with paths like ".*[.]editorconfig".
- files with paths like ".*/[.]eslintignore".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*/[.]vscodeignore".
- files with paths like ".*[.]md".
- 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 ".*[.]svg".
- 498 files match defined criteria (21,610 lines of code, 125.9% vs. main code):
- 483 *.json files (20,643 lines of code)
- 11 *.svg files (556 lines of code)
- 4 *.md files (411 lines of code)
- " *.json" is biggest, containing 95.53% of code.
- " *.md" is smallest, containing 1.9% 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
- *.psm1 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
- *.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
- *.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
2022-01-30 13:34