apache / logging-chainsaw
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
properties
gitattributes
editorconfig
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.

main22587 LOC (96%) 210 files
test392 LOC (1%) 10 files
generated0 LOC (0%) 0 files
build and deployment242 LOC (1%) 2 files
other224 LOC (<1%) 5 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 ".*".
  • 210 files match defined criteria (22,587 LOC, 100.0% vs. main code):
    • 182 *.java files (20,698 LOC)
    • 11 *.html files (1,063 LOC)
    • 7 *.sql files (365 LOC)
    • 6 *.xml files (258 LOC)
    • 3 *.css files (176 LOC)
    • 1 *.rdf files (27 LOC)
  • " *.java" is biggest, containing 91.64% of LOC.
  • " *.rdf" is smallest, containing 0.12% of LOC.


*.java20698 LOC (91%) 182 files
*.html1063 LOC (4%) 11 files
*.sql365 LOC (1%) 7 files
*.xml258 LOC (1%) 6 files
*.css176 LOC (<1%) 3 files
*.rdf27 LOC (<1%) 1 file
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/.*".
  • 10 files match defined criteria (392 LOC, 1.7% vs. main code):
    • 7 *.xml files (338 LOC)
    • 3 *.java files (54 LOC)
  • " *.xml" is biggest, containing 86.22% of LOC.
  • " *.java" is smallest, containing 13.78% of LOC.


*.xml338 LOC (86%) 7 files
*.java54 LOC (13%) 3 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".
    • files with paths like ".*/[.]gitattributes".
  • 2 files match defined criteria (242 LOC, 1.1% vs. main code):
    • 1 *.xml files (230 LOC)
    • 1 *.sh files (12 LOC)
  • " *.xml" is biggest, containing 95.04% of LOC.
  • " *.sh" is smallest, containing 4.96% of LOC.


*.xml230 LOC (95%) 1 file
*.sh12 LOC (4%) 1 file
Other Code
properties
txt
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]json".
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.]editorconfig".
    • files with paths like ".*[.]md".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/asciidoc/.*".
    • files with paths like ".*[.]properties".
  • 5 files match defined criteria (224 LOC, 1.0% vs. main code):
    • 2 *.properties files (92 LOC)
    • 1 *.adoc files (69 LOC)
    • 1 *.txt files (60 LOC)
    • 1 *.md files (3 LOC)
  • " *.properties" is biggest, containing 41.07% of LOC.
  • " *.md" is smallest, containing 1.34% of LOC.


*.properties92 LOC (41%) 2 files
*.adoc69 LOC (30%) 1 file
*.txt60 LOC (26%) 1 file
*.md3 LOC (1%) 1 file
Analyzers
Info about analyzers used for source code examinations.

2023-08-10 18:21