facebook / fbghc
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
t
hs-boot
mk
cabal
hsc
in
lhs
txt
tex
sty
y
ps
m4
x
s
ld
el
plt
bib
hx
patch
eps
cls
gml
rkt
project
gitmodules
  • 50 extensions are included in analyses: hs, t, c, h, hs-boot, mk, cabal, hsc, rst, in, gitignore, lhs, md, sh, py, txt, tex, yml, bat, sty, y, asm, css, ps, m4, x, html, m, s, ld, cpp, el, plt, bib, pl, pp, hx, patch, eps, cls, gml, rkt, d, svg, project, yaml, mm, gitmodules, json, bash
  • 3 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (50 files).
    • exclude files with path like ".*[.]m4" (stuff autogenerated by autoconf - still C deps) (3 files).
    • exclude files with path like ".*/docs/.*" (Documentation) (67 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.

main477420 LOC (73%) 1434 files
test164846 LOC (25%) 7493 files
generated2 LOC (<1%) 2 files
build and deployment7838 LOC (1%) 115 files
other2694 LOC (<1%) 35 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
hs
y
hsc
x
in
cabal
hs-boot
ld
tex
lhs
project
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 1434 files match defined criteria (477,420 lines of code, 100.0% vs. main code):
    • 874 *.hs files (390,355 lines of code)
    • 180 *.c files (54,496 lines of code)
    • 211 *.h files (10,246 lines of code)
    • 4 *.y files (4,869 lines of code)
    • 26 *.hsc files (3,705 lines of code)
    • 3 *.x files (3,126 lines of code)
    • 27 *.in files (2,831 lines of code)
    • 1 *.pp files (2,787 lines of code)
    • 10 *.py files (2,432 lines of code)
    • 19 *.cabal files (1,056 lines of code)
    • 63 *.hs-boot files (826 lines of code)
    • 1 *.html files (261 lines of code)
    • 2 *.pl files (145 lines of code)
    • 3 *.yml files (77 lines of code)
    • 1 *.d files (58 lines of code)
    • 2 *.ld files (52 lines of code)
    • 2 *.css files (37 lines of code)
    • 1 *.bash files (23 lines of code)
    • 1 *.yaml files (16 lines of code)
    • 1 *.tex files (15 lines of code)
    • 1 *.lhs files (5 lines of code)
    • 1 *.project files (2 lines of code)
  • " *.hs" is biggest, containing 81.76% of code.
  • " *.project" is smallest, containing 0% of code.


*.hs390355 LOC (81%) 874 files
*.c54496 LOC (11%) 180 files
*.h10246 LOC (2%) 211 files
*.y4869 LOC (1%) 4 files
*.hsc3705 LOC (<1%) 26 files
*.x3126 LOC (<1%) 3 files
*.in2831 LOC (<1%) 27 files
*.pp2787 LOC (<1%) 1 files
*.py2432 LOC (<1%) 10 files
*.cabal1056 LOC (<1%) 19 files
*.hs-boot826 LOC (<1%) 63 files
*.html261 LOC (<1%) 1 files
*.pl145 LOC (<1%) 2 files
*.yml77 LOC (<1%) 3 files
*.d58 LOC (<1%) 1 files
*.ld52 LOC (<1%) 2 files
*.css37 LOC (<1%) 2 files
*.bash23 LOC (<1%) 1 files
*.yaml16 LOC (<1%) 1 files
*.tex15 LOC (<1%) 1 files
*.lhs5 LOC (<1%) 1 files
*.project2 LOC (<1%) 1 files
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
hs
plt
lhs
cabal
hs-boot
hsc
gml
in
hx
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[-]test[-].*".
    • files with paths like ".*/[Tt]ests/.*".
    • files with paths like ".*_tests[.].*".
    • files with paths like ".*/[Tt]est/.*".
  • 7493 files match defined criteria (164,846 lines of code, 34.5% vs. main code):
    • 7,184 *.hs files (154,780 lines of code)
    • 2 *.plt files (5,000 lines of code)
    • 26 *.lhs files (2,143 lines of code)
    • 95 *.c files (1,388 lines of code)
    • 58 *.cabal files (673 lines of code)
    • 72 *.hs-boot files (275 lines of code)
    • 14 *.hsc files (153 lines of code)
    • 1 *.gml files (134 lines of code)
    • 22 *.h files (90 lines of code)
    • 4 *.asm files (62 lines of code)
    • 2 *.m files (31 lines of code)
    • 6 *.in files (29 lines of code)
    • 1 *.mm files (21 lines of code)
    • 1 *.py files (20 lines of code)
    • 2 *.cpp files (16 lines of code)
    • 1 *.hx files (13 lines of code)
    • 1 *.bat files (9 lines of code)
    • 1 *.sh files (9 lines of code)
  • " *.hs" is biggest, containing 93.89% of code.
  • " *.sh" is smallest, containing 0.01% of code.


*.hs154780 LOC (93%) 7184 files
*.plt5000 LOC (3%) 2 files
*.lhs2143 LOC (1%) 26 files
*.c1388 LOC (<1%) 95 files
*.cabal673 LOC (<1%) 58 files
*.hs-boot275 LOC (<1%) 72 files
*.hsc153 LOC (<1%) 14 files
*.gml134 LOC (<1%) 1 files
*.h90 LOC (<1%) 22 files
*.asm62 LOC (<1%) 4 files
*.m31 LOC (<1%) 2 files
*.in29 LOC (<1%) 6 files
*.mm21 LOC (<1%) 1 files
*.py20 LOC (<1%) 1 files
*.cpp16 LOC (<1%) 2 files
*.hx13 LOC (<1%) 1 files
*.bat9 LOC (<1%) 1 files
*.sh9 LOC (<1%) 1 files
Generated Code
Automatically generated files, not manually changed after generation.
ps
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.](ps|eps|pfa)".
  • 2 files match defined criteria (2 lines of code, 0.0% vs. main code). All matches are in *.ps files.


