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

14 extensions are included in analyses: html, xml, css, js, svg, xsd, json, yaml, webmanifest, sh, txt, gitignore, py, lua
9 criteria are used to exclude files from analysis:

exclude files with path like "(?i).*/jquery.*[.]js" (jQuery files) (76 files).
exclude files with path like ".*jquery[.].*[.]js" (jQuery library) (0 files).
exclude files with path like ".*/normalize[.](css|less|scss|styl)" (Normalize css) (2 files).
exclude files with path like ".*[.]min[.]js" (Minimized JS library) (0 files).
exclude files with path like ".*/bin/.*" (Binaries for distribution) (4 files).
exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (7 files).
exclude files with path like ".*/cache/.*" (Caches) (72 files).
exclude files with path like ".*/[Vv]endors?/.*" (Dependencies) (21 files).
exclude files with path like ".*/extern(al)?/.*" (Dependencies) (149 files).

The source code folder contains 75,173 files:

31,897 files are included in analyses.
43,276 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.

xsd

webmanifest

Explore: circles | sunburst

The following criteria are used to filter files:

files with paths like ".*".

23166 files match defined criteria (2,121,658 LOC, 100.0% vs. main code):

13,322 *.html files (1,104,006 LOC)
7,971 *.xml files (568,731 LOC)
1,479 *.css files (389,242 LOC)
301 *.js files (55,201 LOC)
89 *.xsd files (4,412 LOC)
3 *.webmanifest files (42 LOC)
1 *.yaml files (24 LOC)

" *.html" is biggest, containing 52.04% of LOC.
" *.yaml" is smallest, containing 0% 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/.*".

2833 files match defined criteria (171,578 LOC, 8.1% vs. main code):

2,501 *.html files (161,767 LOC)
308 *.xml files (6,073 LOC)
24 *.css files (3,738 LOC)

" *.html" is biggest, containing 94.28% of LOC.
" *.css" is smallest, containing 2.18% of LOC.

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

5313 files match defined criteria (6,023,702 LOC, 283.9% vs. main code). All matches are in *.html files.

Other Code

txt

Explore: circles | sunburst

The following criteria are used to filter files:

files with paths like ".*[.]svg".
files with paths like ".*[.]json".
files with paths like ".*/[.]gitignore".
files with paths like ".*[.]txt".
files with paths like ".*/LICENSE[.][a-z0-9]+".
files with paths like ".*/vendor/.*".
files with paths like ".*/checkstyle.*".

654 files match defined criteria (266,818 LOC, 12.6% vs. main code):

578 *.svg files (258,337 LOC)
69 *.html files (8,397 LOC)
1 *.txt files (78 LOC)
6 *.json files (6 LOC)

" *.svg" is biggest, containing 96.82% of LOC.
" *.json" is smallest, containing 0% of LOC.

Analyzers

Info about analyzers used for source code examinations.

*.html files are analyzed with HtmlAnalyzer:

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

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

*.css files are analyzed with CssAnalyzer:

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

*.js files are analyzed with JavaScriptAnalyzer:

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

No dependency analysis

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

*.webmanifest files are analyzed with JsonAnalyzer:

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

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

2025-05-07 18:52