apache / aries-antora-site
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
xsd
txt
htaccess
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.

main10531 LOC (10%) 58 files
test0 LOC (0%) 0 files
generated66952 LOC (67%) 443 files
build and deployment0 LOC (0%) 0 files
other21392 LOC (21%) 167 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
xsd
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 58 files match defined criteria (10,531 LOC, 100.0% vs. main code):
    • 12 *.css files (6,043 LOC)
    • 29 *.js files (3,415 LOC)
    • 17 *.xsd files (1,073 LOC)
  • " *.css" is biggest, containing 57.38% of LOC.
  • " *.xsd" is smallest, containing 10.19% of LOC.


*.css6043 LOC (57%) 12 files
*.js3415 LOC (32%) 29 files
*.xsd1073 LOC (10%) 17 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" .*".
  • 443 files match defined criteria (66,952 LOC, 635.8% vs. main code). All matches are in *.html files.


*.html66952 LOC (100%) 443 files
Other Code
txt
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]md".
    • files with paths like ".*[.]svg".
    • files with paths like ".*[.]adoc".
    • files with paths like ".*/[Ss]amples/.*".
    • files with paths like ".*/[Dd]ocumentation/.*".
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.]json".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/[.]htaccess".
  • 167 files match defined criteria (21,392 LOC, 203.1% vs. main code):
    • 147 *.adoc files (20,089 LOC)
    • 3 *.txt files (721 LOC)
    • 8 *.md files (360 LOC)
    • 8 *.svg files (208 LOC)
    • 1 *.json files (14 LOC)
  • " *.adoc" is biggest, containing 93.91% of LOC.
  • " *.json" is smallest, containing 0.07% of LOC.


*.adoc20089 LOC (93%) 147 files
*.txt721 LOC (3%) 3 files
*.md360 LOC (1%) 8 files
*.svg208 LOC (<1%) 8 files
*.json14 LOC (<1%) 1 file
Analyzers
Info about analyzers used for source code examinations.

2025-05-07 20:16