Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 13 extensions are included in analyses: ts, json, md, js, npmignore, yml, snap, styl, gitignore, dockerignore, txt, eslintignore, prettierignore
- 7 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (22 files).
- exclude files with path like ".*/docs/.*" (Documentation) (12 files).
- exclude files with path like ".*/bin/.*" (Binaries for distribution) (2 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 ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
- exclude files with path like ".*[.]txt" (Text files) (0 files).
- The source code folder contains 211 files:
- 169 files are included in analyses.
- 42 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 ".*".
- 101 files match defined criteria (3,112 lines of code, 100.0% vs. main code):
- 81 *.ts files (2,881 lines of code)
- 19 *.js files (220 lines of code)
- 1 *.yml files (11 lines of code)
- " *.ts" is biggest, containing 92.58% of code.
- " *.yml" is smallest, containing 0.35% 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 ".*__tests__.*".
- files with paths like ".*[.]snap".
- files with paths like ".*[.]spec[.]ts".
- files with paths like ".*/__mocks?__/.*".
- files with any line of content like ".*/simpletest/.*".
- 25 files match defined criteria (1,917 lines of code, 61.6% vs. main code):
- 22 *.ts files (1,527 lines of code)
- 2 *.snap files (386 lines of code)
- 1 *.js files (4 lines of code)
- " *.ts" is biggest, containing 79.66% of code.
- " *.js" is smallest, containing 0.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 ".*[.]git[a-z]+".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*/package[.]json".
- files with paths like ".*([.]|/)webpack([.]|/).*".
- 8 files match defined criteria (261 lines of code, 8.4% vs. main code). All matches are in *.ts files.
Other Code
- The following criteria are used to filter files:
- files with paths like ".*[.]json".
- files with paths like ".*/[.]dockerignore".
- files with paths like ".*/[.]eslintignore".
- files with paths like ".*[.]md".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*/[.]prettierignore".
- files with paths like ".*/README[.][a-z0-9]+".
- files with paths like ".*/[.]npmignore".
- files with paths like ".*[.]txt".
- 35 files match defined criteria (5,409 lines of code, 173.8% vs. main code):
- 24 *.json files (4,186 lines of code)
- 11 *.md files (1,223 lines of code)
- " *.json" is biggest, containing 77.39% of code.
- " *.md" is smallest, containing 22.61% of code.
Analyzers
Info about analyzers used for source code examinations.
- *.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
- *.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
- *.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
2022-01-30 23:53