twitter / groupcache
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
proto
txt
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.

main1801 LOC (56%) 10 files
test1297 LOC (41%) 8 files
generated0 LOC (0%) 0 files
build and deployment9 LOC (<1%) 1 file
other55 LOC (1%) 2 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
proto
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 10 files match defined criteria (1,801 LOC, 100.0% vs. main code):
    • 9 *.go files (1,755 LOC)
    • 1 *.proto files (46 LOC)
  • " *.go" is biggest, containing 97.45% of LOC.
  • " *.proto" is smallest, containing 2.55% of LOC.


*.go1755 LOC (97%) 9 files
*.proto46 LOC (2%) 1 file
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
proto
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*_test[.].*".
    • files with paths like ".*/test[.].*".
  • 8 files match defined criteria (1,297 LOC, 72.0% vs. main code):
    • 7 *.go files (1,246 LOC)
    • 1 *.proto files (51 LOC)
  • " *.go" is biggest, containing 96.07% of LOC.
  • " *.proto" is smallest, containing 3.93% of LOC.


*.go1246 LOC (96%) 7 files
*.proto51 LOC (3%) 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".
  • 1 file matches defined criteria (9 LOC, 0.5% vs. main code). All matches are in *.sh files.


*.sh9 LOC (100%) 1 file
Other Code
mod
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/go[.]mod".
    • files with paths like ".*[.]json".
    • files with paths like ".*[.]md".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]txt".
  • 2 files match defined criteria (55 LOC, 3.1% vs. main code):
    • 1 *.md files (52 LOC)
    • 1 *.mod files (3 LOC)
  • " *.md" is biggest, containing 94.55% of LOC.
  • " *.mod" is smallest, containing 5.45% of LOC.


*.md52 LOC (94%) 1 file
*.mod3 LOC (5%) 1 file
Analyzers
Info about analyzers used for source code examinations.

2025-01-17 11:59