apache / shardingsphere - 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

proto

gitattributes

cmd

22 extensions are included in analyses: java, xml, yaml, md, g4, sql, html, ftl, json, css, toml, js, svg, txt, properties, sh, scss, proto, gitattributes, bat, cmd, gitignore
9 criteria are used to exclude files from analysis:

exclude files with path like ".*/cache/.*" (Caches) (32 files).
exclude files with path like ".*/bin/.*" (Binaries for distribution) (6 files).
exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (15 files).
exclude files with path like ".*/extern(al)?/.*" (Dependencies) (42 files).
exclude files with path like ".*/mvnw\.cmd" (Maven) (1 file).
exclude files with path like ".*/docs/.*" (Documentation) (1117 files).
exclude files with path like "(?i).*/jquery.*[.]js" (jQuery files) (0 files).
exclude files with path like ".*jquery[.].*[.]js" (jQuery library) (0 files).
exclude files with path like ".*/[Vv]endors?/.*" (Dependencies) (3 files).

The source code folder contains 15,584 files:

12,967 files are included in analyses.
2,617 files are excluded from analyses:

Explore all files....

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.

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 ".*".

6200 files match defined criteria (305,680 LOC, 100.0% vs. main code):

5,050 *.java files (167,671 LOC)
823 *.yaml files (74,994 LOC)
264 *.g4 files (59,387 LOC)
46 *.ftl files (2,160 LOC)
15 *.xml files (1,313 LOC)
2 *.proto files (155 LOC)

" *.java" is biggest, containing 54.85% of LOC.
" *.proto" is smallest, containing 0.05% of LOC.

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 ".*/e2e/.*".

6252 files match defined criteria (292,476 LOC, 95.7% vs. main code):

3,091 *.java files (140,863 LOC)
2,589 *.xml files (110,964 LOC)
342 *.yaml files (26,275 LOC)
229 *.sql files (14,340 LOC)
1 *.sh files (34 LOC)

" *.java" is biggest, containing 48.16% of LOC.
" *.sh" is smallest, containing 0.01% of LOC.

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 ".*[.]bat".
files with paths like ".*[.]git[a-z]+".
files with paths like ".*/[.]gitignore".
files with paths like ".*/[.]gitattributes".

321 files match defined criteria (12,300 LOC, 4.0% vs. main code). All matches are in *.xml 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 ".*/[Ee]xamples/.*".
files with paths like ".*[.]md".
files with paths like ".*/README[.][a-z0-9]+".
files with paths like ".*[.]txt".
files with paths like ".*/checkstyle[.]xml".
files with paths like ".*/checkstyle.*".
files with paths like ".*[.]json".
files with paths like ".*/[.]gitignore".
files with paths like ".*[.]svg".
files with paths like ".*/LICENSE[.][a-z0-9]+".
files with paths like ".*/vendor/.*".

194 files match defined criteria (18,702 LOC, 6.1% vs. main code):

53 *.json files (9,308 LOC)
53 *.ftl files (2,867 LOC)
9 *.md files (2,374 LOC)
22 *.txt files (1,733 LOC)
34 *.java files (1,110 LOC)
5 *.xml files (861 LOC)
17 *.properties files (423 LOC)
1 *.yaml files (26 LOC)

" *.json" is biggest, containing 49.77% of LOC.
" *.yaml" is smallest, containing 0.14% of LOC.

Analyzers

Info about analyzers used for source code examinations.

*.java files are analyzed with JavaAnalyzer:

All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)

Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)

Unit size analysis

Conditional complexity analysis

Advanced heuristic dependency analysis (based on package names)

*.yaml files are analyzed with YamlAnalyzer:

All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)

Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)

No unit size analysis

No conditional complexity analysis

No dependency analysis

*.g4 files are analyzed with DefaultLanguageAnalyzer:

All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)

Basic code cleaning (empty lines removed for LOC calculations and duplication calculations)

No unit size analysis

No conditional complexity analysis

No dependency analysis

*.ftl files are analyzed with DefaultLanguageAnalyzer:

All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)

Basic code cleaning (empty lines removed for LOC calculations and duplication calculations)

No unit size analysis

No conditional complexity analysis

No dependency analysis

*.xml files are analyzed with XmlAnalyzer:

All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)

Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)

No unit size analysis

No conditional complexity analysis

No dependency analysis

*.proto files are analyzed with DefaultLanguageAnalyzer:

All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)

Basic code cleaning (empty lines removed for LOC calculations and duplication calculations)

No unit size analysis

No conditional complexity analysis

No dependency analysis

2025-05-07 17:00