Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 16 extensions are included in analyses: scss, md, jsx, js, json, yml, mdx, svg, cjs, sh, html, npmignore, babelrc, gitignore, txt, npmrc
- 3 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (29 files).
- exclude files with path like ".*/docs/.*" (Documentation) (121 files).
- exclude files with path like ".*/normalize[.](css|less|scss|styl)" (Normalize css) (1 file).
- The source code folder contains 379 files:
- 203 files are included in analyses.
- 176 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 ".*".
- 156 files match defined criteria (7,783 lines of code, 100.0% vs. main code):
- 146 *.scss files (7,351 lines of code)
- 7 *.js files (403 lines of code)
- 3 *.cjs files (29 lines of code)
- " *.scss" is biggest, containing 94.45% of code.
- " *.cjs" is smallest, containing 0.37% 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 paths like ".*__tests__.*".
- 5 files match defined criteria (195 lines of code, 2.5% vs. main code). All matches are in *.js files.
Other Code
- The following criteria are used to filter files:
- files with paths like ".*/[.]npmignore".
- files with paths like ".*[.]md".
- files with paths like ".*[.]json".
- files with paths like ".*/README[.][a-z0-9]+".
- files with paths like ".*[.]npmrc".
- files with paths like ".*[.]mdx".
- files with paths like ".*[.]svg".
- files with paths like ".*/[.]gitignore".
- 42 files match defined criteria (2,722 lines of code, 35.0% vs. main code):
- 38 *.md files (1,967 lines of code)
- 4 *.json files (755 lines of code)
- " *.md" is biggest, containing 72.26% of code.
- " *.json" is smallest, containing 27.74% of code.
Analyzers
Info about analyzers used for source code examinations.
- *.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
- *.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
- *.cjs 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-02-10 12:17