GoogleCloudPlatform / samples-style-guide
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
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.

main83 LOC (1%) 4 files
test0 LOC (0%) 0 files
generated1508 LOC (35%) 1 file
build and deployment0 LOC (0%) 0 files
other2702 LOC (62%) 21 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 ".*".
  • 4 files match defined criteria (83 LOC, 100.0% vs. main code):
    • 3 *.html files (54 LOC)
    • 1 *.toml files (29 LOC)
  • " *.html" is biggest, containing 65.06% of LOC.
  • " *.toml" is smallest, containing 34.94% of LOC.


*.html54 LOC (65%) 3 files
*.toml29 LOC (34%) 1 file
Generated Code
Automatically generated files, not manually changed after generation.
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/package[-]lock[.]json".
  • 1 file matches defined criteria (1,508 LOC, 1816.9% vs. main code). All matches are in *.json files.


*.json1508 LOC (100%) 1 file
Other Code
txt
mod
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]json".
    • files with paths like ".*[.]txt".
    • 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 ".*/[Ee]xamples/.*".
  • 21 files match defined criteria (2,702 LOC, 3255.4% vs. main code):
    • 5 *.json files (1,527 LOC)
    • 5 *.md files (1,144 LOC)
    • 2 *.txt files (5 LOC)
    • 1 *.cs files (4 LOC)
    • 1 *.go files (4 LOC)
    • 2 *.js files (4 LOC)
    • 1 *.rb files (3 LOC)
    • 1 *.mod files (3 LOC)
    • 1 *.java files (3 LOC)
    • 1 *.php files (3 LOC)
    • 1 *.py files (2 LOC)
  • " *.json" is biggest, containing 56.51% of LOC.
  • " *.py" is smallest, containing 0.07% of LOC.


*.json1527 LOC (56%) 5 files
*.md1144 LOC (42%) 5 files
*.txt5 LOC (<1%) 2 files
*.cs4 LOC (<1%) 1 file
*.go4 LOC (<1%) 1 file
*.js4 LOC (<1%) 2 files
*.rb3 LOC (<1%) 1 file
*.mod3 LOC (<1%) 1 file
*.java3 LOC (<1%) 1 file
*.php3 LOC (<1%) 1 file
*.py2 LOC (<1%) 1 file
Analyzers
Info about analyzers used for source code examinations.

2025-05-04 15:44