Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 24 extensions are included in analyses: js, json, md, vue, py, ts, yaml, txt, yml, sh, editorconfig, sass, cfg, gitignore, toml, gql, npmignore, scala, xml, html, graphql, svg, eslintignore, prettierignore
- 8 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (20 files).
- exclude files with path like ".*\.d\.ts" (Typescript definition files) (1 file).
- exclude files with path like ".*/bin/.*" (Binaries for distribution) (3 files).
- exclude files with path like ".*/docs/.*" (Documentation) (2 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 ".*[.]txt" (Text files) (4 files).
- exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
- The source code folder contains 224 files:
- 171 files are included in analyses.
- 53 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 ".*".
- 85 files match defined criteria (6,108 lines of code, 100.0% vs. main code):
- 16 *.vue files (2,692 lines of code)
- 5 *.yaml files (966 lines of code)
- 38 *.js files (877 lines of code)
- 11 *.py files (517 lines of code)
- 2 *.yml files (438 lines of code)
- 4 *.ts files (179 lines of code)
- 1 *.gql files (138 lines of code)
- 2 *.toml files (93 lines of code)
- 1 *.graphql files (81 lines of code)
- 2 *.sass files (58 lines of code)
- 1 *.html files (43 lines of code)
- 2 *.cfg files (26 lines of code)
- " *.vue" is biggest, containing 44.07% of code.
- " *.cfg" is smallest, containing 0.43% 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 ".*[.]spec[.]js".
- files with paths like ".*/[Tt]ests/.*".
- files with paths like ".*[.][Tt]est[.].*".
- files with paths like ".*[.]test[.].*".
- files with paths like ".*/[Tt]est/.*".
- files with paths like ".*/mock[-].*".
- files with any line of content like ".*/simpletest/.*".
- 24 files match defined criteria (1,152 lines of code, 18.9% vs. main code):
- 8 *.ts files (581 lines of code)
- 3 *.py files (187 lines of code)
- 1 *.scala files (169 lines of code)
- 8 *.js files (114 lines of code)
- 2 *.sh files (81 lines of code)
- 1 *.yml files (12 lines of code)
- 1 *.yaml files (8 lines of code)
- " *.ts" is biggest, containing 50.43% of code.
- " *.yaml" is smallest, containing 0.69% of code.
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 ".*/docker[-]compose[.]yaml".
- files with paths like ".*([.]|/)webpack([.]|/).*".
- files with paths like ".*/package[-]lock[.]json".
- files with paths like ".*/docker[-]compose[.]yml".
- files with paths like ".*[.]git[a-z]+".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*[.]sh".
- 1 file matches defined criteria (31 lines of code, 0.5% vs. main code). All matches are in *.js 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 ".*[.]svg".
- files with paths like ".*/[.]eslintignore".
- files with paths like ".*[.]editorconfig".
- files with paths like ".*/[.]prettierignore".
- files with paths like ".*[.]txt".
- files with paths like ".*/[.]npmignore".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*[.](xml|xsd|robot|sql|pgsql|dashboard|profile|ipynb|raml|avsc|al)".
- 61 files match defined criteria (36,128 lines of code, 591.5% vs. main code):
- 42 *.json files (35,317 lines of code)
- 17 *.md files (608 lines of code)
- 1 *.svg files (190 lines of code)
- 1 *.xml files (13 lines of code)
- " *.json" is biggest, containing 97.76% of code.
- " *.xml" is smallest, containing 0.04% of code.
Analyzers
Info about analyzers used for source code examinations.
- *.vue 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
- *.yaml 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
- *.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
- *.py files are analyzed with PythonAnalyzer:
- 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
- Basic heuristic 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
- *.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
- *.gql files are analyzed with DefaultLanguageAnalyzer:
- All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
- Basic code cleaning (empty lines removed for LOC calculations and duplication calculations)
- No unit size analysis
- No conditional complexity analysis
- No dependency analysis
- *.toml files are analyzed with DefaultLanguageAnalyzer:
- All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
- Basic code cleaning (empty lines removed for LOC calculations and duplication calculations)
- No unit size analysis
- No conditional complexity analysis
- No dependency analysis
- *.graphql files are analyzed with DefaultLanguageAnalyzer:
- All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
- Basic code cleaning (empty lines removed for LOC calculations and duplication calculations)
- No unit size analysis
- No conditional complexity analysis
- No dependency analysis
- *.sass files are analyzed with SassAnalyzer:
- 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
- *.cfg files are analyzed with CfgAnalyzer:
- 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-01-31 15:52