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: js, ts, md, json, html, sh, css, gitignore, txt, yml, npmignore, svg, clang-format, gitattributes, less, jshintrc
- 9 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (10 files).
- exclude files with path like ".*/angular([^.]*)\.js" (AngularJS) (6 files).
- exclude files with path like ".*/docs/.*" (Documentation) (26 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 ".*[.]min[.]js" (Minimized JS library) (11 files).
- exclude files with path like ".*[.]txt" (Text files) (1 file).
- exclude files with path like ".*/prettify[.]js" (1 file).
- exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
- The source code folder contains 420 files:
- 338 files are included in analyses.
- 82 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 ".*".
- 276 files match defined criteria (12,283 lines of code, 100.0% vs. main code):
- 184 *.js files (6,923 lines of code)
- 60 *.ts files (4,197 lines of code)
- 25 *.html files (897 lines of code)
- 1 *.less files (153 lines of code)
- 6 *.css files (113 lines of code)
- " *.js" is biggest, containing 56.36% of code.
- " *.css" is smallest, containing 0.92% 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 ".*/karma[.]conf[.]js".
- files with paths like ".*/protractor[.]conf[.]js".
- files with paths like ".*_test[.].*".
- files with paths like ".*/[Tt]est/.*".
- files with paths like ".*/e2e/.*".
- files with paths like ".*/test_.*".
- files with paths like ".*/[Ss]pecs/.*".
- files with any line of content like ".*/simpletest/.*".
- 22 files match defined criteria (1,527 lines of code, 12.4% vs. main code):
- 21 *.js files (1,516 lines of code)
- 1 *.sh files (11 lines of code)
- " *.js" is biggest, containing 99.28% of code.
- " *.sh" is smallest, containing 0.72% 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[-]lock[.]json".
- files with paths like ".*/package[.]json".
- files with paths like ".*[.]sh".
- files with paths like ".*[.]git[a-z]+".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*/[.]gitattributes".
- 7 files match defined criteria (145 lines of code, 1.2% vs. main code). All matches are in *.sh files.
Other Code
- The following criteria are used to filter files:
- files with paths like ".*[.]json".
- files with paths like ".*[.]md".
- files with paths like ".*/README[.][a-z0-9]+".
- files with paths like ".*[.]txt".
- files with paths like ".*/[.]npmignore".
- files with paths like ".*/[.]gitignore".
- 33 files match defined criteria (22,191 lines of code, 180.7% vs. main code):
- 24 *.json files (18,840 lines of code)
- 9 *.md files (3,351 lines of code)
- " *.json" is biggest, containing 84.9% of code.
- " *.md" is smallest, containing 15.1% 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
- *.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
- *.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
- *.less files are analyzed with LessAnalyzer:
- 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
- *.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
2022-02-02 22:06