guardian/commercial
Code Volume Analysis scope, overview of main, test, generated, deployment, build, and other code. |
Source Code Analysis Scope
Files includes and excluded from analyses
scoping details...
- 17 extensions are included in analyses: ts, md, json, js, yml, mjs, yaml, gitignore, txt, sh, svg, toml, patch, editorconfig, html, npmrc, prettierignore
- 8 criteria are used to exclude files from analysis:
- exclude files with path like ".*\.d\.ts" (Typescript definition files) (2 files).
- exclude files with path like ".*/extern(al)?/.*" (Dependencies) (1 file).
- exclude files with path like ".*/docs/.*" (Documentation) (16 files).
- exclude files with path like ".*/git[-]commit[-]trailers[.]txt" (Git history trailers) (1 file).
- exclude files with path like ".*/git[-][a-zA-Z0-9_]+[.]txt" (Git data exports for sokrates analyses) (1 file).
- exclude files with path like ".*/_sokrates/.*" (Sokrates files) (0 files).
- exclude files with path like ".*/_sokrates_landscape/.*" (Sokrates landscape files) (0 files).
- exclude files with path like ".*/sokrates_.*?[.]json" (Sokrates conventions and configurations) (0 files).
- The source code folder contains 423 files:
- 377 files are included in analyses.
- 46 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.
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
scope details...
- The following criteria are used to filter files:
- files with paths like ".*".
- 211 files match defined criteria (15,076 LOC, 100.0% vs. main code):
- 203 ts files (14,751 LOC)
- 3 yaml files (136 LOC)
- 1 mjs files (106 LOC)
- 3 js files (75 LOC)
- 1 toml files (8 LOC)
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
scope details...
- The following criteria are used to filter files:
- files with paths like ".*/jest[.][a-zA-Z0-9\.]+".
- files with paths like ".*[.]spec[.]ts".
- files with paths like ".*[.][Tt]est[.].*".
- files with paths like ".*[.]test[.].*".
- files with paths like ".*/[Tt]ests/.*".
- files with paths like ".*[-]test[-].*".
- files with paths like ".*/__mock[^/]*/.*".
- 117 files match defined criteria (15,756 LOC, 104.5% vs. main code):
- 111 ts files (15,613 LOC)
- 5 js files (126 LOC)
- 1 html files (17 LOC)
Build and Deployment Code
Source code used to configure or support build and deployment process.
scope details...
- The following criteria are used to filter files:
- files with paths like ".*[.]git[a-z]+".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*/package[.]json".
- files with paths like ".*([.]|/)webpack([.]|/).*".
- files with paths like ".*[.]npmrc".
- files with paths like "(.*/)?[.]npmrc".
- files with paths like ".*/[.]prettierignore".
- files with paths like "(.*/)?[.]prettierignore".
- files with paths like ".*[.]editorconfig".
- files with paths like "(.*/)?[.]editorconfig".
- files with paths like ".*[.]sh".
- files with paths like ".*/[.]github/workflows/.*[.]ya?ml".
- files with paths like ".*/[.]github/actions/.*[.]ya?ml".
- files with paths like ".*/action[.]ya?ml".
- files with paths like "(.*/)?[.](idea|vscode|vs|gradle|mvn|settings|metadata|circleci)/.*".
- files with paths like ".*/pnpm.*[.]ya?ml".
- 22 files match defined criteria (740 LOC, 4.9% vs. main code):
- 8 yaml files (358 LOC)
- 5 mjs files (257 LOC)
- 3 sh files (60 LOC)
- 3 gitignore files (30 LOC)
- 1 editorconfig files (23 LOC)
- 1 prettierignore files (11 LOC)
- 1 npmrc files (1 LOC)
Other Code
scope details...
- 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 ".*[.]patch".
- files with paths like ".*[.]svg".
- files with paths like ".*[.]txt".
- 27 files match defined criteria (1,557 LOC, 10.3% vs. main code):
- 12 md files (1,165 LOC)
- 13 json files (379 LOC)
- 1 patch files (12 LOC)
- 1 svg files (1 LOC)
About This Analysis
learn more about scopes (main, test, generated, build, 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.
learn more about used code analyzers...
- *.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
- *.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
- *.mjs 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
- *.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
- *.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