Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 16 extensions are included in analyses: dart, html, yaml, svg, md, scss, sh, js, diff, json, xml, css, gitignore, txt, dockerignore, yml
- 8 criteria are used to exclude files from analysis:
- exclude files with path like ".*/(3rd|[Tt]hird)[-_]?[Pp]arty/.*" (Dependencies) (8 files).
- exclude files with path like ".*/bin/.*" (Binaries for distribution) (29 files).
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (9 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 ".*[.]txt" (Text files) (0 files).
- exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
- exclude files with path like ".*/static/js/.*" (JS library) (2 files).
- The source code folder contains 672 files:
- 593 files are included in analyses.
- 79 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 ".*".
- 306 files match defined criteria (37,766 lines of code, 100.0% vs. main code):
- 250 *.dart files (34,782 lines of code)
- 14 *.scss files (2,151 lines of code)
- 41 *.yaml files (734 lines of code)
- 1 *.js files (99 lines of code)
- " *.dart" is biggest, containing 92.1% of code.
- " *.js" is smallest, containing 0.26% 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 ".*_test[.].*".
- files with paths like ".*_tests[.].*".
- files with paths like ".*/test_.*".
- files with any line of content like ".*/simpletest/.*".
- 189 files match defined criteria (27,367 lines of code, 72.5% vs. main code):
- 130 *.dart files (14,977 lines of code)
- 53 *.html files (12,338 lines of code)
- 6 *.yaml files (52 lines of code)
- " *.dart" is biggest, containing 54.73% of code.
- " *.yaml" is smallest, containing 0.19% 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 ".*[.]dart" AND any line of content like ".*GENERATED CODE.*DO NOT MODIFY.*".
- files with paths like ".*[.](html|html|xhtml)" AND any line of content like "[ ]*[<]meta name[=]"generator" .*".
- 26 files match defined criteria (3,589 lines of code, 9.5% vs. main code):
- 22 *.dart files (3,079 lines of code)
- 4 *.html files (510 lines of code)
- " *.dart" is biggest, containing 85.79% of code.
- " *.html" is smallest, containing 14.21% 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 ".*/package[-]lock[.]json".
- files with paths like ".*/package[.]json".
- files with paths like ".*[.]sh".
- files with paths like ".*[.]git[a-z]+".
- files with paths like ".*/[.]gitignore".
- 10 files match defined criteria (318 lines of code, 0.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 ".*[.]txt".
- files with paths like ".*[.]svg".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*[.]diff".
- files with paths like ".*/[.]dockerignore".
- 62 files match defined criteria (1,953 lines of code, 5.2% vs. main code):
- 25 *.md files (1,486 lines of code)
- 29 *.svg files (380 lines of code)
- 2 *.json files (53 lines of code)
- 6 *.diff files (34 lines of code)
- " *.md" is biggest, containing 76.09% of code.
- " *.diff" is smallest, containing 1.74% of code.
Analyzers
Info about analyzers used for source code examinations.
- *.dart files are analyzed with CppAnalyzer:
- 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
- *.scss files are analyzed with ScssAnalyzer:
- 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
- *.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
- *.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
2022-02-03 02:08