guardian/notifications-tooling
Code Volume
Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
webmanifest
editorconfig
mjs
snap
prettierignore

scoping details...
  • 19 extensions are included in analyses: ts, tsx, json, md, sql, yml, gitignore, sh, txt, js, css, webmanifest, editorconfig, html, yaml, toml, mjs, snap, prettierignore
  • 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) (72 files).
    • exclude files with path like ".*/git[-]commit[-]trailers[.]txt" (Git history trailers) (1 file).
    • exclude files with path like ".*\.d\.ts" (Typescript definition files) (3 files).
    • 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).
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.
main28862 LOC (63%) 309 files
test12514 LOC (27%) 62 files
generated0 LOC (0%) 0 files
build and deployment323 LOC (<1%) 10 files
other3511 LOC (7%) 38 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
webmanifest
mjs
Explore:   circles  |  sunburst

tsx15228 LOC (52%) 136 files
ts13049 LOC (45%) 154 files
js271 LOC (<1%) 2 files
sql146 LOC (<1%) 8 files
yaml86 LOC (<1%) 4 files
html39 LOC (<1%) 1 file
css20 LOC (<1%) 1 file
webmanifest19 LOC (<1%) 1 file
mjs2 LOC (<1%) 1 file
toml2 LOC (<1%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 309 files match defined criteria (28,862 LOC, 100.0% vs. main code):
    • 136 tsx files (15,228 LOC)
    • 154 ts files (13,049 LOC)
    • 2 js files (271 LOC)
    • 8 sql files (146 LOC)
    • 4 yaml files (86 LOC)
    • 1 html files (39 LOC)
    • 1 css files (20 LOC)
    • 1 webmanifest files (19 LOC)
    • 1 mjs files (2 LOC)
    • 1 toml files (2 LOC)
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
snap
Explore:   circles  |  sunburst

ts10658 LOC (85%) 55 files
snap1387 LOC (11%) 1 file
tsx469 LOC (3%) 6 files

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*[.][Tt]est[.].*".
    • files with paths like ".*[.]test[.].*".
    • files with paths like ".*[.]snap".
    • files with paths like ".*[-]test[-].*".
    • files with paths like ".*/vitest[.].*".
    • files with paths like ".*[-]tests/.*".
  • 62 files match defined criteria (12,514 LOC, 43.4% vs. main code):
    • 55 ts files (10,658 LOC)
    • 1 snap files (1,387 LOC)
    • 6 tsx files (469 LOC)
Build and Deployment Code
Source code used to configure or support build and deployment process.
editorconfig
prettierignore
Explore:   circles  |  sunburst

yaml128 LOC (39%) 1 file
sh105 LOC (32%) 3 files
gitignore69 LOC (21%) 4 files
editorconfig13 LOC (4%) 1 file
prettierignore8 LOC (2%) 1 file

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 ".*/[.]prettierignore".
    • files with paths like "(.*/)?[.]prettierignore".
    • files with paths like ".*[.]editorconfig".
    • files with paths like "(.*/)?[.]editorconfig".
    • files with paths like ".*[.]sh".
    • files with paths like ".*/[.]github/workflows/.*[.]ya?ml".
  • 10 files match defined criteria (323 LOC, 1.1% vs. main code):
    • 1 yaml files (128 LOC)
    • 3 sh files (105 LOC)
    • 4 gitignore files (69 LOC)
    • 1 editorconfig files (13 LOC)
    • 1 prettierignore files (8 LOC)
Other Code
Explore:   circles  |  sunburst

json2859 LOC (81%) 30 files
md652 LOC (18%) 8 files

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 ".*[.]txt".
    • files with paths like ".*/[Ee]xamples/.*".
  • 38 files match defined criteria (3,511 LOC, 12.2% vs. main code):
    • 30 json files (2,859 LOC)
    • 8 md files (652 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
  • *.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
  • *.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
  • *.sql files are analyzed with SqlAnalyzer:
    • 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
  • *.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
  • *.webmanifest 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
  • *.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
  • *.toml 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