Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 26 extensions are included in analyses: yaml, md, csproj, cs, json, ipynb, py, yml, js, ps1, txt, html, gitignore, psm1, cpp, hpp, css, csx, gitattributes, fs, sh, editorconfig, clang-format, cmd, fsproj, ts
- 5 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 ".*/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) (5 files).
- The source code folder contains 686 files:
- 457 files are included in analyses.
- 229 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 ".*".
- 12 files match defined criteria (837 lines of code, 100.0% vs. main code):
- 2 *.psm1 files (422 lines of code)
- 5 *.ps1 files (245 lines of code)
- 2 *.py files (81 lines of code)
- 2 *.yml files (74 lines of code)
- 1 *.cmd files (15 lines of code)
- " *.psm1" is biggest, containing 50.42% of code.
- " *.cmd" is smallest, containing 1.79% 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 ".*/[.]gitattributes".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*[.]csproj".
- files with paths like ".*/package[-]lock[.]json".
- files with paths like ".*/package[.]json".
- files with paths like ".*([.]|/)webpack([.]|/).*".
- files with paths like ".*[.]sh".
- 1 file matches defined criteria (41 lines of code, 4.9% vs. main code). All matches are in *.sh 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 ".*/README[.][a-z0-9]+".
- files with paths like ".*[.]editorconfig".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*[.]txt".
- files with paths like ".*/LICENSE[.][a-z0-9]+".
- files with paths like ".*/[Ss]amples/.*".
- files with paths like ".*[.](xml|xsd|robot|sql|pgsql|dashboard|profile|ipynb|raml|avsc|al)".
- 444 files match defined criteria (183,797 lines of code, 21959.0% vs. main code):
- 186 *.yaml files (155,983 lines of code)
- 17 *.json files (12,607 lines of code)
- 9 *.ipynb files (5,211 lines of code)
- 50 *.cs files (3,581 lines of code)
- 83 *.md files (3,461 lines of code)
- 2 *.hpp files (689 lines of code)
- 61 *.csproj files (585 lines of code)
- 4 *.html files (391 lines of code)
- 12 *.py files (389 lines of code)
- 1 *.ts files (275 lines of code)
- 7 *.js files (241 lines of code)
- 2 *.cpp files (123 lines of code)
- 6 *.yml files (81 lines of code)
- 1 *.css files (73 lines of code)
- 1 *.ps1 files (66 lines of code)
- 1 *.fs files (29 lines of code)
- 1 *.fsproj files (12 lines of code)
- " *.yaml" is biggest, containing 84.87% of code.
- " *.fsproj" is smallest, containing 0.01% of code.
Analyzers
Info about analyzers used for source code examinations.
- *.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
- *.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
- *.cmd 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 15:25