Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 14 extensions are included in analyses: rd, svg, md, r, js, json, gitignore, css, rmd, rda, txt, yml, html, prettierignore
- 3 criteria are used to exclude files from analysis:
- exclude files with path like ".*/vignettes/.*" (R packages) (2 files).
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (7 files).
- exclude files with path like ".*/docs/.*" (Documentation) (11 files).
- The source code folder contains 115 files:
- 28 files are included in analyses.
- 87 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 ".*".
- 10 files match defined criteria (569 lines of code, 100.0% vs. main code):
- 5 *.js files (389 lines of code)
- 2 *.rda files (109 lines of code)
- 2 *.css files (61 lines of code)
- 1 *.yml files (10 lines of code)
- " *.js" is biggest, containing 68.37% of code.
- " *.yml" is smallest, containing 1.76% of code.
Other Code
- The following criteria are used to filter files:
- files with paths like ".*[.]svg".
- files with paths like ".*/[Mm]an/.*".
- files with paths like ".*[.]md".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*/LICENSE[.][a-z0-9]+".
- files with paths like ".*[.]json".
- files with paths like ".*/[.]prettierignore".
- files with paths like ".*/README[.][a-z0-9]+".
- 18 files match defined criteria (354 lines of code, 62.2% vs. main code):
- 8 *.md files (218 lines of code)
- 2 *.json files (128 lines of code)
- 8 *.svg files (8 lines of code)
- " *.md" is biggest, containing 61.58% of code.
- " *.svg" is smallest, containing 2.26% 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
- *.rda files are analyzed with RAnalyzer:
- 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
- *.yml files are analyzed with YamlAnalyzer:
- 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-04-15 05:09