gitlab-org / gitlab-rdoc
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
rhtml
rdoc
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.

main19533 LOC (44%) 142 files
test23871 LOC (54%) 86 files
generated0 LOC (0%) 0 files
build and deployment0 LOC (0%) 0 files
other169 LOC (<1%) 6 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
rdoc
rhtml
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 142 files match defined criteria (19,533 LOC, 100.0% vs. main code):
    • 107 *.rb files (15,958 LOC)
    • 7 *.rdoc files (1,919 LOC)
    • 2 *.css files (552 LOC)
    • 21 *.rhtml files (484 LOC)
    • 4 *.js files (382 LOC)
    • 1 *.gemspec files (238 LOC)
  • " *.rb" is biggest, containing 81.7% of LOC.
  • " *.gemspec" is smallest, containing 1.22% of LOC.


*.rb15958 LOC (81%) 107 files
*.rdoc1919 LOC (9%) 7 files
*.css552 LOC (2%) 2 files
*.rhtml484 LOC (2%) 21 files
*.js382 LOC (1%) 4 files
*.gemspec238 LOC (1%) 1 file
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
rdoc
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[.].*".
  • 86 files match defined criteria (23,871 LOC, 122.2% vs. main code):
    • 85 *.rb files (23,865 LOC)
    • 1 *.rdoc files (6 LOC)
  • " *.rb" is biggest, containing 99.97% of LOC.
  • " *.rdoc" is smallest, containing 0.03% of LOC.


*.rb23865 LOC (99%) 85 files
*.rdoc6 LOC (<1%) 1 file
Other Code
rdoc
txt
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]md".
    • files with paths like ".*/LICENSE[.][a-z0-9]+".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*[.]txt".
  • 6 files match defined criteria (169 LOC, 0.9% vs. main code):
    • 2 *.rdoc files (136 LOC)
    • 1 *.md files (26 LOC)
    • 3 *.txt files (7 LOC)
  • " *.rdoc" is biggest, containing 80.47% of LOC.
  • " *.txt" is smallest, containing 4.14% of LOC.


*.rdoc136 LOC (80%) 2 files
*.md26 LOC (15%) 1 file
*.txt7 LOC (4%) 3 files
Analyzers
Info about analyzers used for source code examinations.

2025-05-16 13:32