Source Code Analysis Scope
Files includes and excluded from analyses
mod
gitattributes
jsonl

scoping details...
  • 12 extensions are included in analyses: go, md, yml, py, json, cjs, mod, txt, gitignore, gitattributes, toml, jsonl
  • 8 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/testdata/.*" (Test data) (4 files).
    • exclude files with path like ".*/docs/.*" (Documentation) (1 file).
    • 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.
main18947 LOC (14%) 109 files
test40916 LOC (32%) 159 files
generated59725 LOC (46%) 242 files
build and deployment1242 LOC (<1%) 12 files
other6486 LOC (5%) 61 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

go17314 LOC (91%) 98 files
py1385 LOC (7%) 3 files
cjs134 LOC (<1%) 4 files
yaml111 LOC (<1%) 3 files
toml3 LOC (<1%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 109 files match defined criteria (18,947 LOC, 100.0% vs. main code):
    • 98 go files (17,314 LOC)
    • 3 py files (1,385 LOC)
    • 4 cjs files (134 LOC)
    • 3 yaml files (111 LOC)
    • 1 toml files (3 LOC)
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
Explore:   circles  |  sunburst

go39242 LOC (95%) 153 files
py1494 LOC (3%) 4 files
cjs180 LOC (<1%) 2 files

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*_test[.].*".
    • files with paths like ".*/test[.].*".
    • files with paths like ".*[.][Tt]est[.].*".
    • files with paths like ".*[.]test[.].*".
    • files with paths like ".*/test_.*".
  • 159 files match defined criteria (40,916 LOC, 215.9% vs. main code):
    • 153 go files (39,242 LOC)
    • 4 py files (1,494 LOC)
    • 2 cjs files (180 LOC)
Generated Code
Automatically generated files, not manually changed after generation.
Explore:   circles  |  sunburst

go59725 LOC (100%) 242 files

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*[.](kts?|java|go|py|cs)" AND any line of content like "[/][/][ ]*File generated from .*".
  • 242 files match defined criteria (59,725 LOC, 315.2% 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
gitattributes
Explore:   circles  |  sunburst

yaml970 LOC (78%) 7 files
mod261 LOC (21%) 3 files
gitignore10 LOC (<1%) 1 file
gitattributes1 LOC (<1%) 1 file

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 ".*/[.]gitattributes".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/[.]github/workflows/.*[.]ya?ml".
  • 12 files match defined criteria (1,242 LOC, 6.6% vs. main code):
    • 7 yaml files (970 LOC)
    • 3 mod files (261 LOC)
    • 1 gitignore files (10 LOC)
    • 1 gitattributes files (1 LOC)
Other Code
mod
jsonl
Explore:   circles  |  sunburst

md4601 LOC (70%) 27 files
go1739 LOC (26%) 27 files
json96 LOC (1%) 5 files
mod40 LOC (<1%) 1 file
jsonl10 LOC (<1%) 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 ".*/[Ee]xamples/.*".
    • files with paths like ".*[.]txt".
  • 61 files match defined criteria (6,486 LOC, 34.2% vs. main code):
    • 27 md files (4,601 LOC)
    • 27 go files (1,739 LOC)
    • 5 json files (96 LOC)
    • 1 mod files (40 LOC)
    • 1 jsonl files (10 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
  • *.py files are analyzed with PythonAnalyzer:
    • 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
  • *.cjs 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
  • *.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
  • *.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