apache / aries-jax-rs-whiteboard
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
builder
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.

main9202 LOC (47%) 98 files
test7408 LOC (37%) 75 files
generated0 LOC (0%) 0 files
build and deployment2365 LOC (12%) 23 files
other521 LOC (2%) 8 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 ".*".
  • 98 files match defined criteria (9,202 LOC, 100.0% vs. main code):
    • 91 *.java files (9,060 LOC)
    • 7 *.xml files (142 LOC)
  • " *.java" is biggest, containing 98.46% of LOC.
  • " *.xml" is smallest, containing 1.54% of LOC.


*.java9060 LOC (98%) 91 files
*.xml142 LOC (1%) 7 files
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/[Tt]est/.*".
  • 75 files match defined criteria (7,408 LOC, 80.5% vs. main code):
    • 73 *.java files (7,301 LOC)
    • 2 *.xml files (107 LOC)
  • " *.java" is biggest, containing 98.56% of LOC.
  • " *.xml" is smallest, containing 1.44% of LOC.


*.java7301 LOC (98%) 73 files
*.xml107 LOC (1%) 2 files
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 ".*[.]sh".
    • files with paths like ".*/pom[.]xml".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
  • 23 files match defined criteria (2,365 LOC, 25.7% vs. main code):
    • 22 *.xml files (2,311 LOC)
    • 1 *.sh files (54 LOC)
  • " *.xml" is biggest, containing 97.72% of LOC.
  • " *.sh" is smallest, containing 2.28% of LOC.


*.xml2311 LOC (97%) 22 files
*.sh54 LOC (2%) 1 file
Other Code
txt
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]json".
    • files with paths like ".*[.]md".
    • files with paths like ".*[.]txt".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*/[.]gitignore".
  • 8 files match defined criteria (521 LOC, 5.7% vs. main code):
    • 6 *.md files (519 LOC)
    • 2 *.txt files (2 LOC)
  • " *.md" is biggest, containing 99.62% of LOC.
  • " *.txt" is smallest, containing 0.38% of LOC.


*.md519 LOC (99%) 6 files
*.txt2 LOC (<1%) 2 files
Analyzers
Info about analyzers used for source code examinations.

2023-08-10 17:30