guardian/media-atom-maker
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, ts, tsx, scss, md, sh, json, svg, yaml, js, xml, html, sbt, yml, gitignore, txt, editorconfig, babelrc, mjs, eslintignore, properties
- 8 criteria are used to exclude files from analysis:
- exclude files with path like ".*\.d\.ts" (Typescript definition files) (4 files).
- exclude files with path like ".*/docs/.*" (Documentation) (11 files).
- exclude files with path like ".*/[Vv]endors?/.*" (Dependencies) (2 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 592 files:
- 526 files are included in analyses.
- 66 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 ".*".
- 425 files match defined criteria (28,676 LOC, 100.0% vs. main code):
- 171 scala files (11,435 LOC)
- 78 tsx files (8,008 LOC)
- 119 ts files (5,406 LOC)
- 36 scss files (2,213 LOC)
- 7 yaml files (1,145 LOC)
- 5 js files (294 LOC)
- 4 html files (89 LOC)
- 4 xml files (59 LOC)
- 1 mjs files (27 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 ".*/[Tt]est/.*".
- files with paths like ".*[-]tests/.*".
- files with paths like ".*[-]test[-].*".
- files with paths like ".*[.]spec[.]ts".
- files with paths like ".*[.][Tt]est[.].*".
- files with paths like ".*[.]test[.].*".
- files with paths like ".*/vitest[.].*".
- 51 files match defined criteria (4,982 LOC, 17.4% vs. main code):
- 35 scala files (3,729 LOC)
- 10 ts files (838 LOC)
- 3 tsx files (392 LOC)
- 2 sh files (13 LOC)
- 1 xml files (10 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 "(.*/)?[.]babelrc([.].*)?".
- files with paths like ".*[.]sbt".
- files with paths like ".*[.]sh".
- files with paths like ".*[.]git[a-z]+".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*[.]editorconfig".
- files with paths like "(.*/)?[.]editorconfig".
- files with paths like ".*/package[.]json".
- files with paths like ".*/[.]github/workflows/.*[.]ya?ml".
- files with paths like "(.*/)?[.]eslintrc([.].*)?".
- files with paths like ".*/[.]eslintignore".
- files with paths like "(.*/)?[.]eslintignore".
- 23 files match defined criteria (760 LOC, 2.7% vs. main code):
- 10 sh files (312 LOC)
- 3 sbt files (278 LOC)
- 3 yaml files (90 LOC)
- 1 js files (32 LOC)
- 3 gitignore files (23 LOC)
- 1 babelrc files (15 LOC)
- 1 editorconfig files (9 LOC)
- 1 eslintignore files (1 LOC)
Other Code
scope details...
- The following criteria are used to filter files:
- files with paths like ".*[.]md".
- files with paths like ".*/README[.][a-z0-9]+".
- files with paths like ".*[.]json".
- files with paths like ".*[.]properties".
- files with paths like ".*[.]svg".
- files with paths like ".*/vendor/.*".
- files with paths like ".*[.]txt".
- 27 files match defined criteria (795 LOC, 2.8% vs. main code):
- 11 json files (510 LOC)
- 8 md files (245 LOC)
- 7 svg files (39 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...
- *.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
- *.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
- *.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
- *.scss files are analyzed with ScssAnalyzer:
- 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
- *.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
- *.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
- *.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