Source Code Analysis Scope
Files includes and excluded from analyses
mod
proto

scoping details...
  • 10 extensions are included in analyses: json, go, js, txt, md, gitignore, html, mod, proto, yml
  • 7 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/docs/.*" (Documentation) (49 files).
    • 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.
main2877 LOC (61%) 38 files
test1325 LOC (28%) 11 files
generated0 LOC (0%) 0 files
build and deployment47 LOC (1%) 4 files
other402 LOC (8%) 4 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

go2683 LOC (93%) 37 files
html194 LOC (6%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 38 files match defined criteria (2,877 LOC, 100.0% vs. main code):
    • 37 go files (2,683 LOC)
    • 1 html files (194 LOC)
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
proto
Explore:   circles  |  sunburst

go1100 LOC (83%) 9 files
js212 LOC (16%) 1 file
proto13 LOC (<1%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*/test_.*".
    • files with paths like ".*_tests[.].*".
    • files with paths like ".*_test[.].*".
  • 11 files match defined criteria (1,325 LOC, 46.1% vs. main code):
    • 9 go files (1,100 LOC)
    • 1 js files (212 LOC)
    • 1 proto files (13 LOC)
Build and Deployment Code
Source code used to configure or support build and deployment process.
mod
Explore:   circles  |  sunburst

yaml23 LOC (48%) 1 file
mod21 LOC (44%) 1 file
gitignore3 LOC (6%) 2 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 ".*/[.]github/workflows/.*[.]ya?ml".
  • 4 files match defined criteria (47 LOC, 1.6% vs. main code):
    • 1 yaml files (23 LOC)
    • 1 mod files (21 LOC)
    • 2 gitignore files (3 LOC)
Other Code
Explore:   circles  |  sunburst

md401 LOC (99%) 3 files
json1 LOC (<1%) 1 file

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".
  • 4 files match defined criteria (402 LOC, 14.0% vs. main code):
    • 3 md files (401 LOC)
    • 1 json 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...
  • *.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
  • *.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