Source Code Analysis Scope
Files includes and excluded from analyses
gitattributes

scoping details...
  • 11 extensions are included in analyses: ex, exs, md, txt, yml, sh, css, gitignore, py, gitattributes, toml
  • 7 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/docs/.*" (Documentation) (4 files).
    • 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.
main11929 LOC (41%) 57 files
test12744 LOC (44%) 30 files
generated0 LOC (0%) 0 files
build and deployment267 LOC (<1%) 7 files
other3582 LOC (12%) 24 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

ex10846 LOC (90%) 51 files
py536 LOC (4%) 1 file
css406 LOC (3%) 1 file
exs138 LOC (1%) 3 files
toml3 LOC (<1%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 57 files match defined criteria (11,929 LOC, 100.0% vs. main code):
    • 51 ex files (10,846 LOC)
    • 1 py files (536 LOC)
    • 1 css files (406 LOC)
    • 3 exs files (138 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

exs12717 LOC (99%) 28 files
yaml19 LOC (<1%) 1 file
sh8 LOC (<1%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*/[Tt]est/.*".
    • files with paths like ".*_test[.].*".
    • files with paths like ".*/test_.*".
    • files with paths like ".*[-]test[-].*".
  • 30 files match defined criteria (12,744 LOC, 106.8% vs. main code):
    • 28 exs files (12,717 LOC)
    • 1 yaml files (19 LOC)
    • 1 sh files (8 LOC)
Build and Deployment Code
Source code used to configure or support build and deployment process.
gitattributes
Explore:   circles  |  sunburst

yaml213 LOC (79%) 4 files
gitignore42 LOC (15%) 1 file
sh11 LOC (4%) 1 file
gitattributes1 LOC (<1%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*[.]sh".
    • files with paths like ".*/docker[-]compose[.]yml".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/[.]gitattributes".
    • files with paths like ".*/[.]github/workflows/.*[.]ya?ml".
  • 7 files match defined criteria (267 LOC, 2.2% vs. main code):
    • 4 yaml files (213 LOC)
    • 1 gitignore files (42 LOC)
    • 1 sh files (11 LOC)
    • 1 gitattributes files (1 LOC)
Other Code
Explore:   circles  |  sunburst

md3487 LOC (97%) 19 files
txt95 LOC (2%) 5 files

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*[.]md".
    • files with paths like ".*[.]txt".
    • files with paths like ".*/README[.][a-z0-9]+".
  • 24 files match defined criteria (3,582 LOC, 30.0% vs. main code):
    • 19 md files (3,487 LOC)
    • 5 txt files (95 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...
  • *.ex 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
  • *.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
  • *.css files are analyzed with CssAnalyzer:
    • 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
  • *.exs 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
  • *.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