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

scoping details...
  • 9 extensions are included in analyses: go, yml, txt, sh, yaml, mod, gitignore, proto, md
  • 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.
main2615 LOC (67%) 30 files
test1032 LOC (26%) 7 files
generated0 LOC (0%) 0 files
build and deployment182 LOC (4%) 7 files
other48 LOC (1%) 1 file
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
proto
Explore:   circles  |  sunburst

go2396 LOC (91%) 24 files
yaml157 LOC (6%) 5 files
proto62 LOC (2%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 30 files match defined criteria (2,615 LOC, 100.0% vs. main code):
    • 24 go files (2,396 LOC)
    • 5 yaml files (157 LOC)
    • 1 proto files (62 LOC)
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
Explore:   circles  |  sunburst

go1032 LOC (100%) 7 files

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*_test[.].*".
  • 7 files match defined criteria (1,032 LOC, 39.5% vs. main code). All matches are in go files.
Build and Deployment Code
Source code used to configure or support build and deployment process.
mod
Explore:   circles  |  sunburst

yaml134 LOC (73%) 2 files
mod34 LOC (18%) 1 file
sh9 LOC (4%) 3 files
gitignore5 LOC (2%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*[.]sh".
    • 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".
  • 7 files match defined criteria (182 LOC, 7.0% vs. main code):
    • 2 yaml files (134 LOC)
    • 1 mod files (34 LOC)
    • 3 sh files (9 LOC)
    • 1 gitignore files (5 LOC)
Other Code
Explore:   circles  |  sunburst

md48 LOC (100%) 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 ".*[.]txt".
  • 1 file matches defined criteria (48 LOC, 1.8% vs. main code). All matches are in md files.
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
  • *.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
  • *.proto 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