elastic / crd-ref-docs
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
tpl
mod
txt
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.

main1717 LOC (54%) 19 files
test891 LOC (28%) 18 files
generated0 LOC (0%) 0 files
build and deployment0 LOC (0%) 0 files
other519 LOC (16%) 8 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
tpl
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 19 files match defined criteria (1,717 LOC, 100.0% vs. main code):
    • 10 *.go files (1,556 LOC)
    • 8 *.tpl files (145 LOC)
    • 1 *.yaml files (16 LOC)
  • " *.go" is biggest, containing 90.62% of LOC.
  • " *.yaml" is smallest, containing 0.93% of LOC.


*.go1556 LOC (90%) 10 files
*.tpl145 LOC (8%) 8 files
*.yaml16 LOC (<1%) 1 file
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
tpl
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/test[.].*".
    • files with paths like ".*_test[.].*".
    • files with paths like ".*/[Tt]est/.*".
  • 18 files match defined criteria (891 LOC, 51.9% vs. main code):
    • 11 *.go files (514 LOC)
    • 1 *.asciidoc files (206 LOC)
    • 4 *.tpl files (76 LOC)
    • 1 *.sh files (76 LOC)
    • 1 *.yaml files (19 LOC)
  • " *.go" is biggest, containing 57.69% of LOC.
  • " *.yaml" is smallest, containing 2.13% of LOC.


*.go514 LOC (57%) 11 files
*.asciidoc206 LOC (23%) 1 file
*.tpl76 LOC (8%) 4 files
*.sh76 LOC (8%) 1 file
*.yaml19 LOC (2%) 1 file
Other Code
mod
txt
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]json".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.]md".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*/go[.]mod".
  • 8 files match defined criteria (519 LOC, 30.2% vs. main code):
    • 4 *.md files (376 LOC)
    • 2 *.mod files (121 LOC)
    • 1 *.txt files (16 LOC)
    • 1 *.json files (6 LOC)
  • " *.md" is biggest, containing 72.45% of LOC.
  • " *.json" is smallest, containing 1.16% of LOC.


*.md376 LOC (72%) 4 files
*.mod121 LOC (23%) 2 files
*.txt16 LOC (3%) 1 file
*.json6 LOC (1%) 1 file
Analyzers
Info about analyzers used for source code examinations.

2025-05-13 19:50