Source Code Analysis Scope
Files includes and excluded from analyses
properties

scoping details...
  • 13 extensions are included in analyses: java, json, md, gradle, yaml, sql, txt, yml, xml, sh, properties, gitignore, bat
  • 8 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/docs/.*" (Documentation) (8 files).
    • exclude files with path like ".*/gradle/wrapper/.*" (Gradle) (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.
main57787 LOC (48%) 618 files
test43894 LOC (37%) 322 files
generated0 LOC (0%) 0 files
build and deployment678 LOC (<1%) 25 files
other15878 LOC (13%) 266 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

java56842 LOC (98%) 596 files
yaml685 LOC (1%) 11 files
sql226 LOC (<1%) 10 files
xml34 LOC (<1%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 618 files match defined criteria (57,787 LOC, 100.0% vs. main code):
    • 596 java files (56,842 LOC)
    • 11 yaml files (685 LOC)
    • 10 sql files (226 LOC)
    • 1 xml files (34 LOC)
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
Explore:   circles  |  sunburst

java43759 LOC (99%) 319 files
yaml135 LOC (<1%) 3 files

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*/[Tt]est/.*".
    • files with paths like ".*[-]test[-].*".
  • 322 files match defined criteria (43,894 LOC, 76.0% vs. main code):
    • 319 java files (43,759 LOC)
    • 3 yaml files (135 LOC)
Build and Deployment Code
Source code used to configure or support build and deployment process.
Explore:   circles  |  sunburst

gradle340 LOC (50%) 17 files
xml132 LOC (19%) 2 files
bat71 LOC (10%) 1 file
gitignore53 LOC (7%) 1 file
sh41 LOC (6%) 2 files
yaml41 LOC (6%) 2 files

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*[.]gradle".
    • files with paths like ".*/docker[-]compose[.]yml".
    • files with paths like ".*[.]sh".
    • files with paths like ".*/config/checkstyle/.*".
    • files with paths like ".*/checkstyle.*".
    • files with paths like ".*/checkstyle[.]xml".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/[.]github/workflows/.*[.]ya?ml".
    • files with paths like ".*[.]bat".
  • 25 files match defined criteria (678 LOC, 1.2% vs. main code):
    • 17 gradle files (340 LOC)
    • 2 xml files (132 LOC)
    • 1 bat files (71 LOC)
    • 1 gitignore files (53 LOC)
    • 2 sh files (41 LOC)
    • 2 yaml files (41 LOC)
Other Code
properties
Explore:   circles  |  sunburst

json15495 LOC (97%) 247 files
md267 LOC (1%) 15 files
yaml109 LOC (<1%) 2 files
txt6 LOC (<1%) 1 file
properties1 LOC (<1%) 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 ".*[.]json".
    • files with paths like ".*[.]properties".
    • files with paths like ".*/[Ss]amples/.*".
    • files with paths like ".*[.]txt".
  • 266 files match defined criteria (15,878 LOC, 27.5% vs. main code):
    • 247 json files (15,495 LOC)
    • 15 md files (267 LOC)
    • 2 yaml files (109 LOC)
    • 1 txt files (6 LOC)
    • 1 properties files (1 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...
  • *.java files are analyzed with JavaAnalyzer:
    • 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 (based on package names)
  • *.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
  • *.sql files are analyzed with SqlAnalyzer:
    • 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
  • *.xml files are analyzed with XmlAnalyzer:
    • 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