facebook / watchman
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
cmake
txt
in
gitattributes
ini
el
clang-format
cmd
clang-tidy
  • 30 extensions are included in analyses: cpp, py, h, html, markdown, md, java, rs, cmake, txt, yml, js, sh, gitignore, scss, thrift, json, c, rb, toml, css, xml, in, gitattributes, ini, el, clang-format, gemspec, cmd, clang-tidy
  • 4 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (16 files).
    • exclude files with path like ".*/docs/.*" (Documentation) (1 file).
    • exclude files with path like ".*/(3rd|[Tt]hird)[-_]?[Pp]arty/.*" (Dependencies) (20 files).
    • exclude files with path like ".*/deps/.*" (Dependencies) (3 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.

main53077 LOC (74%) 414 files
test11649 LOC (16%) 132 files
generated0 LOC (0%) 0 files
build and deployment288 LOC (<1%) 7 files
other6249 LOC (8%) 89 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
cmake
in
cmd
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 414 files match defined criteria (53,077 lines of code, 100.0% vs. main code):
    • 124 *.cpp files (23,144 lines of code)
    • 56 *.py files (9,804 lines of code)
    • 88 *.h files (4,749 lines of code)
    • 24 *.rs files (4,684 lines of code)
    • 20 *.cmake files (2,111 lines of code)
    • 20 *.java files (1,817 lines of code)
    • 3 *.c files (1,513 lines of code)
    • 5 *.scss files (1,051 lines of code)
    • 43 *.html files (1,025 lines of code)
    • 6 *.js files (931 lines of code)
    • 2 *.css files (859 lines of code)
    • 5 *.thrift files (753 lines of code)
    • 5 *.rb files (364 lines of code)
    • 6 *.yml files (145 lines of code)
    • 3 *.toml files (57 lines of code)
    • 1 *.xml files (30 lines of code)
    • 1 *.gemspec files (27 lines of code)
    • 1 *.in files (10 lines of code)
    • 1 *.cmd files (3 lines of code)
  • " *.cpp" is biggest, containing 43.6% of code.
  • " *.cmd" is smallest, containing 0.01% of code.


*.cpp23144 LOC (43%) 124 files
*.py9804 LOC (18%) 56 files
*.h4749 LOC (8%) 88 files
*.rs4684 LOC (8%) 24 files
*.cmake2111 LOC (3%) 20 files
*.java1817 LOC (3%) 20 files
*.c1513 LOC (2%) 3 files
*.scss1051 LOC (1%) 5 files
*.html1025 LOC (1%) 43 files
*.js931 LOC (1%) 6 files
*.css859 LOC (1%) 2 files
*.thrift753 LOC (1%) 5 files
*.rb364 LOC (<1%) 5 files
*.yml145 LOC (<1%) 6 files
*.toml57 LOC (<1%) 3 files
*.xml30 LOC (<1%) 1 files
*.gemspec27 LOC (<1%) 1 files
*.in10 LOC (<1%) 1 files
*.cmd3 LOC (<1%) 1 files
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/[Tt]est/.*".
    • files with paths like ".*_test[.].*".
    • files with paths like ".*/test_.*".
    • files with paths like ".*/[Tt]ests/.*".
    • files with paths like ".*/[Ss]pecs/.*".
  • 132 files match defined criteria (11,649 lines of code, 21.9% vs. main code):
    • 94 *.py files (7,031 lines of code)
    • 24 *.cpp files (2,898 lines of code)
    • 10 *.java files (1,590 lines of code)
    • 1 *.js files (69 lines of code)
    • 2 *.h files (60 lines of code)
    • 1 *.sh files (1 lines of code)
  • " *.py" is biggest, containing 60.36% of code.
  • " *.sh" is smallest, containing 0.01% of code.


*.py7031 LOC (60%) 94 files
*.cpp2898 LOC (24%) 24 files
*.java1590 LOC (13%) 10 files
*.js69 LOC (<1%) 1 files
*.h60 LOC (<1%) 2 files
*.sh1 LOC (<1%) 1 files
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 ".*[.]sh".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/pom[.]xml".
    • files with paths like ".*/package[.]json".
    • files with paths like ".*/[.]gitattributes".
  • 7 files match defined criteria (288 lines of code, 0.5% vs. main code):
    • 6 *.sh files (215 lines of code)
    • 1 *.xml files (73 lines of code)
  • " *.sh" is biggest, containing 74.65% of code.
  • " *.xml" is smallest, containing 25.35% of code.


*.sh215 LOC (74%) 6 files
*.xml73 LOC (25%) 1 files
Other Code
txt
ini
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]md".
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.]json".
    • files with paths like ".*[.]markdown".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/[Ee]xamples/.*".
    • files with paths like ".*[.]ini".
    • files with paths like ".*/LICENSE[.][a-z0-9]+".
  • 89 files match defined criteria (6,249 lines of code, 11.8% vs. main code):
    • 42 *.markdown files (3,485 lines of code)
    • 30 *.md files (1,367 lines of code)
    • 7 *.txt files (855 lines of code)
    • 5 *.json files (353 lines of code)
    • 4 *.rs files (188 lines of code)
    • 1 *.ini files (1 lines of code)
  • " *.markdown" is biggest, containing 55.77% of code.
  • " *.ini" is smallest, containing 0.02% of code.


*.markdown3485 LOC (55%) 42 files
*.md1367 LOC (21%) 30 files
*.txt855 LOC (13%) 7 files
*.json353 LOC (5%) 5 files
*.rs188 LOC (3%) 4 files
*.ini1 LOC (<1%) 1 files
Analyzers
Info about analyzers used for source code examinations.
  • *.cpp 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
  • *.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
  • *.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
  • *.rs 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
  • *.cmake 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
  • *.java files are analyzed with JavaAnalyzer:
    • 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 (based on package names)
  • *.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
  • *.scss files are analyzed with ScssAnalyzer:
    • 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
  • *.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
  • *.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
  • *.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
  • *.thrift files are analyzed with ThriftAnalyzer:
    • 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
  • *.rb files are analyzed with RubyAnalyzer:
    • 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
    • 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
  • *.toml 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
  • *.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
  • *.gemspec files are analyzed with RubyAnalyzer:
    • 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
    • Basic heuristic 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
  • *.cmd 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 22:42