Source Code Analysis Scope
Files includes and excluded from analyses
npmrc
mjs
gitattributes

scoping details...
  • 14 extensions are included in analyses: md, json, py, ts, sh, js, yml, txt, html, npmrc, mjs, gitignore, tsx, gitattributes
  • 7 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/[Vv]endors?/.*" (Dependencies) (1 file).
    • 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.
main28766 LOC (36%) 106 files
test7635 LOC (9%) 22 files
generated0 LOC (0%) 0 files
build and deployment2146 LOC (2%) 30 files
other39836 LOC (50%) 308 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
mjs
Explore:   circles  |  sunburst

py14358 LOC (49%) 60 files
ts7406 LOC (25%) 31 files
html2620 LOC (9%) 5 files
mjs2339 LOC (8%) 3 files
js1208 LOC (4%) 5 files
tsx835 LOC (2%) 2 files

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 106 files match defined criteria (28,766 LOC, 100.0% vs. main code):
    • 60 py files (14,358 LOC)
    • 31 ts files (7,406 LOC)
    • 5 html files (2,620 LOC)
    • 3 mjs files (2,339 LOC)
    • 5 js files (1,208 LOC)
    • 2 tsx files (835 LOC)
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
Explore:   circles  |  sunburst

py5130 LOC (67%) 12 files
ts2505 LOC (32%) 10 files

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*[-]test[-].*".
    • 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 ".*[-]tests[-].*".
    • files with paths like ".*/[Ss]pecs/.*".
  • 22 files match defined criteria (7,635 LOC, 26.5% vs. main code):
    • 12 py files (5,130 LOC)
    • 10 ts files (2,505 LOC)
Build and Deployment Code
Source code used to configure or support build and deployment process.
npmrc
gitattributes
Explore:   circles  |  sunburst

sh1209 LOC (56%) 14 files
yaml903 LOC (42%) 9 files
gitignore27 LOC (1%) 2 files
npmrc4 LOC (<1%) 4 files
gitattributes3 LOC (<1%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*[.]sh".
    • 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".
    • files with paths like ".*[.]npmrc".
    • files with paths like "(.*/)?[.]npmrc".
    • files with paths like ".*/package[.]json".
  • 30 files match defined criteria (2,146 LOC, 7.5% vs. main code):
    • 14 sh files (1,209 LOC)
    • 9 yaml files (903 LOC)
    • 2 gitignore files (27 LOC)
    • 4 npmrc files (4 LOC)
    • 1 gitattributes files (3 LOC)
Other Code
Explore:   circles  |  sunburst

md32400 LOC (81%) 228 files
json7001 LOC (17%) 74 files
txt319 LOC (<1%) 2 files
sh116 LOC (<1%) 4 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 ".*[.]txt".
    • files with paths like ".*/LICENSE[.][a-z0-9]+".
    • files with paths like ".*/vendor/.*".
  • 308 files match defined criteria (39,836 LOC, 138.5% vs. main code):
    • 228 md files (32,400 LOC)
    • 74 json files (7,001 LOC)
    • 2 txt files (319 LOC)
    • 4 sh files (116 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
  • *.ts files are analyzed with TypeScriptAnalyzer:
    • 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
  • *.html files are analyzed with HtmlAnalyzer:
    • 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
    • Advanced heuristic dependency analysis
  • *.mjs 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
  • *.js 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
  • *.tsx files are analyzed with TypeScriptAnalyzer:
    • 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