guardian/grid
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...
- 29 extensions are included in analyses: scala, js, java, html, md, ts, css, json, sh, tsx, svg, yml, txt, gitignore, yaml, xml, sbt, dockerignore, feature, snap, eml, json5, py, jsonl, editorconfig, babelrc, mjs, eslintignore, properties
- 9 criteria are used to exclude files from analysis:
- exclude files with path like "(?i).*/require.*[.]js" (RequireJS files) (1 file).
- exclude files with path like ".*\.d\.ts" (Typescript definition files) (1 file).
- exclude files with path like ".*/bin/.*" (Binaries for distribution) (1 file).
- exclude files with path like ".*/docs/.*" (Documentation) (43 files).
- exclude files with path like ".*/git[-]commit[-]trailers[.]txt" (Git history trailers) (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 ".*/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,251 files:
- 1,078 files are included in analyses.
- 173 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 ".*".
- 811 files match defined criteria (65,265 LOC, 100.0% vs. main code):
- 372 scala files (25,231 LOC)
- 140 js files (12,246 LOC)
- 97 java files (11,338 LOC)
- 80 html files (5,009 LOC)
- 53 css files (4,687 LOC)
- 38 ts files (3,155 LOC)
- 18 tsx files (2,708 LOC)
- 7 yaml files (702 LOC)
- 1 py files (58 LOC)
- 1 json5 files (51 LOC)
- 2 xml files (50 LOC)
- 1 eml files (25 LOC)
- 1 mjs files (5 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 ".*[.]spec[.]js".
- files with paths like ".*[.]spec[.]ts".
- 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 ".*[-]tests/.*".
- files with paths like ".*[.]feature".
- files with paths like ".*__tests__.*".
- files with paths like ".*/test[-]data/.*".
- 147 files match defined criteria (16,641 LOC, 25.5% vs. main code):
- 93 scala files (10,859 LOC)
- 37 ts files (3,650 LOC)
- 2 snap files (1,381 LOC)
- 2 feature files (369 LOC)
- 7 js files (254 LOC)
- 3 sh files (106 LOC)
- 1 dockerignore files (10 LOC)
- 1 xml files (8 LOC)
- 1 jsonl files (4 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 "(.*/)?[.]babelrc([.].*)?".
- files with paths like ".*([.]|/)webpack([.]|/).*".
- files with paths like ".*[.]git[a-z]+".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*/package[.]json".
- files with paths like ".*/[.]eslintignore".
- files with paths like "(.*/)?[.]eslintignore".
- files with paths like ".*[.]sh".
- files with paths like ".*[.]editorconfig".
- files with paths like "(.*/)?[.]editorconfig".
- files with paths like ".*/Dockerfile[.][a-zA-Z0-9._-]+".
- files with paths like ".*/package[-]lock[.]json".
- files with paths like ".*[.]sbt".
- files with paths like ".*/[.]github/workflows/.*[.]ya?ml".
- files with paths like ".*/[.]dockerignore".
- files with paths like "(.*/)?[.]dockerignore".
- files with paths like ".*/docker[-]compose[.]yml".
- files with paths like ".*/requirements[a-zA-Z0-9._-]*[.]txt".
- 41 files match defined criteria (1,648 LOC, 2.5% vs. main code):
- 21 sh files (883 LOC)
- 6 yaml files (313 LOC)
- 2 sbt files (260 LOC)
- 3 js files (114 LOC)
- 5 gitignore files (56 LOC)
- 1 editorconfig files (11 LOC)
- 1 babelrc files (7 LOC)
- 1 dockerignore files (2 LOC)
- 1 eslintignore files (2 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 ".*[.]svg".
- files with paths like ".*[.]json".
- files with paths like ".*[.]txt".
- files with paths like ".*[.]properties".
- 79 files match defined criteria (23,406 LOC, 35.9% vs. main code):
- 30 json files (21,861 LOC)
- 35 md files (925 LOC)
- 4 txt files (563 LOC)
- 9 svg files (56 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
- *.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
- *.java files are analyzed with JavaAnalyzer:
- 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 (based on package names)
- *.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
- *.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
- *.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
- *.py files are analyzed with PythonAnalyzer:
- 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
- *.json5 files are analyzed with JsonAnalyzer:
- 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
- *.eml 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
- *.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