Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 19 extensions are included in analyses: svg, js, json, rb, md, yml, mdx, npmignore, gitignore, sh, gemspec, babelrc, tsx, eslintignore, snap, scss, txt, npmrc, ts
- 3 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (41 files).
- exclude files with path like ".*/docs/.*" (Documentation) (21 files).
- exclude files with path like ".*\.d\.ts" (Typescript definition files) (1 file).
- The source code folder contains 655 files:
- 527 files are included in analyses.
- 128 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 ".*".
- 29 files match defined criteria (604 lines of code, 100.0% vs. main code):
- 16 *.js files (374 lines of code)
- 9 *.rb files (180 lines of code)
- 3 *.gemspec files (44 lines of code)
- 1 *.scss files (6 lines of code)
- " *.js" is biggest, containing 61.92% of code.
- " *.scss" is smallest, containing 0.99% 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]ests/.*".
- files with paths like ".*[.]snap".
- files with paths like ".*[-]tests/.*".
- files with paths like ".*__tests__.*".
- files with paths like ".*/[Tt]est/.*".
- files with paths like ".*_test[.].*".
- 16 files match defined criteria (687 lines of code, 113.7% vs. main code):
- 5 *.js files (430 lines of code)
- 7 *.rb files (202 lines of code)
- 2 *.tsx files (30 lines of code)
- 2 *.snap files (25 lines of code)
- " *.js" is biggest, containing 62.59% of code.
- " *.snap" is smallest, containing 3.64% 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 ".*[.]sh".
- 1 file matches defined criteria (2 lines of code, 0.3% 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 ".*[.]json".
- files with paths like ".*/README[.][a-z0-9]+".
- files with paths like ".*[.]svg".
- files with paths like ".*[.]npmrc".
- files with paths like ".*[.]mdx".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*/[.]npmignore".
- files with paths like ".*/[.]eslintignore".
- 481 files match defined criteria (1,968 lines of code, 325.8% vs. main code):
- 12 *.md files (917 lines of code)
- 9 *.json files (568 lines of code)
- 460 *.svg files (483 lines of code)
- " *.md" is biggest, containing 46.6% of code.
- " *.svg" is smallest, containing 24.54% of code.
Analyzers
Info about analyzers used for source code examinations.
- *.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
- *.gemspec 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
- *.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
2022-02-10 12:17