apache / shardingsphere-doc
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
webmanifest
txt
lua
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.

main906816 LOC (16%) 9,101 files
test6040 LOC (<1%) 308 files
generated4222433 LOC (78%) 2,810 files
build and deployment0 LOC (0%) 0 files
other258409 LOC (4%) 577 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
xsd
webmanifest
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 9101 files match defined criteria (906,816 LOC, 100.0% vs. main code):
    • 7,309 *.xml files (521,660 LOC)
    • 877 *.css files (283,692 LOC)
    • 289 *.js files (52,361 LOC)
    • 533 *.html files (44,625 LOC)
    • 89 *.xsd files (4,412 LOC)
    • 3 *.webmanifest files (42 LOC)
    • 1 *.yaml files (24 LOC)
  • " *.xml" is biggest, containing 57.53% of LOC.
  • " *.yaml" is smallest, containing 0% of LOC.


*.xml521660 LOC (57%) 7,309 files
*.css283692 LOC (31%) 877 files
*.js52361 LOC (5%) 289 files
*.html44625 LOC (4%) 533 files
*.xsd4412 LOC (<1%) 89 files
*.webmanifest42 LOC (<1%) 3 files
*.yaml24 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/.*".
    • files with paths like ".*[-]test[-].*".
  • 308 files match defined criteria (6,040 LOC, 0.7% vs. main code). All matches are in *.xml files.


*.xml6040 LOC (100%) 308 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 ".*[.](html|html|xhtml)" AND any line of content like "[ ]*[<]meta name[=]"generator" .*".
  • 2810 files match defined criteria (4,222,433 LOC, 465.6% vs. main code). All matches are in *.html files.


*.html4222433 LOC (100%) 2,810 files
Other Code
txt
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]json".
    • files with paths like ".*[.]svg".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]txt".
    • files with paths like ".*/LICENSE[.][a-z0-9]+".
  • 577 files match defined criteria (258,409 LOC, 28.5% vs. main code):
    • 570 *.svg files (258,325 LOC)
    • 1 *.txt files (78 LOC)
    • 6 *.json files (6 LOC)
  • " *.svg" is biggest, containing 99.97% of LOC.
  • " *.json" is smallest, containing 0% of LOC.


*.svg258325 LOC (99%) 570 files
*.txt78 LOC (<1%) 1 file
*.json6 LOC (<1%) 6 files
Analyzers
Info about analyzers used for source code examinations.

2023-08-10 20:50