*.ps2 LOC (100%) 2 files
Build and Deployment Code
Source code used to configure or support build and deployment process.
mk
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]sh".
    • files with paths like ".*[.]bat".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]mk".
    • files with paths like ".*/[.]gitmodules".
  • 115 files match defined criteria (7,838 lines of code, 1.6% vs. main code):
    • 98 *.mk files (7,379 lines of code)
    • 14 *.sh files (414 lines of code)
    • 3 *.bat files (45 lines of code)
  • " *.mk" is biggest, containing 94.14% of code.
  • " *.bat" is smallest, containing 0.57% of code.


*.mk7379 LOC (94%) 98 files
*.sh414 LOC (5%) 14 files
*.bat45 LOC (<1%) 3 files
Other Code
txt
patch
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 ".*[.]json".
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.]patch".
    • files with paths like ".*/INSTALL[.][a-z0-9]+".
    • files with paths like ".*[.](rst|rest|resttxt|rsttxt)".
    • files with paths like ".*[.]svg".
  • 35 files match defined criteria (2,694 lines of code, 0.6% vs. main code):
    • 23 *.md files (2,209 lines of code)
    • 10 *.txt files (336 lines of code)
    • 1 *.patch files (77 lines of code)
    • 1 *.json files (72 lines of code)
  • " *.md" is biggest, containing 82% of code.
  • " *.json" is smallest, containing 2.67% of code.


*.md2209 LOC (81%) 23 files
*.txt336 LOC (12%) 10 files
*.patch77 LOC (2%) 1 files
*.json72 LOC (2%) 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
  • *.c files are analyzed with CStyleAnalyzer:
    • 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
  • *.h files are analyzed with CppAnalyzer:
    • 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
  • *.y 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
  • *.hsc 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
  • *.x 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
  • *.in files are analyzed with RustAnalyzer:
    • 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
  • *.pp files are analyzed with PuppetAnalyzer:
    • 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
  • *.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
  • *.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
  • *.hs-boot 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
  • *.pl files are analyzed with PerlAnalyzer:
    • 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
  • *.yml 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
  • *.d files are analyzed with DAnalyzer:
    • 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
  • *.ld 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
  • *.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
  • *.bash files are analyzed with ShellAnalyzer:
    • 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
  • *.tex 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
  • *.lhs 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
  • *.project 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-14 23:24