elastic / elastic-package - 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

hbs

txt

mod

12 extensions are included in analyses: yaml, json, go, md, hbs, svg, sh, txt, tf, ps1, gitignore, mod
3 criteria are used to exclude files from analysis:

exclude files with path like ".*/testdata/.*" (Test data) (74 files).
exclude files with path like ".*/docs/.*" (Documentation) (130 files).
exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (15 files).

The source code folder contains 2,225 files:

1,006 files are included in analyses.
1,219 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.

Explore: circles | sunburst

The following criteria are used to filter files:

files with paths like ".*".

267 files match defined criteria (34,265 LOC, 100.0% vs. main code):

263 *.go files (33,530 LOC)
4 *.yaml files (735 LOC)

" *.go" is biggest, containing 97.85% of LOC.
" *.yaml" is smallest, containing 2.15% of LOC.

Test Code

Used only for testing of the product. Normally not deployed in a production environment.

hbs

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 ".*/test_.*".
files with paths like ".*[-]test[-].*".
files with paths like ".*_tests[.].*".
files with paths like ".*[.][Tt]ests[.].*".
files with paths like ".*[.]tests[.].*".

168 files match defined criteria (12,158 LOC, 35.5% vs. main code):

68 *.go files (9,107 LOC)
78 *.hbs files (2,309 LOC)
15 *.yaml files (407 LOC)
3 *.sh files (269 LOC)
4 *.tf files (66 LOC)

" *.go" is biggest, containing 74.91% of LOC.
" *.tf" is smallest, containing 0.54% 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 ".*[.]sh".
files with paths like ".*[.]git[a-z]+".
files with paths like ".*/[.]gitignore".

11 files match defined criteria (518 LOC, 1.5% vs. main code). All matches are in *.sh files.

Other Code

txt

mod

Explore: circles | sunburst

The following criteria are used to filter files:

files with paths like ".*[.]json".
files with paths like ".*[.]txt".
files with paths like ".*[.]md".
files with paths like ".*/README[.][a-z0-9]+".
files with paths like ".*/LICENSE[.][a-z0-9]+".
files with paths like ".*/[.]gitignore".
files with paths like ".*/go[.]mod".
files with paths like ".*[.]svg".

560 files match defined criteria (173,154 LOC, 505.3% vs. main code):

525 *.json files (160,860 LOC)
11 *.svg files (10,139 LOC)
19 *.txt files (1,464 LOC)
4 *.md files (511 LOC)
1 *.mod files (180 LOC)

" *.json" is biggest, containing 92.9% of LOC.
" *.mod" is smallest, containing 0.1% of LOC.

Analyzers

Info about analyzers used for source code examinations.

*.go files are analyzed with GoLangAnalyzer:

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

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