Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 17 extensions are included in analyses: ts, tsx, md, css, js, json, jsx, yml, gitignore, snap, npmignore, editorconfig, eslintignore, txt, MD, html, npmrc
- 7 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (21 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) (20 files).
- exclude files with path like ".*\.d\.ts" (Typescript definition files) (6 files).
- exclude files with path like ".*[.]txt" (Text files) (0 files).
- exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
- The source code folder contains 534 files:
- 476 files are included in analyses.
- 58 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 ".*".
- 334 files match defined criteria (21,521 lines of code, 100.0% vs. main code):
- 160 *.tsx files (13,459 lines of code)
- 120 *.ts files (6,041 lines of code)
- 29 *.css files (879 lines of code)
- 4 *.jsx files (737 lines of code)
- 19 *.js files (367 lines of code)
- 1 *.html files (29 lines of code)
- 1 *.md files (9 lines of code)
- " *.tsx" is biggest, containing 62.54% of code.
- " *.md" is smallest, containing 0.04% 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 ".*[.]spec[.]ts".
- files with paths like ".*[-]test[-].*".
- files with paths like ".*/[Tt]ests/.*".
- files with paths like ".*[.]snap".
- files with any line of content like ".*/simpletest/.*".
- 107 files match defined criteria (15,210 lines of code, 70.7% vs. main code):
- 103 *.ts files (14,865 lines of code)
- 2 *.snap files (253 lines of code)
- 1 *.tsx files (84 lines of code)
- 1 *.js files (8 lines of code)
- " *.ts" is biggest, containing 97.73% of code.
- " *.js" is smallest, containing 0.05% 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([.]|/).*".
- 1 file matches defined criteria (23 lines of code, 0.1% vs. main code). All matches are in *.js 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 ".*[.]txt".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*[.]editorconfig".
- files with paths like ".*/[.]npmignore".
- files with paths like ".*[.]npmrc".
- files with paths like ".*/[.]eslintignore".
- 34 files match defined criteria (2,331 lines of code, 10.8% vs. main code):
- 21 *.md files (1,918 lines of code)
- 13 *.json files (413 lines of code)
- " *.md" is biggest, containing 82.28% of code.
- " *.json" is smallest, containing 17.72% 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
- *.css files are analyzed with CssAnalyzer:
- 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
- *.jsx 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
- *.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
- *.md 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
2022-01-31 22:39