Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 24 extensions are included in analyses: yaml, json, ts, gitignore, go, js, md, mod, java, tf, sh, yml, vue, rs, gitattributes, hcl, toml, gradle, mjs, editorconfig, svg, cjs, txt, tfstate
- 3 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (46 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).
- The source code folder contains 210 files:
- 136 files are included in analyses.
- 74 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 ".*".
- 72 files match defined criteria (1,261 lines of code, 100.0% vs. main code):
- 17 *.yaml files (443 lines of code)
- 9 *.go files (178 lines of code)
- 14 *.ts files (138 lines of code)
- 7 *.tf files (124 lines of code)
- 1 *.tfstate files (104 lines of code)
- 6 *.java files (103 lines of code)
- 8 *.js files (65 lines of code)
- 3 *.vue files (46 lines of code)
- 3 *.rs files (35 lines of code)
- 2 *.toml files (13 lines of code)
- 2 *.mjs files (12 lines of code)
- " *.yaml" is biggest, containing 35.13% of code.
- " *.mjs" is smallest, containing 0.95% 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 ".*__tests__.*".
- files with paths like ".*[.][Tt]est[.].*".
- files with paths like ".*[.]test[.].*".
- files with paths like ".*/[Tt]est/.*".
- 12 files match defined criteria (240 lines of code, 19.0% vs. main code):
- 4 *.go files (124 lines of code)
- 6 *.ts files (82 lines of code)
- 1 *.js files (25 lines of code)
- 1 *.java files (9 lines of code)
- " *.go" is biggest, containing 51.67% of code.
- " *.java" is smallest, containing 3.75% 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 ".*/[.]gitignore".
- files with paths like ".*/package[-]lock[.]json".
- files with paths like ".*/package[.]json".
- files with paths like ".*/docker[-]compose[.]yaml".
- files with paths like ".*[.]gradle".
- files with paths like ".*/[.]gitattributes".
- files with paths like ".*[.]sh".
- 10 files match defined criteria (69 lines of code, 5.5% vs. main code):
- 6 *.sh files (32 lines of code)
- 2 *.gradle files (21 lines of code)
- 2 *.yaml files (16 lines of code)
- " *.sh" is biggest, containing 46.38% of code.
- " *.yaml" is smallest, containing 23.19% of code.
Other Code
- The following criteria are used to filter files:
- files with paths like ".*/[.]gitignore".
- files with paths like ".*[.]json".
- files with paths like ".*[.]md".
- files with paths like ".*/README[.][a-z0-9]+".
- files with paths like ".*/go[.]mod".
- files with paths like ".*[.]editorconfig".
- files with paths like ".*[.]txt".
- 42 files match defined criteria (22,138 lines of code, 1755.6% vs. main code):
- 24 *.json files (21,863 lines of code)
- 11 *.md files (178 lines of code)
- 7 *.mod files (97 lines of code)
- " *.json" is biggest, containing 98.76% of code.
- " *.mod" is smallest, containing 0.44% of code.
Analyzers
Info about analyzers used for source code examinations.
- *.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
- *.go files are analyzed with GoLangAnalyzer:
- 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
- *.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
- *.tf 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
- *.tfstate files are analyzed with JsonAnalyzer:
- 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
- *.java files are analyzed with JavaAnalyzer:
- 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 package names)
- *.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
- *.vue 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
- *.rs files are analyzed with RustAnalyzer:
- 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
- *.toml 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
- *.mjs 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-05-14 00:22