gitlab-org / release-tools
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
rake
gitconfig
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.

main64155 LOC (94%) 885 files
test1956 LOC (2%) 17 files
generated0 LOC (0%) 0 files
build and deployment114 LOC (<1%) 8 files
other1781 LOC (2%) 25 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
rake
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 885 files match defined criteria (64,155 LOC, 100.0% vs. main code):
    • 817 *.rb files (60,098 LOC)
    • 26 *.go files (1,955 LOC)
    • 17 *.rake files (1,284 LOC)
    • 25 *.erb files (818 LOC)
  • " *.rb" is biggest, containing 93.68% of LOC.
  • " *.erb" is smallest, containing 1.28% of LOC.


*.rb60098 LOC (93%) 817 files
*.go1955 LOC (3%) 26 files
*.rake1284 LOC (2%) 17 files
*.erb818 LOC (1%) 25 files
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 ".*/mock[a-zA-Z0-9_\- ]+/.*".
    • files with paths like ".*/[Mm]ocks/.*".
    • files with paths like ".*_test[.].*".
    • files with paths like ".*[-]test[-].*".
  • 17 files match defined criteria (1,956 LOC, 3.0% vs. main code):
    • 16 *.go files (1,946 LOC)
    • 1 *.sh files (10 LOC)
  • " *.go" is biggest, containing 99.49% of LOC.
  • " *.sh" is smallest, containing 0.51% of LOC.


*.go1946 LOC (99%) 16 files
*.sh10 LOC (<1%) 1 file
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 ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]sh".
    • files with paths like ".*/[.]gitconfig".
  • 8 files match defined criteria (114 LOC, 0.2% vs. main code). All matches are in *.sh files.


*.sh114 LOC (100%) 8 files
Other Code
mod
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 ".*/[.]gitignore".
    • files with paths like ".*/go[.]mod".
    • files with paths like ".*[.]json".
  • 25 files match defined criteria (1,781 LOC, 2.8% vs. main code):
    • 17 *.md files (1,285 LOC)
    • 7 *.json files (448 LOC)
    • 1 *.mod files (48 LOC)
  • " *.md" is biggest, containing 72.15% of LOC.
  • " *.mod" is smallest, containing 2.7% of LOC.


*.md1285 LOC (72%) 17 files
*.json448 LOC (25%) 7 files
*.mod48 LOC (2%) 1 file
Analyzers
Info about analyzers used for source code examinations.


2025-05-16 13:48