azure / azure-functions-powershell-library

Analysis scope, overview of main, test, generated, deployment, build, and other code.

Source Code Analysis Scope

Files includes and excluded from analyses

txt

gitattributes

resx

csproj

12 extensions are included in analyses: cs, json, ps1, psd1, psm1, yaml, md, txt, gitignore, gitattributes, resx, csproj
4 criteria are used to exclude files from analysis:

exclude files with path like ".*[.]resx" (The resx resource files) (1 file).
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).

The source code folder contains 106 files:

85 files are included in analyses.
21 files are excluded from analyses:

Explore all 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.

28 files

30 files

1 file

25 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 ".*".

28 files match defined criteria (1,414 LOC, 100.0% vs. main code):

23 *.cs files (961 LOC)
3 *.ps1 files (197 LOC)
1 *.psm1 files (172 LOC)
1 *.psd1 files (84 LOC)

" *.cs" is biggest, containing 67.96% of LOC.
" *.psd1" is smallest, containing 5.94% of LOC.

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[.].*".

30 files match defined criteria (607 LOC, 42.9% vs. main code):

14 *.ps1 files (372 LOC)
7 *.psm1 files (145 LOC)
9 *.psd1 files (90 LOC)

" *.ps1" is biggest, containing 61.29% of LOC.
" *.psd1" is smallest, containing 14.83% of LOC.

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 ".*/src/gen/.*".
files with paths like ".*[.]cs" AND any line of content like "[/][/][ ]*".

1 file matches defined criteria (116 LOC, 8.2% vs. main code). All matches are in *.cs 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 ".*[.]csproj".

files with paths like ".*[.]git[a-z]+".

files with paths like ".*/[.]gitignore".

files with paths like ".*/[.]gitattributes".

1 file matches defined criteria (31 LOC, 2.2% vs. main code). All matches are in *.csproj files.

Other Code

txt

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 ".*/[.]gitignore".

files with paths like ".*[.]txt".

files with paths like ".*[.]json".

25 files match defined criteria (294 LOC, 20.8% vs. main code):

20 *.json files (218 LOC)

4 *.md files (75 LOC)

1 *.txt files (1 LOC)

" *.json" is biggest, containing 74.15% of LOC.

" *.txt" is smallest, containing 0.34% of LOC.