Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 11 extensions are included in analyses: ts, json, md, sh, html, snap, yml, js, vscodeignore, gitignore, clang-format
- 2 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 ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
- The source code folder contains 138 files:
- 115 files are included in analyses.
- 23 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 ".*".
- 42 files match defined criteria (4,465 lines of code, 100.0% vs. main code):
- 38 *.ts files (4,397 lines of code)
- 2 *.js files (59 lines of code)
- 2 *.html files (9 lines of code)
- " *.ts" is biggest, containing 98.48% of code.
- " *.html" is smallest, containing 0.2% 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]ests/.*".
- files with paths like ".*/[Tt]est/.*".
- files with paths like ".*[.]snap".
- files with paths like ".*/test_.*".
- files with paths like ".*/e2e/.*".
- files with any line of content like ".*/simpletest/.*".
- 24 files match defined criteria (2,912 lines of code, 65.2% vs. main code):
- 4 *.snap files (2,154 lines of code)
- 18 *.ts files (622 lines of code)
- 2 *.html files (136 lines of code)
- " *.snap" is biggest, containing 73.97% of code.
- " *.html" is smallest, containing 4.67% 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 ".*[.]sh".
- files with paths like ".*/package[.]json".
- files with paths like ".*[.]git[a-z]+".
- files with paths like ".*/[.]gitignore".
- 4 files match defined criteria (79 lines of code, 1.8% vs. main code). All matches are in *.sh files.
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 ".*[.]json".
- files with paths like ".*/[.]vscodeignore".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*/[Dd]emos?/.*".
- 45 files match defined criteria (2,577 lines of code, 57.7% vs. main code):
- 37 *.json files (1,854 lines of code)
- 6 *.md files (705 lines of code)
- 2 *.ts files (18 lines of code)
- " *.json" is biggest, containing 71.94% of code.
- " *.ts" is smallest, containing 0.7% 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
- *.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
2022-02-02 22:19