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

main118935 LOC (85%) 676 files
test177 LOC (<1%) 5 files
generated0 LOC (0%) 0 files
build and deployment2524 LOC (1%) 38 files
other17514 LOC (12%) 127 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
proto
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 676 files match defined criteria (118,935 LOC, 100.0% vs. main code):
    • 658 *.java files (117,959 LOC)
    • 7 *.xml files (494 LOC)
    • 8 *.yaml files (353 LOC)
    • 1 *.proto files (76 LOC)
    • 2 *.groovy files (53 LOC)
  • " *.java" is biggest, containing 99.18% of LOC.
  • " *.groovy" is smallest, containing 0.04% of LOC.


*.java117959 LOC (99%) 658 files
*.xml494 LOC (<1%) 7 files
*.yaml353 LOC (<1%) 8 files
*.proto76 LOC (<1%) 1 file
*.groovy53 LOC (<1%) 2 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 ".*[-]test[-].*".
    • files with paths like ".*/[Tt]est/.*".
    • files with paths like ".*/[Tt]ests/.*".
  • 5 files match defined criteria (177 LOC, 0.1% vs. main code):
    • 4 *.java files (143 LOC)
    • 1 *.sh files (34 LOC)
  • " *.java" is biggest, containing 80.79% of LOC.
  • " *.sh" is smallest, containing 19.21% of LOC.


*.java143 LOC (80%) 4 files
*.sh34 LOC (19%) 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 ".*[.]sh".
    • files with paths like ".*/assembly[.]xml".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/[.]gitattributes".
  • 38 files match defined criteria (2,524 LOC, 2.1% vs. main code):
    • 14 *.xml files (1,976 LOC)
    • 24 *.sh files (548 LOC)
  • " *.xml" is biggest, containing 78.29% of LOC.
  • " *.sh" is smallest, containing 21.71% of LOC.


*.xml1976 LOC (78%) 14 files
*.sh548 LOC (21%) 24 files
Other Code
txt
properties
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]properties".
    • files with paths like ".*[.]txt".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*[.]json".
    • files with paths like ".*/checkstyle[.]xml".
    • files with paths like ".*/checkstyle.*".
    • files with paths like ".*[.]editorconfig".
    • files with paths like ".*[.]md".
    • files with paths like ".*/[.]gitignore".
  • 127 files match defined criteria (17,514 LOC, 14.7% vs. main code):
    • 111 *.txt files (16,674 LOC)
    • 12 *.properties files (430 LOC)
    • 3 *.md files (208 LOC)
    • 1 *.xml files (202 LOC)
  • " *.txt" is biggest, containing 95.2% of LOC.
  • " *.xml" is smallest, containing 1.15% of LOC.


*.txt16674 LOC (95%) 111 files
*.properties430 LOC (2%) 12 files
*.md208 LOC (1%) 3 files
*.xml202 LOC (1%) 1 file
Analyzers
Info about analyzers used for source code examinations.

2023-08-10 21:18