gitlab-org / omnibus
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
feature
txt
rdoc
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.

main20648 LOC (86%) 188 files
test232 LOC (<1%) 7 files
generated0 LOC (0%) 0 files
build and deployment665 LOC (2%) 2 files
other2243 LOC (9%) 12 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
rdoc
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 188 files match defined criteria (20,648 LOC, 100.0% vs. main code):
    • 154 *.rb files (19,893 LOC)
    • 32 *.erb files (695 LOC)
    • 1 *.gemspec files (41 LOC)
    • 1 *.rdoc files (19 LOC)
  • " *.rb" is biggest, containing 96.34% of LOC.
  • " *.rdoc" is smallest, containing 0.09% of LOC.


*.rb19893 LOC (96%) 154 files
*.erb695 LOC (3%) 32 files
*.gemspec41 LOC (<1%) 1 file
*.rdoc19 LOC (<1%) 1 file
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
feature
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*_tests[.].*".
    • files with paths like ".*[.]feature".
  • 7 files match defined criteria (232 LOC, 1.1% vs. main code). All matches are in *.feature files.


*.feature232 LOC (100%) 7 files
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".
  • 2 files match defined criteria (665 LOC, 3.2% vs. main code). All matches are in *.sh files.


*.sh665 LOC (100%) 2 files
Other Code
txt
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]md".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*[.]json".
    • files with paths like ".*[.]txt".
    • files with paths like ".*/[.]gitignore".
  • 12 files match defined criteria (2,243 LOC, 10.9% vs. main code):
    • 8 *.md files (1,617 LOC)
    • 2 *.txt files (570 LOC)
    • 2 *.json files (56 LOC)
  • " *.md" is biggest, containing 72.09% of LOC.
  • " *.json" is smallest, containing 2.5% of LOC.


*.md1617 LOC (72%) 8 files
*.txt570 LOC (25%) 2 files
*.json56 LOC (2%) 2 files
Analyzers
Info about analyzers used for source code examinations.

2025-05-16 13:48