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, js, md, svg, cs, ts, yml, gitignore, g4, py, csproj, editorconfig, html, txt, gitattributes, MD, man, npmrc, yaml, htm, cmd
- 6 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (14 files).
- exclude files with path like ".*/docs/.*" (Documentation) (63 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) (1 file).
- The source code folder contains 886 files:
- 424 files are included in analyses.
- 462 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 ".*".
- 132 files match defined criteria (20,095 lines of code, 100.0% vs. main code):
- 80 *.js files (8,601 lines of code)
- 1 *.yaml files (6,946 lines of code)
- 15 *.ts files (1,881 lines of code)
- 22 *.cs files (1,492 lines of code)
- 4 *.g4 files (720 lines of code)
- 3 *.py files (274 lines of code)
- 7 *.yml files (181 lines of code)
- " *.js" is biggest, containing 42.8% of code.
- " *.yml" is smallest, containing 0.9% 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 ".*[-]test[-].*".
- files with paths like ".*/[Tt]est/.*".
- files with paths like ".*[.][Tt]est[.].*".
- files with paths like ".*[.]test[.].*".
- files with paths like ".*/[Ss]pecs/.*".
- files with any line of content like ".*/simpletest/.*".
- 44 files match defined criteria (11,143 lines of code, 55.5% vs. main code):
- 32 *.js files (10,429 lines of code)
- 10 *.ts files (605 lines of code)
- 1 *.yml files (61 lines of code)
- 1 *.man files (48 lines of code)
- " *.js" is biggest, containing 93.59% of code.
- " *.man" is smallest, containing 0.43% 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 ".*/generated/.*".
- files with paths like ".*[.]cs" AND any line of content like "[/][/][ ]*
- 15 files match defined criteria (11,832 lines of code, 58.9% vs. main code):
- 4 *.js files (6,628 lines of code)
- 1 *.json files (4,158 lines of code)
- 10 *.cs files (1,046 lines of code)
- " *.js" is biggest, containing 56.02% of code.
- " *.cs" is smallest, containing 8.84% 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 ".*[.]csproj".
- files with paths like ".*/package[-]lock[.]json".
- files with paths like ".*/package[.]json".
- 2 files match defined criteria (51 lines of code, 0.3% vs. main code). All matches are in *.csproj 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 ".*[.]md".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*/README[.][a-z0-9]+".
- files with paths like ".*[.]svg".
- files with paths like ".*/[Ss]amples/.*".
- files with paths like ".*/LICENSE[.][a-z0-9]+".
- files with paths like ".*[.]txt".
- files with paths like ".*[.]npmrc".
- files with paths like ".*/[Ee]xamples/.*".
- 232 files match defined criteria (114,117 lines of code, 567.9% vs. main code):
- 178 *.json files (110,233 lines of code)
- 42 *.md files (3,466 lines of code)
- 8 *.cs files (306 lines of code)
- 1 *.cmd files (65 lines of code)
- 1 *.csproj files (36 lines of code)
- 1 *.html files (10 lines of code)
- 1 *.svg files (1 lines of code)
- " *.json" is biggest, containing 96.6% of code.
- " *.svg" is smallest, containing 0% of code.
Analyzers
Info about analyzers used for source code examinations.
- *.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
- *.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
- *.cs files are analyzed with CSharpAnalyzer:
- 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 (based on namespace heuristics)
- *.g4 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
- *.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
- *.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:30