Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 12 extensions are included in analyses: ts, json, svg, tsx, scss, js, md, yml, html, gitignore, txt, npmrc
- 5 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (8 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 717 files:
- 687 files are included in analyses.
- 30 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 ".*".
- 396 files match defined criteria (17,410 lines of code, 100.0% vs. main code):
- 380 *.ts files (16,366 lines of code)
- 15 *.js files (1,019 lines of code)
- 1 *.html files (25 lines of code)
- " *.ts" is biggest, containing 94% of code.
- " *.html" is smallest, containing 0.14% 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 ".*/karma[.]conf[.]js".
- files with paths like ".*[.][Tt]ests[.].*".
- files with paths like ".*[.]tests[.].*".
- files with paths like ".*/[Tt]est/.*".
- files with any line of content like ".*/simpletest/.*".
- 132 files match defined criteria (21,565 lines of code, 123.9% vs. main code):
- 130 *.ts files (21,478 lines of code)
- 2 *.js files (87 lines of code)
- " *.ts" is biggest, containing 99.6% of code.
- " *.js" is smallest, containing 0.4% 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([.]|/).*".
- 1 file matches defined criteria (59 lines of code, 0.3% 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 ".*[.]md".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*[.]npmrc".
- files with paths like ".*/README[.][a-z0-9]+".
- files with paths like ".*/[Dd]emos?/.*".
- files with paths like ".*[.]svg".
- files with paths like ".*[.]txt".
- 158 files match defined criteria (6,493 lines of code, 37.3% vs. main code):
- 35 *.tsx files (3,354 lines of code)
- 36 *.ts files (1,349 lines of code)
- 35 *.json files (607 lines of code)
- 23 *.scss files (494 lines of code)
- 24 *.svg files (412 lines of code)
- 4 *.md files (251 lines of code)
- 1 *.html files (26 lines of code)
- " *.tsx" is biggest, containing 51.66% of code.
- " *.html" is smallest, containing 0.4% 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
- *.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
2022-01-30 15:04