Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 11 extensions are included in analyses: tsx, md, ts, json, js, gitignore, sh, txt, yml, html, eslintignore
- 7 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (13 files).
- exclude files with path like ".*\.d\.ts" (Typescript definition files) (3 files).
- exclude files with path like ".*/docs/.*" (Documentation) (12 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 ".*[.]txt" (Text files) (1 file).
- exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
- The source code folder contains 439 files:
- 397 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 ".*".
- 223 files match defined criteria (16,442 lines of code, 100.0% vs. main code):
- 184 *.tsx files (13,952 lines of code)
- 35 *.ts files (2,371 lines of code)
- 4 *.js files (119 lines of code)
- " *.tsx" is biggest, containing 84.86% of code.
- " *.js" is smallest, containing 0.72% 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 ".*/__mocks?__/.*".
- files with paths like ".*[.][Tt]est[.].*".
- files with paths like ".*[.]test[.].*".
- files with any line of content like ".*/simpletest/.*".
- 76 files match defined criteria (6,274 lines of code, 38.2% vs. main code):
- 71 *.tsx files (6,130 lines of code)
- 5 *.ts files (144 lines of code)
- " *.tsx" is biggest, containing 97.7% of code.
- " *.ts" is smallest, containing 2.3% 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 ".*/package[.]json".
- files with paths like ".*[.]git[a-z]+".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*([.]|/)webpack([.]|/).*".
- files with paths like ".*[.]sh".
- 4 files match defined criteria (122 lines of code, 0.7% vs. main code):
- 1 *.js files (62 lines of code)
- 3 *.sh files (60 lines of code)
- " *.js" is biggest, containing 50.82% of code.
- " *.sh" is smallest, containing 49.18% 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 ".*/[Ee]xamples/.*".
- files with paths like ".*[.]json".
- files with paths like ".*[.]txt".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*/[.]eslintignore".
- 94 files match defined criteria (6,793 lines of code, 41.3% vs. main code):
- 71 *.md files (5,752 lines of code)
- 11 *.tsx files (469 lines of code)
- 8 *.json files (358 lines of code)
- 3 *.ts files (194 lines of code)
- 1 *.html files (20 lines of code)
- " *.md" is biggest, containing 84.68% of code.
- " *.html" is smallest, containing 0.29% of code.
Analyzers
Info about analyzers used for source code examinations.
- *.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
- *.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
2022-01-31 15:20