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: tsx, mdx, json, js, ts, md, gitignore, txt, html, css, npmignore, scss, babelrc, sh, MD, eslintignore, yaml
- 9 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (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 ".*/docs/.*" (Documentation) (51 files).
- exclude files with path like ".*\.d\.ts" (Typescript definition files) (2 files).
- exclude files with path like ".*/react(-[^.]*)?\.js" (React) (12 files).
- exclude files with path like ".*/bin/.*" (Binaries for distribution) (1 file).
- exclude files with path like ".*[.]txt" (Text files) (2 files).
- exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
- The source code folder contains 845 files:
- 730 files are included in analyses.
- 115 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 ".*".
- 369 files match defined criteria (19,145 lines of code, 100.0% vs. main code):
- 274 *.tsx files (11,579 lines of code)
- 66 *.js files (5,001 lines of code)
- 27 *.ts files (2,512 lines of code)
- 1 *.scss files (35 lines of code)
- 1 *.html files (18 lines of code)
- " *.tsx" is biggest, containing 60.48% of code.
- " *.html" is smallest, containing 0.09% 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]est[.].*".
- files with paths like ".*[.]test[.].*".
- files with any line of content like ".*/simpletest/.*".
- 78 files match defined criteria (3,344 lines of code, 17.5% vs. main code). All matches are in *.tsx files.
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 ".*/package[.]json".
- files with paths like ".*/package[-]lock[.]json".
- files with paths like ".*[.]git[a-z]+".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*[.]sh".
- files with paths like ".*([.]|/)webpack([.]|/).*".
- 1 file matches defined criteria (104 lines of code, 0.5% vs. main code). All matches are in *.sh 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 ".*/[.]eslintignore".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*[.]mdx".
- files with paths like ".*/[Dd]emos?/.*".
- files with paths like ".*/[.]npmignore".
- 282 files match defined criteria (169,724 lines of code, 886.5% vs. main code):
- 102 *.json files (162,119 lines of code)
- 100 *.mdx files (4,233 lines of code)
- 48 *.tsx files (1,741 lines of code)
- 15 *.md files (879 lines of code)
- 13 *.ts files (404 lines of code)
- 1 *.yaml files (238 lines of code)
- 1 *.js files (80 lines of code)
- 1 *.css files (17 lines of code)
- 1 *.html files (13 lines of code)
- " *.json" is biggest, containing 95.52% of code.
- " *.html" is smallest, containing 0.01% 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
- *.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
- *.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
- *.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
- *.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-31 17:34