Source Code Analysis Scope
Files includes and excluded from analyses

scoping details...
  • 8 extensions are included in analyses: json, py, sh, yaml, txt, gitignore, md, toml
  • 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.
main8949 LOC (81%) 59 files
test0 LOC (0%) 0 files
generated0 LOC (0%) 0 files
build and deployment315 LOC (2%) 9 files
other1710 LOC (15%) 89 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

py8893 LOC (99%) 54 files
yaml56 LOC (<1%) 5 files

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 59 files match defined criteria (8,949 LOC, 100.0% vs. main code):
    • 54 py files (8,893 LOC)
    • 5 yaml files (56 LOC)
Build and Deployment Code
Source code used to configure or support build and deployment process.
Explore:   circles  |  sunburst

gitignore132 LOC (41%) 1 file
sh117 LOC (37%) 7 files
toml66 LOC (20%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*/pyproject[.]toml".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]sh".
  • 9 files match defined criteria (315 LOC, 3.5% vs. main code):
    • 1 gitignore files (132 LOC)
    • 7 sh files (117 LOC)
    • 1 toml files (66 LOC)
Other Code
Explore:   circles  |  sunburst

json1576 LOC (92%) 88 files
md134 LOC (7%) 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".
    • files with paths like ".*[.]json".
  • 89 files match defined criteria (1,710 LOC, 19.1% vs. main code):
    • 88 json files (1,576 LOC)
    • 1 md files (134 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
  • *.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