epam / badgerdoc
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
ini
mako
cfg
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.

main67332 LOC (55%) 935 files
test41368 LOC (33%) 131 files
generated0 LOC (0%) 0 files
build and deployment220 LOC (<1%) 3 files
other13085 LOC (10%) 80 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
mako
cfg
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 935 files match defined criteria (67,332 LOC, 100.0% vs. main code):
    • 274 *.py files (23,375 LOC)
    • 224 *.tsx files (21,193 LOC)
    • 77 *.yaml files (9,778 LOC)
    • 201 *.ts files (9,295 LOC)
    • 133 *.scss files (3,068 LOC)
    • 14 *.toml files (397 LOC)
    • 5 *.mako files (85 LOC)
    • 1 *.js files (70 LOC)
    • 5 *.cfg files (55 LOC)
    • 1 *.html files (16 LOC)
  • " *.py" is biggest, containing 34.72% of LOC.
  • " *.html" is smallest, containing 0.02% of LOC.


*.py23375 LOC (34%) 274 files
*.tsx21193 LOC (31%) 224 files
*.yaml9778 LOC (14%) 77 files
*.ts9295 LOC (13%) 201 files
*.scss3068 LOC (4%) 133 files
*.toml397 LOC (<1%) 14 files
*.mako85 LOC (<1%) 5 files
*.js70 LOC (<1%) 1 file
*.cfg55 LOC (<1%) 5 files
*.html16 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 ".*/[Tt]ests/.*".
    • files with paths like ".*/test_.*".
    • files with paths like ".*[.][Tt]est[.].*".
    • files with paths like ".*[.]test[.].*".
    • files with paths like ".*__tests__.*".
    • files with paths like ".*/mock[a-zA-Z0-9_\- ]+/.*".
    • files with paths like ".*/[Mm]ocks/.*".
  • 131 files match defined criteria (41,368 LOC, 61.4% vs. main code):
    • 111 *.py files (36,238 LOC)
    • 15 *.ts files (4,718 LOC)
    • 4 *.tsx files (404 LOC)
    • 1 *.js files (8 LOC)
  • " *.py" is biggest, containing 87.6% of LOC.
  • " *.js" is smallest, containing 0.02% of LOC.


*.py36238 LOC (87%) 111 files
*.ts4718 LOC (11%) 15 files
*.tsx404 LOC (<1%) 4 files
*.js8 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".
    • files with paths like ".*/package[.]json".
    • files with paths like ".*/docker[-]compose[.]yaml".
  • 3 files match defined criteria (220 LOC, 0.3% vs. main code):
    • 2 *.sh files (154 LOC)
    • 1 *.yaml files (66 LOC)
  • " *.sh" is biggest, containing 70% of LOC.
  • " *.yaml" is smallest, containing 30% of LOC.


*.sh154 LOC (70%) 2 files
*.yaml66 LOC (30%) 1 file
Other Code
txt
ini
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 ".*[.]txt".
    • files with paths like ".*[.]ini".
    • files with paths like ".*[.]json".
    • files with paths like ".*/[.]prettierignore".
    • files with paths like ".*/[.]dockerignore".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/[.]eslintignore".
    • files with paths like ".*[.]svg".
    • files with paths like ".*/[Dd]ocumentation/.*".
  • 80 files match defined criteria (13,085 LOC, 19.4% vs. main code):
    • 3 *.yaml files (5,406 LOC)
    • 7 *.json files (4,333 LOC)
    • 24 *.md files (1,734 LOC)
    • 21 *.txt files (1,080 LOC)
    • 11 *.ini files (434 LOC)
    • 12 *.svg files (68 LOC)
    • 2 *.py files (30 LOC)
  • " *.yaml" is biggest, containing 41.31% of LOC.
  • " *.py" is smallest, containing 0.23% of LOC.


*.yaml5406 LOC (41%) 3 files
*.json4333 LOC (33%) 7 files
*.md1734 LOC (13%) 24 files
*.txt1080 LOC (8%) 21 files
*.ini434 LOC (3%) 11 files
*.svg68 LOC (<1%) 12 files
*.py30 LOC (<1%) 2 files
Analyzers
Info about analyzers used for source code examinations.

2025-01-10 14:22