Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 18 extensions are included in analyses: md, dart, yaml, html, scss, svg, yml, json, gitignore, js, plist, rb, sh, txt, py, dockerignore, gitattributes, gitmodules
- 7 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (19 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 ".*/docs/.*" (Documentation) (29 files).
- exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
- exclude files with path like ".*[.]txt" (Text files) (1 file).
- exclude files with path like ".*/bootstrap[-].*" (Library) (1 file).
- The source code folder contains 1,102 files:
- 1,017 files are included in analyses.
- 85 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 ".*".
- 78 files match defined criteria (5,422 lines of code, 100.0% vs. main code):
- 28 *.html files (1,874 lines of code)
- 23 *.scss files (1,866 lines of code)
- 8 *.yml files (768 lines of code)
- 7 *.js files (517 lines of code)
- 4 *.rb files (165 lines of code)
- 1 *.dart files (146 lines of code)
- 6 *.yaml files (59 lines of code)
- 1 *.py files (27 lines of code)
- " *.html" is biggest, containing 34.56% of code.
- " *.py" is smallest, containing 0.5% of code.
Generated Code
Automatically generated files, not manually changed after generation.
- The following criteria are used to filter files:
- files with paths like ".*[.]dart" AND any line of content like ".*GENERATED CODE.*DO NOT MODIFY.*".
- files with paths like ".*/package[-]lock[.]json".
- 4 files match defined criteria (5,239 lines of code, 96.6% vs. main code):
- 1 *.json files (5,206 lines of code)
- 3 *.dart files (33 lines of code)
- " *.json" is biggest, containing 99.37% of code.
- " *.dart" is smallest, containing 0.63% 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 ".*[.]git[a-z]+".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*/package[-]lock[.]json".
- files with paths like ".*/[.]gitmodules".
- files with paths like ".*/docker[-]compose[.]yml".
- files with paths like ".*/package[.]json".
- files with paths like ".*/[.]gitattributes".
- 5 files match defined criteria (383 lines of code, 7.1% vs. main code):
- 4 *.sh files (359 lines of code)
- 1 *.yml files (24 lines of code)
- " *.sh" is biggest, containing 93.73% of code.
- " *.yml" is smallest, containing 6.27% of code.
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 ".*/[.]gitignore".
- files with paths like ".*/[Ee]xamples/.*".
- files with paths like ".*[.]svg".
- files with paths like ".*[.]plist".
- files with paths like ".*/[.]dockerignore".
- 934 files match defined criteria (161,441 lines of code, 2977.5% vs. main code):
- 425 *.md files (133,495 lines of code)
- 278 *.dart files (14,739 lines of code)
- 7 *.json files (8,273 lines of code)
- 10 *.svg files (2,938 lines of code)
- 209 *.yaml files (1,751 lines of code)
- 5 *.plist files (245 lines of code)
- " *.md" is biggest, containing 82.69% of code.
- " *.plist" is smallest, containing 0.15% of code.
Analyzers
Info about analyzers used for source code examinations.
- *.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
- *.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
- *.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
- *.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
- *.rb files are analyzed with RubyAnalyzer:
- 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
- Basic heuristic dependency analysis
- *.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
- *.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
- *.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
2022-02-03 01:21