guardian/devx-logs
Code Volume
Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
mod

scoping details...
  • 10 extensions are included in analyses: md, ts, go, yml, gitignore, txt, yaml, mod, sh, json
  • 6 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 ".*/_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.
main342 LOC (32%) 6 files
test269 LOC (25%) 4 files
generated0 LOC (0%) 0 files
build and deployment322 LOC (30%) 13 files
other119 LOC (11%) 6 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
Explore:   circles  |  sunburst

go200 LOC (58%) 2 files
ts126 LOC (36%) 3 files
yaml16 LOC (4%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 6 files match defined criteria (342 LOC, 100.0% vs. main code):
    • 2 go files (200 LOC)
    • 3 ts files (126 LOC)
    • 1 yaml files (16 LOC)
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
Explore:   circles  |  sunburst

go187 LOC (69%) 2 files
ts82 LOC (30%) 2 files

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*_test[.].*".
  • 4 files match defined criteria (269 LOC, 78.7% vs. main code):
    • 2 go files (187 LOC)
    • 2 ts files (82 LOC)
Build and Deployment Code
Source code used to configure or support build and deployment process.
mod
Explore:   circles  |  sunburst

yaml232 LOC (72%) 6 files
mod71 LOC (22%) 2 files
sh15 LOC (4%) 2 files
gitignore4 LOC (1%) 3 files

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*/go[.]mod".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]sh".
    • files with paths like ".*/[.]github/workflows/.*[.]ya?ml".
  • 13 files match defined criteria (322 LOC, 94.2% vs. main code):
    • 6 yaml files (232 LOC)
    • 2 mod files (71 LOC)
    • 2 sh files (15 LOC)
    • 3 gitignore files (4 LOC)
Other Code
Explore:   circles  |  sunburst

md113 LOC (94%) 5 files
json6 LOC (5%) 1 file

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".
  • 6 files match defined criteria (119 LOC, 34.8% vs. main code):
    • 5 md files (113 LOC)
    • 1 json files (6 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...
  • *.go files are analyzed with GoLangAnalyzer:
    • 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
  • *.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