apache / incubator-kie-kogito-docs
Source Code Overview

Analysis scope, overview of main, test, generated, deployment, build, and other code.

Source Code Analysis Scope
Files includes and excluded from analyses
hbs
txt
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.

  • 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.

main349 LOC (1%) 13 files
test0 LOC (0%) 0 files
generated2347 LOC (8%) 1 file
build and deployment0 LOC (0%) 0 files
other23578 LOC (89%) 140 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
hbs
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 13 files match defined criteria (349 LOC, 100.0% vs. main code):
    • 6 *.css files (177 LOC)
    • 2 *.js files (91 LOC)
    • 4 *.hbs files (51 LOC)
    • 1 *.py files (30 LOC)
  • " *.css" is biggest, containing 50.72% of LOC.
  • " *.py" is smallest, containing 8.6% of LOC.


*.css177 LOC (50%) 6 files
*.js91 LOC (26%) 2 files
*.hbs51 LOC (14%) 4 files
*.py30 LOC (8%) 1 file
Generated Code
Automatically generated files, not manually changed after generation.
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/package[-]lock[.]json".
  • 1 file matches defined criteria (2,347 LOC, 672.5% vs. main code). All matches are in *.json files.


*.json2347 LOC (100%) 1 file
Other Code
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]json".
    • files with paths like ".*[.]svg".
    • files with paths like ".*[.]md".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.]adoc".
    • files with paths like ".*/README[.][a-z0-9]+".
  • 140 files match defined criteria (23,578 LOC, 6755.9% vs. main code):
    • 130 *.adoc files (19,186 LOC)
    • 3 *.json files (2,385 LOC)
    • 6 *.svg files (1,841 LOC)
    • 1 *.md files (166 LOC)
  • " *.adoc" is biggest, containing 81.37% of LOC.
  • " *.md" is smallest, containing 0.7% of LOC.


*.adoc19186 LOC (81%) 130 files
*.json2385 LOC (10%) 3 files
*.svg1841 LOC (7%) 6 files
*.md166 LOC (<1%) 1 file
Analyzers
Info about analyzers used for source code examinations.

2025-05-07 20:38