Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 14 extensions are included in analyses: md, html, gitignore, svg, js, json, toml, css, scss, txt, sh, editorconfig, yml, gitmodules
- 7 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (11 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) (5 files).
- exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
- exclude files with path like ".*/static/js/.*" (JS library) (1 file).
- exclude files with path like ".*[.]txt" (Text files) (0 files).
- The source code folder contains 101 files:
- 66 files are included in analyses.
- 35 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 ".*".
- 20 files match defined criteria (519 lines of code, 100.0% vs. main code):
- 17 *.html files (281 lines of code)
- 2 *.toml files (159 lines of code)
- 1 *.scss files (79 lines of code)
- " *.html" is biggest, containing 54.14% of code.
- " *.scss" is smallest, containing 15.22% 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 ".*/[.]gitmodules".
- files with paths like ".*[.]sh".
- files with paths like ".*/package[.]json".
- 1 file matches defined criteria (215 lines of code, 41.4% 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 ".*[.]editorconfig".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*[.]txt".
- 45 files match defined criteria (3,340 lines of code, 643.5% vs. main code):
- 43 *.md files (2,201 lines of code)
- 2 *.json files (1,139 lines of code)
- " *.md" is biggest, containing 65.9% of code.
- " *.json" is smallest, containing 34.1% 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
- *.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
- *.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
2022-02-03 09:21