apache / incubator-pekko-platform-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
proto
properties
hbs
cql
txt
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.

main278 LOC (14%) 13 files
test0 LOC (0%) 0 files
generated0 LOC (0%) 0 files
build and deployment701 LOC (36%) 8 files
other927 LOC (48%) 15 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
hbs
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 13 files match defined criteria (278 LOC, 100.0% vs. main code):
    • 10 *.hbs files (219 LOC)
    • 2 *.yml files (49 LOC)
    • 1 *.js files (10 LOC)
  • " *.hbs" is biggest, containing 78.78% of LOC.
  • " *.js" is smallest, containing 3.6% of LOC.


*.hbs219 LOC (78%) 10 files
*.yml49 LOC (17%) 2 files
*.js10 LOC (3%) 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 ".*/docker[-]compose[.]yml".
    • files with paths like ".*/pom[.]xml".
  • 8 files match defined criteria (701 LOC, 252.2% vs. main code). All matches are in *.sh files.


*.sh701 LOC (100%) 8 files
Other Code
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 ".*[.]svg".
    • files with paths like ".*/[Ee]xamples/.*".
    • files with paths like ".*[.]properties".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]txt".
  • 15 files match defined criteria (927 LOC, 333.5% vs. main code):
    • 9 *.svg files (661 LOC)
    • 1 *.adoc files (174 LOC)
    • 4 *.md files (75 LOC)
    • 1 *.json files (17 LOC)
  • " *.svg" is biggest, containing 71.31% of LOC.
  • " *.json" is smallest, containing 1.83% of LOC.


*.svg661 LOC (71%) 9 files
*.adoc174 LOC (18%) 1 file
*.md75 LOC (8%) 4 files
*.json17 LOC (1%) 1 file
Analyzers
Info about analyzers used for source code examinations.

2023-08-11 02:35