Source Code Analysis Scope
Files includes and excluded from analyses

scoping details...
  • 6 extensions are included in analyses: md, json, svg, sh, gitignore, py
  • 4 criteria are used to exclude files from analysis:
    • 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 ".*/git[-][a-zA-Z0-9_]+[.]txt" (Git data exports for sokrates analyses) (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.
main173 LOC (3%) 1 file
test0 LOC (0%) 0 files
generated29 LOC (<1%) 1 file
build and deployment15 LOC (<1%) 2 files
other4588 LOC (95%) 85 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

py173 LOC (100%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 1 file matches defined criteria (173 LOC, 100.0% vs. main code). All matches are in py files.
Generated Code
Automatically generated files, not manually changed after generation.
Explore:   circles  |  sunburst

md29 LOC (100%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with any line of content like "\<\!\-\-[ ]*Generated by .*".
  • 1 file matches defined criteria (29 LOC, 16.8% vs. main code). All matches are in md files.
Build and Deployment Code
Source code used to configure or support build and deployment process.
Explore:   circles  |  sunburst

sh12 LOC (80%) 1 file
gitignore3 LOC (20%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]sh".
  • 2 files match defined criteria (15 LOC, 8.7% vs. main code):
    • 1 sh files (12 LOC)
    • 1 gitignore files (3 LOC)
Other Code
Explore:   circles  |  sunburst

md3211 LOC (69%) 78 files
json1250 LOC (27%) 5 files
svg127 LOC (2%) 2 files

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 ".*[.]svg".
  • 85 files match defined criteria (4,588 LOC, 2652.0% vs. main code):
    • 78 md files (3,211 LOC)
    • 5 json files (1,250 LOC)
    • 2 svg files (127 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