facebookincubator / retrie
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
hs
txt
cabal
  • 7 extensions are included in analyses: hs, md, txt, gitignore, json, yml, cabal
  • 4 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/bin/.*" (Binaries for distribution) (1 file).
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (2 files).
    • 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).
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.

main6399 LOC (79%) 37 files
test1183 LOC (14%) 13 files
generated0 LOC (0%) 0 files
build and deployment0 LOC (0%) 0 files
other450 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.
hs
cabal
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 37 files match defined criteria (6,399 lines of code, 100.0% vs. main code):
    • 36 *.hs files (6,223 lines of code)
    • 1 *.cabal files (176 lines of code)
  • " *.hs" is biggest, containing 97.25% of code.
  • " *.cabal" is smallest, containing 2.75% of code.


*.hs6223 LOC (97%) 36 files
*.cabal176 LOC (2%) 1 files
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
hs
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/[Tt]ests/.*".
  • 13 files match defined criteria (1,183 lines of code, 18.5% vs. main code). All matches are in *.hs files.


*.hs1183 LOC (100%) 13 files
Other Code
hs
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/[Dd]emos?/.*".
    • 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".
  • 6 files match defined criteria (450 lines of code, 7.0% vs. main code):
    • 4 *.md files (332 lines of code)
    • 1 *.json files (72 lines of code)
    • 1 *.hs files (46 lines of code)
  • " *.md" is biggest, containing 73.78% of code.
  • " *.hs" is smallest, containing 10.22% of code.


*.md332 LOC (73%) 4 files
*.json72 LOC (16%) 1 files
*.hs46 LOC (10%) 1 files
Analyzers
Info about analyzers used for source code examinations.
  • *.hs 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
  • *.cabal 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


2022-04-15 05:00