guardian/facia-tool
Code Volume
Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
mjs
editorconfig
snap
jscsrc
properties
prettierignore

scoping details...
  • 25 extensions are included in analyses: ts, js, tsx, scala, html, json, md, sql, sh, mjs, css, svg, py, yml, gitignore, yaml, txt, sbt, editorconfig, snap, jscsrc, xml, cjs, properties, prettierignore
  • 9 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/bin/.*" (Binaries for distribution) (1 file).
    • exclude files with path like ".*\.d\.ts" (Typescript definition files) (3 files).
    • exclude files with path like ".*/docs/.*" (Documentation) (7 files).
    • exclude files with path like ".*/bootstrap[.](js|css|less|scss|styl)" (Bootstrap) (1 file).
    • exclude files with path like ".*/git[-]commit[-]trailers[.]txt" (Git history trailers) (1 file).
    • exclude files with path like ".*/git[-][a-zA-Z0-9_]+[.]txt" (Git data exports for sokrates analyses) (1 file).
    • exclude files with path like ".*/_sokrates/.*" (Sokrates files) (0 files).
    • exclude files with path like ".*/_sokrates_landscape/.*" (Sokrates landscape files) (0 files).
    • exclude files with path like ".*/sokrates_.*?[.]json" (Sokrates conventions and configurations) (0 files).
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.
main78400 LOC (55%) 749 files
test39431 LOC (28%) 245 files
generated9946 LOC (7%) 1 file
build and deployment818 LOC (<1%) 19 files
other11826 LOC (8%) 33 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
mjs
jscsrc
Explore:   circles  |  sunburst

