guardian / editorial-tools-user-telemetry-service
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
snap
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.

main1149 LOC (23%) 22 files
test3087 LOC (64%) 13 files
generated6 LOC (<1%) 1 file
build and deployment70 LOC (1%) 3 files
other497 LOC (10%) 18 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 ".*".
  • 22 files match defined criteria (1,149 LOC, 100.0% vs. main code):
    • 21 *.ts files (1,128 LOC)
    • 1 *.cjs files (21 LOC)
  • " *.ts" is biggest, containing 98.17% of LOC.
  • " *.cjs" is smallest, containing 1.83% of LOC.


*.ts1128 LOC (98%) 21 files
*.cjs21 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 ".*/[Tt]ests/.*".
    • files with paths like ".*[.]spec[.]ts".
    • files with paths like ".*/jest[.][a-zA-Z0-9\.]+".
    • files with paths like ".*__tests__.*".
    • files with paths like ".*[.][Tt]est[.].*".
    • files with paths like ".*[.]test[.].*".
    • files with paths like ".*[.]snap".
  • 13 files match defined criteria (3,087 LOC, 268.7% vs. main code):
    • 1 *.snap files (1,957 LOC)
    • 9 *.ts files (1,116 LOC)
    • 3 *.js files (14 LOC)
  • " *.snap" is biggest, containing 63.39% of LOC.
  • " *.js" is smallest, containing 0.45% of LOC.


*.snap1957 LOC (63%) 1 file
*.ts1116 LOC (36%) 9 files
*.js14 LOC (<1%) 3 files
Generated Code
Automatically generated files, not manually changed after generation.
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/package[-]lock[.]json".
  • 1 file matches defined criteria (6 LOC, 0.5% vs. main code). All matches are in *.json files.


*.json6 LOC (100%) 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 ".*/package[.]json".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]sh".
    • files with paths like ".*/package[-]lock[.]json".
  • 3 files match defined criteria (70 LOC, 6.1% vs. main code). All matches are in *.sh files.


*.sh70 LOC (100%) 3 files
Other Code
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]json".
    • files with paths like ".*[.]md".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]txt".
  • 18 files match defined criteria (497 LOC, 43.3% vs. main code):
    • 13 *.json files (336 LOC)
    • 5 *.md files (161 LOC)
  • " *.json" is biggest, containing 67.61% of LOC.
  • " *.md" is smallest, containing 32.39% of LOC.


*.json336 LOC (67%) 13 files
*.md161 LOC (32%) 5 files
Analyzers
Info about analyzers used for source code examinations.

2025-05-09 20:53