guardian/guardian-engineering-site
Code Volume
Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
mdx
svelte
mjs
editorconfig
npmrc
prettierignore

scoping details...
  • 16 extensions are included in analyses: md, json, ts, mdx, txt, gitignore, js, yml, yaml, css, svelte, mjs, tsx, editorconfig, npmrc, prettierignore
  • 7 criteria are used to exclude files from analysis:
    • 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) (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).
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.
main684 LOC (3%) 9 files
test0 LOC (0%) 0 files
generated0 LOC (0%) 0 files
build and deployment4560 LOC (20%) 9 files
other17438 LOC (76%) 308 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
svelte
mjs
Explore:   circles  |  sunburst

js397 LOC (58%) 2 files
svelte130 LOC (19%) 1 file
ts124 LOC (18%) 3 files
mjs19 LOC (2%) 1 file
tsx11 LOC (1%) 1 file
css3 LOC (<1%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 9 files match defined criteria (684 LOC, 100.0% vs. main code):
    • 2 js files (397 LOC)
    • 1 svelte files (130 LOC)
    • 3 ts files (124 LOC)
    • 1 mjs files (19 LOC)
    • 1 tsx files (11 LOC)
    • 1 css files (3 LOC)
Build and Deployment Code
Source code used to configure or support build and deployment process.
editorconfig
npmrc
prettierignore
Explore:   circles  |  sunburst

yaml4434 LOC (97%) 4 files
gitignore119 LOC (2%) 2 files
editorconfig3 LOC (<1%) 1 file
npmrc2 LOC (<1%) 1 file
prettierignore2 LOC (<1%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*/pnpm.*[.]ya?ml".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/package[.]json".
    • files with paths like ".*[.]npmrc".
    • files with paths like "(.*/)?[.]npmrc".
    • files with paths like ".*/[.]prettierignore".
    • files with paths like "(.*/)?[.]prettierignore".
    • files with paths like ".*[.]editorconfig".
    • files with paths like "(.*/)?[.]editorconfig".
    • files with paths like ".*/[.]github/workflows/.*[.]ya?ml".
    • files with paths like "(.*/)?[.](idea|vscode|vs|gradle|mvn|settings|metadata|circleci)/.*".
  • 9 files match defined criteria (4,560 LOC, 666.7% vs. main code):
    • 4 yaml files (4,434 LOC)
    • 2 gitignore files (119 LOC)
    • 1 editorconfig files (3 LOC)
    • 1 npmrc files (2 LOC)
    • 1 prettierignore files (2 LOC)
Other Code
mdx
Explore:   circles  |  sunburst

md15205 LOC (87%) 298 files
json2040 LOC (11%) 8 files
mdx193 LOC (1%) 2 files

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 ".*[.]txt".
    • files with paths like ".*[.]mdx".
  • 308 files match defined criteria (17,438 LOC, 2549.4% vs. main code):
    • 298 md files (15,205 LOC)
    • 8 json files (2,040 LOC)
    • 2 mdx files (193 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...
  • *.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
  • *.svelte 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
  • *.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
  • *.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
  • *.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