apache / incubator-liminal
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
cfg
in
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.

main2094 LOC (31%) 71 files
test2361 LOC (35%) 78 files
generated0 LOC (0%) 0 files
build and deployment93 LOC (1%) 3 files
other2098 LOC (31%) 56 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
in
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 71 files match defined criteria (2,094 LOC, 100.0% vs. main code):
    • 67 *.py files (1,983 LOC)
    • 2 *.yml files (56 LOC)
    • 1 *.toml files (36 LOC)
    • 1 *.in files (19 LOC)
  • " *.py" is biggest, containing 94.7% of LOC.
  • " *.in" is smallest, containing 0.91% of LOC.


*.py1983 LOC (94%) 67 files
*.yml56 LOC (2%) 2 files
*.toml36 LOC (1%) 1 file
*.in19 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 ".*_tests[.].*".
  • 78 files match defined criteria (2,361 LOC, 112.8% vs. main code):
    • 71 *.py files (2,184 LOC)
    • 6 *.yml files (176 LOC)
    • 1 *.sh files (1 LOC)
  • " *.py" is biggest, containing 92.5% of LOC.
  • " *.sh" is smallest, containing 0.04% of LOC.


*.py2184 LOC (92%) 71 files
*.yml176 LOC (7%) 6 files
*.sh1 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 ".*[.]bat".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/docker[-]compose[.]yml".
  • 3 files match defined criteria (93 LOC, 4.4% vs. main code):
    • 1 *.yml files (79 LOC)
    • 2 *.sh files (14 LOC)
  • " *.yml" is biggest, containing 84.95% of LOC.
  • " *.sh" is smallest, containing 15.05% of LOC.


*.yml79 LOC (84%) 1 file
*.sh14 LOC (15%) 2 files
Other Code
txt
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 ".*[.](rst|rest|resttxt|rsttxt)".
    • files with paths like ".*[.]md".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/[Ee]xamples/.*".
    • files with paths like ".*/LICENSE[.][a-z0-9]+".
  • 56 files match defined criteria (2,098 LOC, 100.2% vs. main code):
    • 5 *.md files (869 LOC)
    • 30 *.py files (629 LOC)
    • 11 *.txt files (244 LOC)
    • 5 *.yml files (223 LOC)
    • 4 *.yaml files (112 LOC)
    • 1 *.json files (21 LOC)
  • " *.md" is biggest, containing 41.42% of LOC.
  • " *.json" is smallest, containing 1% of LOC.


*.md869 LOC (41%) 5 files
*.py629 LOC (29%) 30 files
*.txt244 LOC (11%) 11 files
*.yml223 LOC (10%) 5 files
*.yaml112 LOC (5%) 4 files
*.json21 LOC (1%) 1 file
Analyzers
Info about analyzers used for source code examinations.


2023-08-11 01:46