twitter / scoot
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
mod
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.

main26284 LOC (73%) 179 files
test8912 LOC (25%) 70 files
generated0 LOC (0%) 0 files
build and deployment16 LOC (<1%) 2 files
other400 LOC (1%) 13 files
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 ".*".
  • 179 files match defined criteria (26,284 LOC, 100.0% vs. main code):
    • 176 *.go files (26,043 LOC)
    • 3 *.thrift files (241 LOC)
  • " *.go" is biggest, containing 99.08% of LOC.
  • " *.thrift" is smallest, containing 0.92% of LOC.


*.go26043 LOC (99%) 176 files
*.thrift241 LOC (<1%) 3 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 ".*_test[.].*".
    • files with paths like ".*/test_.*".
    • files with paths like ".*/mock[a-zA-Z0-9_\- ]+/.*".
    • files with paths like ".*/[Mm]ocks/.*".
    • files with paths like ".*/[Tt]ests/.*".
    • files with paths like ".*[-]tests/.*".
    • files with paths like ".*_mock[.][a-zA-Z0-9_\-]+".
  • 70 files match defined criteria (8,912 LOC, 33.9% vs. main code):
    • 69 *.go files (8,900 LOC)
    • 1 *.sh files (12 LOC)
  • " *.go" is biggest, containing 99.87% of LOC.
  • " *.sh" is smallest, containing 0.13% of LOC.


*.go8900 LOC (99%) 69 files
*.sh12 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 ".*[.]sh".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
  • 2 files match defined criteria (16 LOC, 0.1% vs. main code). All matches are in *.sh files.


*.sh16 LOC (100%) 2 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 ".*/go[.]mod".
    • files with paths like ".*[.]json".
    • files with paths like ".*/[.]gitignore".
  • 13 files match defined criteria (400 LOC, 1.5% vs. main code):
    • 12 *.md files (382 LOC)
    • 1 *.mod files (18 LOC)
  • " *.md" is biggest, containing 95.5% of LOC.
  • " *.mod" is smallest, containing 4.5% of LOC.


*.md382 LOC (95%) 12 files
*.mod18 LOC (4%) 1 file
Analyzers
Info about analyzers used for source code examinations.

2025-01-17 11:59