apache / incubator-devlake-terraform
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
txt
nix
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.

main1020 LOC (69%) 12 files
test158 LOC (10%) 4 files
generated0 LOC (0%) 0 files
build and deployment15 LOC (1%) 2 files
other268 LOC (18%) 12 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
nix
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 12 files match defined criteria (1,020 LOC, 100.0% vs. main code):
    • 10 *.go files (988 LOC)
    • 1 *.yaml files (21 LOC)
    • 1 *.nix files (11 LOC)
  • " *.go" is biggest, containing 96.86% of LOC.
  • " *.nix" is smallest, containing 1.08% of LOC.


*.go988 LOC (96%) 10 files
*.yaml21 LOC (2%) 1 file
*.nix11 LOC (1%) 1 file
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[.].*".
  • 4 files match defined criteria (158 LOC, 15.5% vs. main code). All matches are in *.go files.


*.go158 LOC (100%) 4 files
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 (15 LOC, 1.5% vs. main code). All matches are in *.sh files.


*.sh15 LOC (100%) 2 files
Other Code
mod
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/[Ee]xamples/.*".
    • files with paths like ".*[.]md".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*/go[.]mod".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]json".
    • files with paths like ".*[.]txt".
  • 12 files match defined criteria (268 LOC, 26.3% vs. main code):
    • 2 *.mod files (153 LOC)
    • 4 *.tf files (67 LOC)
    • 3 *.md files (40 LOC)
    • 1 *.json files (6 LOC)
    • 2 *.sh files (2 LOC)
  • " *.mod" is biggest, containing 57.09% of LOC.
  • " *.sh" is smallest, containing 0.75% of LOC.


*.mod153 LOC (57%) 2 files
*.tf67 LOC (25%) 4 files
*.md40 LOC (14%) 3 files
*.json6 LOC (2%) 1 file
*.sh2 LOC (<1%) 2 files
Analyzers
Info about analyzers used for source code examinations.

2025-05-07 20:53