guardian/newsletters-nx
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, tsx, json, md, feature, mjs, yaml, js, txt, gitignore, babelrc, sh, yml, editorconfig, html, snap, prettierignore
- 9 criteria are used to exclude files from analysis:
- exclude files with path like ".*/bin/.*" (Binaries for distribution) (1 file).
- exclude files with path like ".*/docs/.*" (Documentation) (13 files).
- exclude files with path like ".*/git[-]commit[-]trailers[.]txt" (Git history trailers) (1 file).
- 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) (1 file).
- exclude files with path like ".*\.d\.ts" (Typescript definition files) (2 files).
- 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 574 files:
- 541 files are included in analyses.
- 33 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 ".*".
- 394 files match defined criteria (25,649 LOC, 100.0% vs. main code):
- 239 ts files (14,589 LOC)
- 138 tsx files (10,207 LOC)
- 4 yaml files (473 LOC)
- 10 mjs files (334 LOC)
- 1 html files (29 LOC)
- 2 js files (17 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 ".*[.][Tt]est[.].*".
- files with paths like ".*[.]test[.].*".
- files with paths like ".*[.]snap".
- files with paths like ".*/testing[.].*".
- files with paths like ".*[.]spec[.]ts".
- files with paths like ".*/test[-]helpers/.*".
- files with paths like ".*[.]spec[.]tsx".
- files with paths like ".*[.]feature".
- 68 files match defined criteria (7,604 LOC, 29.6% vs. main code):
- 49 ts files (4,123 LOC)
- 1 snap files (2,763 LOC)
- 15 feature files (629 LOC)
- 2 tsx files (88 LOC)
- 1 js files (1 LOC)
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.
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[-]lock[.]json".
- files with paths like ".*/package[.]json".
- files with paths like "(.*/)?[.]eslintrc([.].*)?".
- files with paths like ".*[.]sh".
- files with paths like ".*/[.]prettierignore".
- files with paths like "(.*/)?[.]prettierignore".
- files with paths like ".*[.]editorconfig".
- files with paths like "(.*/)?[.]editorconfig".
- files with paths like "(.*/)?[.]babelrc([.].*)?".
- files with paths like ".*/[.]github/workflows/.*[.]ya?ml".
- files with paths like "(.*/)?[.](idea|vscode|vs|gradle|mvn|settings|metadata|circleci)/.*".
- files with paths like ".*/pnpm.*[.]ya?ml".
- 15 files match defined criteria (401 LOC, 1.6% vs. main code):
- 3 yaml files (201 LOC)
- 3 gitignore files (73 LOC)
- 3 sh files (50 LOC)
- 3 babelrc files (26 LOC)
- 1 editorconfig files (23 LOC)
- 1 js files (22 LOC)
- 1 prettierignore files (6 LOC)
Other Code
scope details...
- 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".
- 64 files match defined criteria (13,943 LOC, 54.4% vs. main code):
- 54 json files (13,653 LOC)
- 9 md files (238 LOC)
- 1 txt files (52 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
- *.tsx 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
- *.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
- *.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