Source Code Analysis Scope
Files includes and excluded from analyses
gitattributes

scoping details...
  • 11 extensions are included in analyses: py, md, yml, json, cjs, txt, toml, gitignore, gitattributes, yaml, sh
  • 6 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/extern(al)?/.*" (Dependencies) (1 file).
    • exclude files with path like ".*/git[-]commit[-]trailers[.]txt" (Git history trailers) (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.
main111115 LOC (55%) 1,945 files
test76201 LOC (38%) 313 files
generated0 LOC (0%) 0 files
build and deployment1032 LOC (<1%) 12 files
other10486 LOC (5%) 87 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

py110786 LOC (99%) 1,933 files
cjs165 LOC (<1%) 5 files
yaml144 LOC (<1%) 5 files
toml20 LOC (<1%) 2 files

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 1945 files match defined criteria (111,115 LOC, 100.0% vs. main code):
    • 1,933 py files (110,786 LOC)
    • 5 cjs files (165 LOC)
    • 5 yaml files (144 LOC)
    • 2 toml files (20 LOC)
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
gitattributes
Explore:   circles  |  sunburst

py75817 LOC (99%) 308 files
cjs383 LOC (<1%) 4 files
gitattributes1 LOC (<1%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*/[Tt]ests/.*".
    • files with paths like ".*/test_.*".
    • files with paths like ".*[.][Tt]est[.].*".
    • files with paths like ".*[.]test[.].*".
    • files with paths like ".*/test[.].*".
  • 313 files match defined criteria (76,201 LOC, 68.6% vs. main code):
    • 308 py files (75,817 LOC)
    • 4 cjs files (383 LOC)
    • 1 gitattributes files (1 LOC)
Build and Deployment Code
Source code used to configure or support build and deployment process.
gitattributes
Explore:   circles  |  sunburst

yaml732 LOC (70%) 9 files
toml281 LOC (27%) 1 file
gitignore18 LOC (1%) 1 file
gitattributes1 LOC (<1%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*/pnpm.*[.]ya?ml".
    • files with paths like ".*/pyproject[.]toml".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitattributes".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/package[.]json".
    • files with paths like ".*[.]sh".
    • files with paths like ".*/[.]github/workflows/.*[.]ya?ml".
    • files with paths like ".*/[.]github/actions/.*[.]ya?ml".
    • files with paths like ".*/action[.]ya?ml".
    • files with paths like "(.*/)?[.](idea|vscode|vs|gradle|mvn|settings|metadata|circleci)/.*".
  • 12 files match defined criteria (1,032 LOC, 0.9% vs. main code):
    • 9 yaml files (732 LOC)
    • 1 toml files (281 LOC)
    • 1 gitignore files (18 LOC)
    • 1 gitattributes files (1 LOC)
Other Code
Explore:   circles  |  sunburst

md7440 LOC (70%) 27 files
py1954 LOC (18%) 46 files
json1073 LOC (10%) 12 files
sh18 LOC (<1%) 1 file
txt1 LOC (<1%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*[.]md".
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.]json".
    • files with paths like ".*/LICENSE[.][a-z0-9]+".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*/[Ee]xamples/.*".
  • 87 files match defined criteria (10,486 LOC, 9.4% vs. main code):
    • 27 md files (7,440 LOC)
    • 46 py files (1,954 LOC)
    • 12 json files (1,073 LOC)
    • 1 sh files (18 LOC)
    • 1 txt 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...
  • *.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