guardian / content-api-sanity-tests
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
properties
snap
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.

main1185 LOC (48%) 39 files
test1104 LOC (45%) 4 files
generated0 LOC (0%) 0 files
build and deployment8 LOC (<1%) 1 file
other146 LOC (5%) 6 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 ".*".
  • 39 files match defined criteria (1,185 LOC, 100.0% vs. main code):
    • 31 *.scala files (939 LOC)
    • 3 *.ts files (162 LOC)
    • 2 *.sbt files (37 LOC)
    • 1 *.yaml files (23 LOC)
    • 1 *.xml files (14 LOC)
    • 1 *.java files (10 LOC)
  • " *.scala" is biggest, containing 79.24% of LOC.
  • " *.java" is smallest, containing 0.84% of LOC.


*.scala939 LOC (79%) 31 files
*.ts162 LOC (13%) 3 files
*.sbt37 LOC (3%) 2 files
*.yaml23 LOC (1%) 1 file
*.xml14 LOC (1%) 1 file
*.java10 LOC (<1%) 1 file
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
snap
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/jest[.][a-zA-Z0-9\.]+".
    • files with paths like ".*[.][Tt]est[.].*".
    • files with paths like ".*[.]test[.].*".
    • files with paths like ".*[.]snap".
    • files with paths like ".*/[Tt]est/.*".
  • 4 files match defined criteria (1,104 LOC, 93.2% vs. main code):
    • 1 *.snap files (1,082 LOC)
    • 1 *.ts files (11 LOC)
    • 1 *.scala files (10 LOC)
    • 1 *.js files (1 LOC)
  • " *.snap" is biggest, containing 98.01% of LOC.
  • " *.js" is smallest, containing 0.09% of LOC.


*.snap1082 LOC (98%) 1 file
*.ts11 LOC (<1%) 1 file
*.scala10 LOC (<1%) 1 file
*.js1 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 ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/package[.]json".
    • files with paths like ".*[.]sh".
  • 1 file matches defined criteria (8 LOC, 0.7% vs. main code). All matches are in *.sh files.


*.sh8 LOC (100%) 1 file
Other Code
properties
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 ".*/[.]gitignore".
    • files with paths like ".*[.]properties".
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.]json".
  • 6 files match defined criteria (146 LOC, 12.3% vs. main code):
    • 3 *.json files (114 LOC)
    • 2 *.md files (31 LOC)
    • 1 *.properties files (1 LOC)
  • " *.json" is biggest, containing 78.08% of LOC.
  • " *.properties" is smallest, containing 0.68% of LOC.


*.json114 LOC (78%) 3 files
*.md31 LOC (21%) 2 files
*.properties1 LOC (<1%) 1 file
Analyzers
Info about analyzers used for source code examinations.

2025-05-09 20:42