facebook / remodel
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
feature
txt
  • 7 extensions are included in analyses: ts, feature, js, md, json, txt, gitignore
  • 4 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (1 file).
    • exclude files with path like ".*/git[-]history[.]txt" (Git history) (1 file).
    • exclude files with path like ".*/git[-][a-zA-Z0-9_]+[.]txt" (Git data exports for sokrates analyses) (0 files).
    • exclude files with path like ".*\.d\.ts" (Typescript definition files) (5 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.

  • 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.

main17896 LOC (37%) 95 files
test29365 LOC (61%) 71 files
generated0 LOC (0%) 0 files
build and deployment0 LOC (0%) 0 files
other524 LOC (1%) 9 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 ".*".
  • 95 files match defined criteria (17,896 lines of code, 100.0% vs. main code):
    • 88 *.ts files (17,318 lines of code)
    • 7 *.js files (578 lines of code)
  • " *.ts" is biggest, containing 96.77% of code.
  • " *.js" is smallest, containing 3.23% of code.


*.ts17318 LOC (96%) 88 files
*.js578 LOC (3%) 7 files
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
feature
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]feature".
    • files with paths like ".*__tests__.*".
    • files with paths like ".*/test_.*".
    • files with paths like ".*[-]test[-].*".
  • 71 files match defined criteria (29,365 lines of code, 164.1% vs. main code):
    • 40 *.ts files (21,095 lines of code)
    • 29 *.feature files (6,880 lines of code)
    • 2 *.js files (1,390 lines of code)
  • " *.ts" is biggest, containing 71.84% of code.
  • " *.js" is smallest, containing 4.73% of code.


*.ts21095 LOC (71%) 40 files
*.feature6880 LOC (23%) 29 files
*.js1390 LOC (4%) 2 files
Other Code
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]md".
    • files with paths like ".*[.]json".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]txt".
  • 9 files match defined criteria (524 lines of code, 2.9% vs. main code):
    • 5 *.md files (382 lines of code)
    • 4 *.json files (142 lines of code)
  • " *.md" is biggest, containing 72.9% of code.
  • " *.json" is smallest, containing 27.1% of code.


*.md382 LOC (72%) 5 files
*.json142 LOC (27%) 4 files
Analyzers
Info about analyzers used for source code examinations.
  • *.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
  • *.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


2022-04-14 23:08