facebookincubator / CG-SQL
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
txt
l
y
prettierignore
  • 20 extensions are included in analyses: md, sql, c, h, sh, js, txt, java, html, gitignore, py, css, svg, l, m, json, y, yml, prettierignore, inc
  • 4 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (7 files).
    • exclude files with path like ".*/docs/.*" (Documentation) (5 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.

main31103 LOC (36%) 107 files
test11866 LOC (13%) 60 files
generated7490 LOC (8%) 3 files
build and deployment631 LOC (<1%) 17 files
other34343 LOC (40%) 69 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
y
l
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 107 files match defined criteria (31,103 lines of code, 100.0% vs. main code):
    • 38 *.c files (24,050 lines of code)
    • 35 *.h files (2,439 lines of code)
    • 1 *.y files (2,341 lines of code)
    • 3 *.py files (662 lines of code)
    • 10 *.sql files (540 lines of code)
    • 9 *.js files (382 lines of code)
    • 1 *.l files (305 lines of code)
    • 5 *.java files (167 lines of code)
    • 2 *.m files (129 lines of code)
    • 2 *.css files (86 lines of code)
    • 1 *.inc files (2 lines of code)
  • " *.c" is biggest, containing 77.32% of code.
  • " *.inc" is smallest, containing 0.01% of code.


*.c24050 LOC (77%) 38 files
*.h2439 LOC (7%) 35 files
*.y2341 LOC (7%) 1 files
*.py662 LOC (2%) 3 files
*.sql540 LOC (1%) 10 files
*.js382 LOC (1%) 9 files
*.l305 LOC (<1%) 1 files
*.java167 LOC (<1%) 5 files
*.m129 LOC (<1%) 2 files
*.css86 LOC (<1%) 2 files
*.inc2 LOC (<1%) 1 files
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
y
l
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*_test[.].*".
    • files with paths like ".*/[Tt]est/.*".
    • files with paths like ".*/test_.*".
    • files with paths like ".*_tests[.].*".
  • 60 files match defined criteria (11,866 lines of code, 38.2% vs. main code):
    • 44 *.sql files (8,970 lines of code)
    • 5 *.sh files (1,639 lines of code)
    • 1 *.y files (628 lines of code)
    • 7 *.c files (428 lines of code)
    • 1 *.l files (147 lines of code)
    • 2 *.h files (54 lines of code)
  • " *.sql" is biggest, containing 75.59% of code.
  • " *.h" is smallest, containing 0.46% of code.


*.sql8970 LOC (75%) 44 files
*.sh1639 LOC (13%) 5 files
*.y628 LOC (5%) 1 files
*.c428 LOC (3%) 7 files
*.l147 LOC (1%) 1 files
*.h54 LOC (<1%) 2 files
Generated Code
Automatically generated files, not manually changed after generation.
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/generated/.*".
  • 3 files match defined criteria (7,490 lines of code, 24.1% vs. main code):
    • 1 *.md files (7,459 lines of code)
    • 2 *.sh files (31 lines of code)
  • " *.md" is biggest, containing 99.59% of code.
  • " *.sh" is smallest, containing 0.41% of code.


*.md7459 LOC (99%) 1 files
*.sh31 LOC (<1%) 2 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 ".*/package[.]json".
  • 17 files match defined criteria (631 lines of code, 2.0% vs. main code). All matches are in *.sh files.


*.sh631 LOC (100%) 17 files
Other Code
txt
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 ".*/[.]prettierignore".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/[Dd]emos?/.*".
    • files with paths like ".*[.]txt".
  • 69 files match defined criteria (34,343 lines of code, 110.4% vs. main code):
    • 61 *.md files (33,603 lines of code)
    • 3 *.txt files (487 lines of code)
    • 2 *.json files (124 lines of code)
    • 1 *.sql files (62 lines of code)
    • 1 *.c files (61 lines of code)
    • 1 *.sh files (6 lines of code)
  • " *.md" is biggest, containing 97.85% of code.
  • " *.sh" is smallest, containing 0.02% of code.


*.md33603 LOC (97%) 61 files
*.txt487 LOC (1%) 3 files
*.json124 LOC (<1%) 2 files
*.sql62 LOC (<1%) 1 files
*.c61 LOC (<1%) 1 files
*.sh6 LOC (<1%) 1 files
Analyzers
Info about analyzers used for source code examinations.
  • *.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
  • *.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
  • *.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
  • *.l 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)
  • *.m 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
  • *.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
  • *.inc files are analyzed with PhpAnalyzer:
    • 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

2022-04-15 05:04