fbsamples / workplace-platform-samples
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
ps1
ejs
txt
editorconfig
  • 13 extensions are included in analyses: md, js, py, ps1, json, gitignore, css, ejs, txt, xml, sql, editorconfig, php
  • 5 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 ".*/normalize[.](css|less|scss|styl)" (Normalize css) (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 ".*[.]txt" (Text files) (1 file).
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.

main5874 LOC (25%) 75 files
test0 LOC (0%) 0 files
generated7433 LOC (32%) 1 files
build and deployment0 LOC (0%) 0 files
other9574 LOC (41%) 87 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
ps1
ejs
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 75 files match defined criteria (5,874 lines of code, 100.0% vs. main code):
    • 21 *.ps1 files (2,444 lines of code)
    • 24 *.js files (1,793 lines of code)
    • 24 *.py files (1,314 lines of code)
    • 2 *.css files (160 lines of code)
    • 3 *.ejs files (103 lines of code)
    • 1 *.php files (60 lines of code)
  • " *.ps1" is biggest, containing 41.61% of code.
  • " *.php" is smallest, containing 1.02% of code.


*.ps12444 LOC (41%) 21 files
*.js1793 LOC (30%) 24 files
*.py1314 LOC (22%) 24 files
*.css160 LOC (2%) 2 files
*.ejs103 LOC (1%) 3 files
*.php60 LOC (1%) 1 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 ".*/package[-]lock[.]json".
  • 1 file matches defined criteria (7,433 lines of code, 126.5% vs. main code). All matches are in *.json files.


*.json7433 LOC (100%) 1 files
Other Code
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 ".*[.]json".
    • files with paths like ".*[.]editorconfig".
    • files with paths like ".*[.]txt".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.](xml|xsd|robot|sql|pgsql|dashboard|profile|ipynb|raml|avsc|al)".
  • 87 files match defined criteria (9,574 lines of code, 163.0% vs. main code):
    • 15 *.json files (8,031 lines of code)
    • 69 *.md files (1,526 lines of code)
    • 2 *.xml files (16 lines of code)
    • 1 *.sql files (1 lines of code)
  • " *.json" is biggest, containing 83.88% of code.
  • " *.sql" is smallest, containing 0.01% of code.


*.json8031 LOC (83%) 15 files
*.md1526 LOC (15%) 69 files
*.xml16 LOC (<1%) 2 files
*.sql1 LOC (<1%) 1 files
Analyzers
Info about analyzers used for source code examinations.
  • *.ps1 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
  • *.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
  • *.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
  • *.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
  • *.ejs 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
  • *.php 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-01-26 09:33