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: tsx, snap, ts, mdx, md, js, json, yml, gitignore, svg, rb, txt, npmrc
- 3 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (33 files).
- exclude files with path like ".*\.d\.ts" (Typescript definition files) (4 files).
- exclude files with path like ".*/docs/.*" (Documentation) (106 files).
- The source code folder contains 638 files:
- 482 files are included in analyses.
- 156 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 ".*".
- 267 files match defined criteria (21,312 lines of code, 100.0% vs. main code):
- 194 *.tsx files (18,925 lines of code)
- 54 *.ts files (1,456 lines of code)
- 18 *.js files (820 lines of code)
- 1 *.rb files (111 lines of code)
- " *.tsx" is biggest, containing 88.8% of code.
- " *.rb" is smallest, containing 0.52% 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 ".*[.][Tt]est[.].*".
- files with paths like ".*[.]test[.].*".
- files with paths like ".*[.]snap".
- 197 files match defined criteria (38,206 lines of code, 179.3% vs. main code):
- 68 *.snap files (30,373 lines of code)
- 116 *.tsx files (7,133 lines of code)
- 7 *.js files (560 lines of code)
- 6 *.ts files (140 lines of code)
- " *.snap" is biggest, containing 79.5% of code.
- " *.ts" is smallest, containing 0.37% of code.
Other Code
- The following criteria are used to filter files:
- files with paths like ".*/[.]gitignore".
- files with paths like ".*[.]json".
- files with paths like ".*[.]md".
- files with paths like ".*/README[.][a-z0-9]+".
- files with paths like ".*[.]npmrc".
- files with paths like ".*[.]mdx".
- 18 files match defined criteria (1,905 lines of code, 8.9% vs. main code):
- 12 *.md files (1,587 lines of code)
- 6 *.json files (318 lines of code)
- " *.md" is biggest, containing 83.31% of code.
- " *.json" is smallest, containing 16.69% 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
- *.rb files are analyzed with RubyAnalyzer:
- 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
- Basic heuristic dependency analysis
2022-02-10 16:40