ts18845 LOC (24%) 198 files
tsx18326 LOC (23%) 185 files
js18310 LOC (23%) 141 files
scala17116 LOC (21%) 159 files
css2497 LOC (3%) 5 files
mjs1414 LOC (1%) 6 files
html1287 LOC (1%) 32 files
py339 LOC (<1%) 4 files
sql189 LOC (<1%) 14 files
yaml47 LOC (<1%) 3 files
xml24 LOC (<1%) 1 file
jscsrc6 LOC (<1%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 749 files match defined criteria (78,400 LOC, 100.0% vs. main code):
    • 198 ts files (18,845 LOC)
    • 185 tsx files (18,326 LOC)
    • 141 js files (18,310 LOC)
    • 159 scala files (17,116 LOC)
    • 5 css files (2,497 LOC)
    • 6 mjs files (1,414 LOC)
    • 32 html files (1,287 LOC)
    • 4 py files (339 LOC)
    • 14 sql files (189 LOC)
    • 3 yaml files (47 LOC)
    • 1 xml files (24 LOC)
    • 1 jscsrc files (6 LOC)
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
snap
Explore:   circles  |  sunburst

ts12619 LOC (32%) 71 files
js10412 LOC (26%) 109 files
scala8000 LOC (20%) 40 files
snap5495 LOC (13%) 2 files
tsx2887 LOC (7%) 22 files
cjs18 LOC (<1%) 1 file

scope details...
  • 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/.*".
    • files with paths like ".*/mock[^/]*/.*".
    • files with paths like ".*/[Mm]ocks/.*".
    • files with paths like ".*/[Tt]ests/.*".
    • files with paths like ".*[.]spec[.]js".
    • files with paths like ".*/__mock[^/]*/.*".
    • files with paths like ".*[.]spec[.]ts".
    • files with paths like ".*__tests__.*".
    • files with paths like ".*[.]spec[.]tsx".
    • files with paths like ".*[-]test[-].*".
    • files with paths like ".*/karma[.]conf[.]js".
  • 245 files match defined criteria (39,431 LOC, 50.3% vs. main code):
    • 71 ts files (12,619 LOC)
    • 109 js files (10,412 LOC)
    • 40 scala files (8,000 LOC)
    • 2 snap files (5,495 LOC)
    • 22 tsx files (2,887 LOC)
    • 1 cjs files (18 LOC)
Generated Code
Automatically generated files, not manually changed after generation.
Explore:   circles  |  sunburst

json9946 LOC (100%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*/package[-]lock[.]json".
  • 1 file matches defined criteria (9,946 LOC, 12.7% vs. main code). All matches are in json files.
Build and Deployment Code
Source code used to configure or support build and deployment process.
editorconfig
prettierignore
Explore:   circles  |  sunburst

yaml342 LOC (41%) 4 files
sh240 LOC (29%) 6 files
sbt146 LOC (17%) 2 files
gitignore66 LOC (8%) 4 files
editorconfig22 LOC (2%) 2 files
prettierignore2 LOC (<1%) 1 file

scope details...
  • 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[-]lock[.]json".
    • files with paths like ".*/package[.]json".
    • files with paths like ".*[.]editorconfig".
    • files with paths like "(.*/)?[.]editorconfig".
    • files with paths like ".*/[.]prettierignore".
    • files with paths like "(.*/)?[.]prettierignore".
    • files with paths like ".*[.]sbt".
    • files with paths like ".*[.]sh".
    • files with paths like ".*/[.]github/workflows/.*[.]ya?ml".
    • files with paths like ".*/docker[-]compose[.]yml".
    • files with paths like "(.*/)?[.](idea|vscode|vs|gradle|mvn|settings|metadata|circleci)/.*".
  • 19 files match defined criteria (818 LOC, 1.0% vs. main code):
    • 4 yaml files (342 LOC)
    • 6 sh files (240 LOC)
    • 2 sbt files (146 LOC)
    • 4 gitignore files (66 LOC)
    • 2 editorconfig files (22 LOC)
    • 1 prettierignore files (2 LOC)
Other Code
properties
Explore:   circles  |  sunburst

json10921 LOC (92%) 17 files
md869 LOC (7%) 10 files
svg35 LOC (<1%) 5 files
properties1 LOC (<1%) 1 file

scope details...
  • 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 ".*[.]svg".
    • files with paths like ".*[.]properties".
    • files with paths like ".*[.]txt".
  • 33 files match defined criteria (11,826 LOC, 15.1% vs. main code):
    • 17 json files (10,921 LOC)
    • 10 md files (869 LOC)
    • 5 svg files (35 LOC)
    • 1 properties files (1 LOC)
About This Analysis
learn more about scopes (main, test, generated, build, 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.

learn more about used code analyzers...
  • *.ts files are analyzed with TypeScriptAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
    • Unit size analysis
    • Conditional complexity analysis
    • No dependency analysis
  • *.tsx files are analyzed with TypeScriptAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
    • Unit size analysis
    • Conditional complexity analysis
    • No dependency analysis
  • *.js files are analyzed with JavaScriptAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
    • Unit size analysis
    • Conditional complexity analysis
    • No dependency analysis
  • *.scala files are analyzed with ScalaAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
    • Unit size analysis
    • Conditional complexity analysis
    • Basic heuristic dependency analysis
  • *.css files are analyzed with CssAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
    • No unit size analysis
    • No conditional complexity analysis
    • No dependency analysis
  • *.mjs files are analyzed with DefaultLanguageAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Basic code cleaning (empty lines removed for LOC calculations and duplication calculations)
    • No unit size analysis
    • No conditional complexity analysis
    • No dependency analysis
  • *.html files are analyzed with HtmlAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
    • Unit size analysis
    • Conditional complexity analysis
    • Advanced heuristic dependency analysis
  • *.py files are analyzed with PythonAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
    • Unit size analysis
    • Conditional complexity analysis
    • Basic heuristic dependency analysis
  • *.sql files are analyzed with SqlAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
    • No unit size analysis
    • No conditional complexity analysis
    • No dependency analysis
  • *.yaml files are analyzed with YamlAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
    • No unit size analysis
    • No conditional complexity analysis
    • No dependency analysis
  • *.xml files are analyzed with XmlAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
    • No unit size analysis
    • No conditional complexity analysis
    • No dependency analysis
  • *.jscsrc files are analyzed with DefaultLanguageAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Basic code cleaning (empty lines removed for LOC calculations and duplication calculations)
    • No unit size analysis
    • No conditional complexity analysis
    • No dependency analysis