guardian/support-admin-console
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: tsx, ts, scala, json, md, js, yaml, html, sh, gitignore, txt, mjs, sbt, editorconfig, yml, css, gitattributes, xml, npmrc, properties, snap
- 8 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) (2 files).
- exclude files with path like ".*\.d\.ts" (Typescript definition files) (1 file).
- 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 507 files:
- 478 files are included in analyses.
- 29 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 ".*".
- 371 files match defined criteria (34,917 LOC, 100.0% vs. main code):
- 193 tsx files (24,640 LOC)
- 103 scala files (5,645 LOC)
- 64 ts files (4,351 LOC)
- 2 mjs files (98 LOC)
- 4 html files (80 LOC)
- 3 yaml files (74 LOC)
- 1 xml files (26 LOC)
- 1 css files (3 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 ".*[.]spec[.]ts".
- files with paths like ".*/e2e/.*".
- files with paths like ".*[-]test[-].*".
- files with paths like ".*[-]tests[-].*".
- 73 files match defined criteria (6,234 LOC, 17.9% vs. main code):
- 1 snap files (2,684 LOC)
- 48 ts files (2,014 LOC)
- 14 tsx files (976 LOC)
- 6 scala files (512 LOC)
- 1 mjs files (34 LOC)
- 3 js files (14 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 ".*/pnpm.*[.]ya?ml".
- files with paths like ".*[.]editorconfig".
- files with paths like "(.*/)?[.]editorconfig".
- files with paths like ".*[.]git[a-z]+".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*/package[.]json".
- files with paths like ".*[.]sh".
- files with paths like ".*[.]npmrc".
- files with paths like "(.*/)?[.]npmrc".
- files with paths like ".*([.]|/)webpack([.]|/).*".
- files with paths like ".*[.]sbt".
- files with paths like "(.*/)?[.]prettierrc([.].*)?".
- files with paths like ".*/[.]github/workflows/.*[.]ya?ml".
- files with paths like ".*/[.]gitattributes".
- 19 files match defined criteria (5,875 LOC, 16.8% vs. main code):
- 4 yaml files (5,606 LOC)
- 3 js files (91 LOC)
- 2 sbt files (87 LOC)
- 3 sh files (36 LOC)
- 3 gitignore files (33 LOC)
- 2 editorconfig files (20 LOC)
- 1 gitattributes files (1 LOC)
- 1 npmrc 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".
- 15 files match defined criteria (373 LOC, 1.1% vs. main code):
- 9 json files (226 LOC)
- 5 md files (146 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
- *.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
- *.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
- *.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
- *.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