Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 10 extensions are included in analyses: json, html, tsx, ts, scss, js, md, yml, txt, gitignore
- 5 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (1 file).
- 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) (0 files).
- The source code folder contains 73 files:
- 69 files are included in analyses.
- 4 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 ".*".
- 4 files match defined criteria (35 lines of code, 100.0% vs. main code):
- 2 *.yml files (22 lines of code)
- 1 *.tsx files (8 lines of code)
- 1 *.scss files (5 lines of code)
- " *.yml" is biggest, containing 62.86% of code.
- " *.scss" is smallest, containing 14.29% 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]ests/.*".
- files with paths like ".*[.][Tt]est[.].*".
- files with paths like ".*[.]test[.].*".
- files with paths like ".*/__mocks?__/.*".
- files with any line of content like ".*/simpletest/.*".
- 6 files match defined criteria (119 lines of code, 340.0% vs. main code):
- 1 *.tsx files (85 lines of code)
- 3 *.ts files (32 lines of code)
- 2 *.js files (2 lines of code)
- " *.tsx" is biggest, containing 71.43% of code.
- " *.js" is smallest, containing 1.68% 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 ".*([.]|/)webpack([.]|/).*".
- 1 file matches defined criteria (58 lines of code, 165.7% vs. main code). All matches are in *.js files.
Other Code
- The following criteria are used to filter files:
- files with paths like ".*[.]json".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*[.]md".
- files with paths like ".*/README[.][a-z0-9]+".
- files with paths like ".*/[Ss]amples/.*".
- files with paths like ".*[.]txt".
- 58 files match defined criteria (12,952 lines of code, 37005.7% vs. main code):
- 19 *.json files (11,749 lines of code)
- 11 *.tsx files (815 lines of code)
- 7 *.ts files (171 lines of code)
- 15 *.html files (102 lines of code)
- 2 *.md files (82 lines of code)
- 4 *.scss files (33 lines of code)
- " *.json" is biggest, containing 90.71% of code.
- " *.scss" is smallest, containing 0.25% of code.
Analyzers
Info about analyzers used for source code examinations.
- *.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
- *.tsx 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
- *.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-01-30 22:13