apache / incubator-kie-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
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.

main32 LOC (<1%) 2 files
test0 LOC (0%) 0 files
generated27826 LOC (11%) 145 files
build and deployment417 LOC (<1%) 5 files
other219995 LOC (88%) 720 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
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 2 files match defined criteria (32 LOC, 100.0% vs. main code). All matches are in *.xml files.


*.xml32 LOC (100%) 2 files
Generated Code
Automatically generated files, not manually changed after generation.
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with any line of content like "\<\!\-\-[ ]*Generated by .*".
    • files with paths like ".*[.](html|html|xhtml)" AND any line of content like "[ ]*[<]meta name[=]"generator" .*".
  • 145 files match defined criteria (27,826 LOC, 86956.2% vs. main code):
    • 144 *.svg files (27,352 LOC)
    • 1 *.html files (474 LOC)
  • " *.svg" is biggest, containing 98.3% of LOC.
  • " *.html" is smallest, containing 1.7% of LOC.


*.svg27352 LOC (98%) 144 files
*.html474 LOC (1%) 1 file
Build and Deployment Code
Source code used to configure or support build and deployment process.
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/pom[.]xml".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
  • 5 files match defined criteria (417 LOC, 1303.1% vs. main code). All matches are in *.xml files.


*.xml417 LOC (100%) 5 files
Other Code
txt
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]adoc".
    • files with paths like ".*[.]md".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*[.]txt".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/asciidoc/.*".
    • files with paths like ".*[.]svg".
  • 720 files match defined criteria (219,995 LOC, 687484.4% vs. main code):
    • 564 *.svg files (157,688 LOC)
    • 142 *.adoc files (47,090 LOC)
    • 4 *.js files (12,732 LOC)
    • 4 *.css files (2,202 LOC)
    • 1 *.txt files (169 LOC)
    • 1 *.md files (104 LOC)
    • 4 *.html files (10 LOC)
  • " *.svg" is biggest, containing 71.68% of LOC.
  • " *.html" is smallest, containing 0% of LOC.


*.svg157688 LOC (71%) 564 files
*.adoc47090 LOC (21%) 142 files
*.js12732 LOC (5%) 4 files
*.css2202 LOC (1%) 4 files
*.txt169 LOC (<1%) 1 file
*.md104 LOC (<1%) 1 file
*.html10 LOC (<1%) 4 files
Analyzers
Info about analyzers used for source code examinations.

2025-05-07 15:53