guardian/support-frontend
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...
- 21 extensions are included in analyses: scala, tsx, ts, json, sbt, md, yml, js, sh, yaml, snap, html, xml, jsx, gitignore, mjs, java, txt, svg, gitattributes, properties
- 7 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) (3 files).
- exclude files with path like ".*\.d\.ts" (Typescript definition files) (3 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 ".*/git[-][a-zA-Z0-9_]+[.]txt" (Git data exports for sokrates analyses) (0 files).
- exclude files with path like ".*/sokrates_.*?[.]json" (Sokrates conventions and configurations) (0 files).
- The source code folder contains 1,719 files:
- 1,591 files are included in analyses.
- 128 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 ".*".
- 1120 files match defined criteria (80,105 LOC, 100.0% vs. main code):
- 401 tsx files (35,975 LOC)
- 400 scala files (20,783 LOC)
- 262 ts files (20,632 LOC)
- 15 yaml files (1,278 LOC)
- 9 js files (564 LOC)
- 12 html files (473 LOC)
- 7 mjs files (185 LOC)
- 8 jsx files (113 LOC)
- 6 xml files (102 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 ".*/[Tt]est/.*".
- files with paths like ".*/[Tt]ests/.*".
- files with paths like ".*/__mock[^/]*/.*".
- files with paths like ".*__tests__.*".
- files with paths like ".*[.]spec[.]ts".
- files with paths like ".*[-]test[-].*".
- 314 files match defined criteria (40,185 LOC, 50.2% vs. main code):
- 147 ts files (14,502 LOC)
- 12 snap files (12,936 LOC)
- 120 scala files (11,271 LOC)
- 22 tsx files (1,318 LOC)
- 5 js files (70 LOC)
- 4 java files (44 LOC)
- 3 xml files (43 LOC)
- 1 sh files (1 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 ".*[.]sbt".
- 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 ".*/[.]gitattributes".
- files with paths like "(.*/)?[.](idea|vscode|vs|gradle|mvn|settings|metadata|circleci)/.*".
- files with paths like ".*([.]|/)webpack([.]|/).*".
- files with paths like ".*/pnpm.*[.]ya?ml".
- 83 files match defined criteria (2,145 LOC, 2.7% vs. main code):
- 25 yaml files (862 LOC)
- 29 sbt files (671 LOC)
- 16 sh files (331 LOC)
- 4 js files (203 LOC)
- 8 gitignore files (77 LOC)
- 1 gitattributes files (1 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 ".*[.]properties".
- files with paths like ".*[.]txt".
- 74 files match defined criteria (6,216 LOC, 7.8% vs. main code):
- 51 json files (4,591 LOC)
- 21 md files (1,615 LOC)
- 1 txt files (9 LOC)
- 1 properties 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...
- *.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
- *.scala files are analyzed with ScalaAnalyzer:
- 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
- *.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
- *.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
- *.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
- *.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
- *.jsx 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
- *.xml files are analyzed with XmlAnalyzer:
- 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