Source Code Analysis Scope
Files includes and excluded from analyses

scoping details...
  • 9 extensions are included in analyses: ts, md, json, yml, txt, sh, gitignore, py, yaml
  • 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.
main289 LOC (9%) 2 files
test0 LOC (0%) 0 files
generated0 LOC (0%) 0 files
build and deployment265 LOC (8%) 6 files
other2607 LOC (82%) 29 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

py278 LOC (96%) 1 file
yaml11 LOC (3%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 2 files match defined criteria (289 LOC, 100.0% vs. main code):
    • 1 py files (278 LOC)
    • 1 yaml files (11 LOC)
Build and Deployment Code
Source code used to configure or support build and deployment process.
Explore:   circles  |  sunburst

sh133 LOC (50%) 2 files
yaml132 LOC (49%) 4 files

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*/package[.]json".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]sh".
    • files with paths like ".*/[.]github/workflows/.*[.]ya?ml".
  • 6 files match defined criteria (265 LOC, 91.7% vs. main code):
    • 2 sh files (133 LOC)
    • 4 yaml files (132 LOC)
Other Code
Explore:   circles  |  sunburst

md1400 LOC (53%) 6 files
ts1094 LOC (41%) 16 files
json106 LOC (4%) 6 files
gitignore7 LOC (<1%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*[.]md".
    • files with paths like ".*/LICENSE[.][a-z0-9]+".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*/[Ee]xamples/.*".
    • files with paths like ".*[.]json".
    • files with paths like ".*[.]txt".
  • 29 files match defined criteria (2,607 LOC, 902.1% vs. main code):
    • 6 md files (1,400 LOC)
    • 16 ts files (1,094 LOC)
    • 6 json files (106 LOC)
    • 1 gitignore files (7 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