apache / incubator-devlake
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
editorconfig
eslintignore
prettierignore
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.

main101395 LOC (70%) 1,882 files
test16114 LOC (11%) 225 files
generated0 LOC (0%) 0 files
build and deployment2234 LOC (1%) 48 files
other23891 LOC (16%) 67 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 ".*".
  • 1882 files match defined criteria (101,395 LOC, 100.0% vs. main code):
    • 1,551 *.go files (86,646 LOC)
    • 117 *.tsx files (8,740 LOC)
    • 172 *.ts files (3,254 LOC)
    • 30 *.py files (2,125 LOC)
    • 5 *.yml files (269 LOC)
    • 1 *.yaml files (203 LOC)
    • 2 *.css files (63 LOC)
    • 2 *.toml files (63 LOC)
    • 1 *.html files (20 LOC)
    • 1 *.sql files (12 LOC)
  • " *.go" is biggest, containing 85.45% of LOC.
  • " *.sql" is smallest, containing 0.01% of LOC.


*.go86646 LOC (85%) 1,551 files
*.tsx8740 LOC (8%) 117 files
*.ts3254 LOC (3%) 172 files
*.py2125 LOC (2%) 30 files
*.yml269 LOC (<1%) 5 files
*.yaml203 LOC (<1%) 1 file
*.css63 LOC (<1%) 2 files
*.toml63 LOC (<1%) 2 files
*.html20 LOC (<1%) 1 file
*.sql12 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[.].*".
    • files with paths like ".*/[Tt]est/.*".
    • files with paths like ".*/e2e/.*".
    • files with paths like ".*[.][Tt]est[.].*".
    • files with paths like ".*[.]test[.].*".
    • files with paths like ".*/[Tt]ests/.*".
    • files with paths like ".*_tests[.].*".
  • 225 files match defined criteria (16,114 LOC, 15.9% vs. main code):
    • 210 *.go files (15,407 LOC)
    • 10 *.py files (641 LOC)
    • 1 *.yml files (29 LOC)
    • 1 *.toml files (23 LOC)
    • 3 *.sh files (14 LOC)
  • " *.go" is biggest, containing 95.61% of LOC.
  • " *.sh" is smallest, containing 0.09% of LOC.


*.go15407 LOC (95%) 210 files
*.py641 LOC (3%) 10 files
*.yml29 LOC (<1%) 1 file
*.toml23 LOC (<1%) 1 file
*.sh14 LOC (<1%) 3 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 ".*/docker[-]compose[.]yml".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]sh".
    • files with paths like ".*/package[.]json".
  • 48 files match defined criteria (2,234 LOC, 2.2% vs. main code):
    • 35 *.sh files (1,509 LOC)
    • 13 *.yml files (725 LOC)
  • " *.sh" is biggest, containing 67.55% of LOC.
  • " *.yml" is smallest, containing 32.45% of LOC.


*.sh1509 LOC (67%) 35 files
*.yml725 LOC (32%) 13 files
Other Code
mod
txt
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 ".*[.]json".
    • files with paths like ".*/go[.]mod".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]txt".
    • files with paths like ".*/[.]prettierignore".
    • files with paths like ".*/[.]dockerignore".
    • files with paths like ".*/[.]eslintignore".
    • files with paths like ".*[.]svg".
    • files with paths like ".*[.]editorconfig".
  • 67 files match defined criteria (23,891 LOC, 23.6% vs. main code):
    • 25 *.json files (22,435 LOC)
    • 26 *.md files (978 LOC)
    • 14 *.svg files (329 LOC)
    • 1 *.mod files (144 LOC)
    • 1 *.txt files (5 LOC)
  • " *.json" is biggest, containing 93.91% of LOC.
  • " *.txt" is smallest, containing 0.02% of LOC.


*.json22435 LOC (93%) 25 files
*.md978 LOC (4%) 26 files
*.svg329 LOC (1%) 14 files
*.mod144 LOC (<1%) 1 file
*.txt5 LOC (<1%) 1 file
Analyzers
Info about analyzers used for source code examinations.

2023-08-11 02:17