elastic / elasticsearch-specification

Analysis scope, overview of main, test, generated, deployment, build, and other code.

Source Code Analysis Scope

Files includes and excluded from analyses

txt

gitattributes

prettierignore

13 extensions are included in analyses: ts, yaml, json, md, rs, toml, js, gitignore, sh, txt, py, gitattributes, prettierignore
4 criteria are used to exclude files from analysis:

exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (22 files).
exclude files with path like ".*/docs/.*" (Documentation) (14 files).
exclude files with path like ".*\.d\.ts" (Typescript definition files) (2 files).
exclude files with path like ".*/bin/.*" (Binaries for distribution) (3 files).

The source code folder contains 2,821 files:

2,742 files are included in analyses.
79 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.

1,464 files

37 files

4 files

1,241 files

Main Code

All manually created or maintained source code that defines logic of the product that is run in a production environment.

Explore: circles | sunburst

The following criteria are used to filter files:

files with paths like ".*".

1464 files match defined criteria (41,347 LOC, 100.0% vs. main code):

1,435 *.ts files (37,360 LOC)
17 *.rs files (3,259 LOC)
3 *.js files (377 LOC)
1 *.py files (138 LOC)
6 *.toml files (129 LOC)
2 *.yaml files (84 LOC)

" *.ts" is biggest, containing 90.36% of LOC.
" *.yaml" is smallest, containing 0.2% 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 ".*[.][Tt]est[.].*".
files with paths like ".*[.]test[.].*".
files with paths like ".*/test_.*".
files with paths like ".*/[Tt]ests/.*".

37 files match defined criteria (512 LOC, 1.2% vs. main code). All matches are in *.ts 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 ".*/package[-]lock[.]json".

4 files match defined criteria (24,867 LOC, 60.1% vs. main code). All matches are in *.json files.

Other Code

Explore: circles | sunburst

The following criteria are used to filter files:

files with paths like ".*[.]json".
files with paths like ".*[.]md".
files with paths like ".*/README[.][a-z0-9]+".
files with paths like ".*[.]txt".
files with paths like ".*/[.]gitignore".
files with paths like ".*/[.]prettierignore".
files with paths like ".*/[Ee]xamples/.*".

1241 files match defined criteria (60,902 LOC, 147.3% vs. main code):

600 *.json files (49,970 LOC)
633 *.yaml files (10,194 LOC)
8 *.md files (738 LOC)

" *.json" is biggest, containing 82.05% of LOC.
" *.md" is smallest, containing 1.21% of LOC.

Analyzers

Info about analyzers used for source code examinations.

*.ts files are analyzed with TypeScriptAnalyzer:

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

*.rs files are analyzed with RustAnalyzer:

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

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

*.py files are analyzed with PythonAnalyzer:

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

Basic heuristic dependency analysis

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

*.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-13 19:41