apache / maven-checkstyle-plugin
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
properties
txt
cgi
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.

main488 LOC (4%) 71 files
test683 LOC (6%) 29 files
generated16 LOC (<1%) 4 files
build and deployment2858 LOC (27%) 68 files
other6247 LOC (60%) 131 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
cgi
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 71 files match defined criteria (488 LOC, 100.0% vs. main code):
    • 29 *.java files (151 LOC)
    • 3 *.xml files (148 LOC)
    • 34 *.groovy files (126 LOC)
    • 1 *.cgi files (22 LOC)
    • 3 *.html files (21 LOC)
    • 1 *.g4 files (20 LOC)
  • " *.java" is biggest, containing 30.94% of LOC.
  • " *.g4" is smallest, containing 4.1% of LOC.


*.java151 LOC (30%) 29 files
*.xml148 LOC (30%) 3 files
*.groovy126 LOC (25%) 34 files
*.cgi22 LOC (4%) 1 file
*.html21 LOC (4%) 3 files
*.g420 LOC (4%) 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/.*".
    • files with paths like ".*[-]test[-].*".
    • files with paths like ".*[-]tests[-].*".
  • 29 files match defined criteria (683 LOC, 140.0% vs. main code):
    • 16 *.xml files (582 LOC)
    • 11 *.java files (94 LOC)
    • 2 *.groovy files (7 LOC)
  • " *.xml" is biggest, containing 85.21% of LOC.
  • " *.groovy" is smallest, containing 1.02% of LOC.


*.xml582 LOC (85%) 16 files
*.java94 LOC (13%) 11 files
*.groovy7 LOC (1%) 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 paths like ".*/generated/.*".
  • 4 files match defined criteria (16 LOC, 3.3% vs. main code). All matches are in *.java files.


*.java16 LOC (100%) 4 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 ".*/pom[.]xml".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
  • 68 files match defined criteria (2,858 LOC, 585.7% vs. main code). All matches are in *.xml files.


*.xml2858 LOC (100%) 68 files
Other Code
properties
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 ".*/README[.][a-z0-9]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]txt".
    • files with paths like ".*/checkstyle.*".
    • files with paths like ".*/LICENSE[.][a-z0-9]+".
    • files with paths like ".*[.]properties".
    • files with paths like ".*/checkstyle[.]xml".
  • 131 files match defined criteria (6,247 LOC, 1280.1% vs. main code):
    • 43 *.java files (3,716 LOC)
    • 55 *.properties files (1,100 LOC)
    • 12 *.txt files (882 LOC)
    • 16 *.xml files (435 LOC)
    • 1 *.md files (85 LOC)
    • 2 *.groovy files (15 LOC)
    • 2 *.html files (14 LOC)
  • " *.java" is biggest, containing 59.48% of LOC.
  • " *.html" is smallest, containing 0.22% of LOC.


*.java3716 LOC (59%) 43 files
*.properties1100 LOC (17%) 55 files
*.txt882 LOC (14%) 12 files
*.xml435 LOC (6%) 16 files
*.md85 LOC (1%) 1 file
*.groovy15 LOC (<1%) 2 files
*.html14 LOC (<1%) 2 files
Analyzers
Info about analyzers used for source code examinations.

2023-08-10 21:06