microsoft / PowerShell-FeatureFlags
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
csproj
nuspec
  • 10 extensions are included in analyses: json, ps1, psm1, md, txt, psd1, csproj, gitignore, yml, nuspec
  • 5 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (2 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.

main518 LOC (28%) 6 files
test794 LOC (44%) 2 files
generated0 LOC (0%) 0 files
build and deployment32 LOC (1%) 2 files
other454 LOC (25%) 7 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 6 files match defined criteria (518 lines of code, 100.0% vs. main code):
    • 1 *.psm1 files (382 lines of code)
    • 4 *.ps1 files (77 lines of code)
    • 1 *.psd1 files (59 lines of code)
  • " *.psm1" is biggest, containing 73.75% of code.
  • " *.psd1" is smallest, containing 11.39% of code.


*.psm1382 LOC (73%) 1 files
*.ps177 LOC (14%) 4 files
*.psd159 LOC (11%) 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 ".*[.][Tt]ests[.].*".
    • files with any line of content like ".*/simpletest/.*".
  • 2 files match defined criteria (794 lines of code, 153.3% vs. main code):
    • 1 *.ps1 files (590 lines of code)
    • 1 *.psm1 files (204 lines of code)
  • " *.ps1" is biggest, containing 74.31% of code.
  • " *.psm1" is smallest, containing 25.69% of code.


*.ps1590 LOC (74%) 1 files
*.psm1204 LOC (25%) 1 files
Build and Deployment Code
Source code used to configure or support build and deployment process.
nuspec
csproj
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]nuspec".
    • files with paths like ".*[.]csproj".
  • 2 files match defined criteria (32 lines of code, 6.2% vs. main code):
    • 1 *.nuspec files (21 lines of code)
    • 1 *.csproj files (11 lines of code)
  • " *.nuspec" is biggest, containing 65.62% of code.
  • " *.csproj" is smallest, containing 34.38% of code.


*.nuspec21 LOC (65%) 1 files
*.csproj11 LOC (34%) 1 files
Other Code
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 ".*/README[.][a-z0-9]+".
    • files with paths like ".*/[Ee]xamples/.*".
    • files with paths like ".*[.]txt".
  • 7 files match defined criteria (454 lines of code, 87.6% vs. main code):
    • 2 *.md files (247 lines of code)
    • 5 *.json files (207 lines of code)
  • " *.md" is biggest, containing 54.41% of code.
  • " *.json" is smallest, containing 45.59% of code.


*.md247 LOC (54%) 2 files
*.json207 LOC (45%) 5 files
Analyzers
Info about analyzers used for source code examinations.
  • *.psm1 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
  • *.psd1 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-31 01:15