microsoft / OpenAPI.NET
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
xaml
csproj
resx
gitattributes
props
editorconfig
cmd
  • 15 extensions are included in analyses: cs, txt, yaml, json, xaml, csproj, yml, resx, gitignore, md, gitattributes, ps1, props, editorconfig, cmd
  • 7 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (11 files).
    • exclude files with path like ".*/docs/.*" (Documentation) (1 file).
    • exclude files with path like ".*[.]resx" (The resx resource files) (3 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) (102 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.

main18093 LOC (28%) 241 files
test17823 LOC (28%) 113 files
generated318 LOC (<1%) 4 files
build and deployment267 LOC (<1%) 4 files
other26016 LOC (41%) 93 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
xaml
cmd
props
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 241 files match defined criteria (18,093 lines of code, 100.0% vs. main code):
    • 231 *.cs files (14,677 lines of code)
    • 7 *.xaml files (3,385 lines of code)
    • 1 *.cmd files (17 lines of code)
    • 1 *.props files (8 lines of code)
    • 1 *.ps1 files (6 lines of code)
  • " *.cs" is biggest, containing 81.12% of code.
  • " *.ps1" is smallest, containing 0.03% of code.


*.cs14677 LOC (81%) 231 files
*.xaml3385 LOC (18%) 7 files
*.cmd17 LOC (<1%) 1 files
*.props8 LOC (<1%) 1 files
*.ps16 LOC (<1%) 1 files
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
csproj
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 paths like ".*[.][Tt]ests[.].*".
    • files with any line of content like ".*/simpletest/.*".
  • 113 files match defined criteria (17,823 lines of code, 98.5% vs. main code):
    • 110 *.cs files (17,446 lines of code)
    • 3 *.csproj files (377 lines of code)
  • " *.cs" is biggest, containing 97.88% of code.
  • " *.csproj" is smallest, containing 2.12% of code.


*.cs17446 LOC (97%) 110 files
*.csproj377 LOC (2%) 3 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 ".*[.]cs" AND any line of content like "[/][/][ ]*".
  • 4 files match defined criteria (318 lines of code, 1.8% vs. main code). All matches are in *.cs files.


*.cs318 LOC (100%) 4 files
Build and Deployment Code
Source code used to configure or support build and deployment process.
csproj
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitattributes".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]csproj".
  • 4 files match defined criteria (267 lines of code, 1.5% vs. main code). All matches are in *.csproj files.


*.csproj267 LOC (100%) 4 files
Other Code
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]json".
    • files with paths like ".*[.]editorconfig".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]md".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*[.]txt".
    • files with paths like ".*/[Ss]amples/.*".
  • 93 files match defined criteria (26,016 lines of code, 143.8% vs. main code):
    • 6 *.json files (24,172 lines of code)
    • 86 *.yaml files (1,760 lines of code)
    • 1 *.md files (84 lines of code)
  • " *.json" is biggest, containing 92.91% of code.
  • " *.md" is smallest, containing 0.32% of code.


*.json24172 LOC (92%) 6 files
*.yaml1760 LOC (6%) 86 files
*.md84 LOC (<1%) 1 files
Analyzers
Info about analyzers used for source code examinations.
  • *.cs files are analyzed with CSharpAnalyzer:
    • 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 namespace heuristics)
  • *.xaml 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
  • *.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
  • *.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
  • *.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


2022-01-30 15:04