microsoft / fsharplu
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
fs
fsproj
ini
fsx
gitattributes
targets
props
txt
pub
  • 15 extensions are included in analyses: fs, md, fsproj, ini, yml, fsx, ps1, json, gitignore, gitattributes, targets, props, txt, MD, pub
  • 5 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (4 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).
    • exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
    • exclude files with path like ".*[.]txt" (Text files) (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.

main13448 LOC (80%) 84 files
test2477 LOC (14%) 19 files
generated0 LOC (0%) 0 files
build and deployment0 LOC (0%) 0 files
other807 LOC (4%) 14 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
fs
fsproj
fsx
props
pub
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 84 files match defined criteria (13,448 lines of code, 100.0% vs. main code):
    • 65 *.fs files (12,573 lines of code)
    • 5 *.fsproj files (352 lines of code)
    • 4 *.fsx files (253 lines of code)
    • 4 *.ps1 files (229 lines of code)
    • 3 *.yml files (25 lines of code)
    • 1 *.md files (7 lines of code)
    • 1 *.props files (7 lines of code)
    • 1 *.pub files (2 lines of code)
  • " *.fs" is biggest, containing 93.49% of code.
  • " *.pub" is smallest, containing 0.01% of code.


*.fs12573 LOC (93%) 65 files
*.fsproj352 LOC (2%) 5 files
*.fsx253 LOC (1%) 4 files
*.ps1229 LOC (1%) 4 files
*.yml25 LOC (<1%) 3 files
*.md7 LOC (<1%) 1 files
*.props7 LOC (<1%) 1 files
*.pub2 LOC (<1%) 1 files
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
fs
fsproj
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.][Tt]est/.*".
    • files with paths like ".*[.][Tt]est[.].*".
    • files with paths like ".*[.][Tt]ests/.*".
    • files with paths like ".*[.][Tt]ests[.].*".
    • files with paths like ".*[-]test[-].*".
    • files with any line of content like ".*/simpletest/.*".
  • 19 files match defined criteria (2,477 lines of code, 18.4% vs. main code):
    • 16 *.fs files (2,247 lines of code)
    • 1 *.yml files (136 lines of code)
    • 2 *.fsproj files (94 lines of code)
  • " *.fs" is biggest, containing 90.71% of code.
  • " *.fsproj" is smallest, containing 3.79% of code.


*.fs2247 LOC (90%) 16 files
*.yml136 LOC (5%) 1 files
*.fsproj94 LOC (3%) 2 files
Other Code
ini
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]json".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]md".
    • files with paths like ".*[.]ini".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*[.]txt".
  • 14 files match defined criteria (807 lines of code, 6.0% vs. main code):
    • 1 *.json files (453 lines of code)
    • 8 *.md files (246 lines of code)
    • 5 *.ini files (108 lines of code)
  • " *.json" is biggest, containing 56.13% of code.
  • " *.ini" is smallest, containing 13.38% of code.


*.json453 LOC (56%) 1 files
*.md246 LOC (30%) 8 files
*.ini108 LOC (13%) 5 files
Analyzers
Info about analyzers used for source code examinations.
  • *.fs 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
  • *.fsproj 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
  • *.fsx 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
  • *.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
  • *.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
  • *.md 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
  • *.props 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
  • *.pub 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-01-30 13:45