PSModuleQuantityAnalyzer

PSModuleQuantityAnalyzer is a PowerShell module that performs static analysis of PowerShell modules and generates quantitative metrics about their structure, maintainability, and architecture.

It helps developers and automation engineers quickly understand the size, complexity, and health of a PowerShell codebase.

---

🚀 Key Capabilities

PSModuleQuantityAnalyzer analyzes PowerShell modules and produces insights such as:

Function Inventory

• Total number of functions
• Public vs Private functions
• File location of functions
• Lines of code per function
• Comment lines per function
• Function reference count

Code Metrics

• Total lines of code
• Comment ratio
• Average function size
• Largest functions in the module

Maintainability Insights

• Large functions
• High complexity functions
• Refactoring candidates

Architecture Insights

• Function dependency graph
• Detection of unused private functions
• Duplicate function detection

Documentation Coverage

• Functions missing comment-based help
• Documentation coverage statistics

Reporting

Reports can be exported as:

• Markdown reports (GitHub friendly)
• CSV reports
• Console summaries

---

📦 Installation

Install from the PowerShell Gallery:

Install-Module PSModuleQuantityAnalyzer

Import the module:

Import-Module PSModuleQuantityAnalyzer

---

🔎 Example Usage

Analyze a module:

Get-PSModuleSummary -ModuleName ".\MyModule.psd1"

Get-PSModuleSummary -ModuleName PSModuleQuantityAnalyzer | Select-Object Version, Function, HelpTopics, TotalLines, LinesOfCode, LinesOfComment, References, PartOfFile | ft

Generate a full Markdown report:

Export-PSModuleMarkdownReport -ModuleName "ImportExcel"

---

📊 Example Output

Module Metrics

Metric	Value
Total Functions	54
Public Functions	12
Private Functions	42
Total Lines	4820
Lines of Code	3412
Comment Lines	604
Comment Ratio	12.5 %
Average Function Size	89

---

🔎 Function Inventory

Function	Help Topics	Total Lines	Code	Comments	References	File
Access-Directory	0	34	25	3	1	Access-Directory.ps1
Add-ADCSForAS2Go	6	44	26	7	1	Add-ADCSForAS2Go.ps1
Add-GPOMemberToBuiltinGroups	3	142	81	21	1	Add-GPOMemberToBuiltinGroups.ps1
Add-GPOScheduleTask	6	86	47	11	1	Add-GPOScheduleTask.ps1
Add-GPOUserRightAssignments	0	164	117	11	1	Add-GPOUserRightAssignments.ps1
Add-GroupElementToFileGroupsXml	3	55	35	8	0	Add-GroupElementToFileGroupsXml.ps1
Add-Node	0	28	27	0	7	ChooseADOrganizationalUnit.ps1

---

📈 Function Size Distribution

pie
    title Function Size Distribution
    "0-25 Lines" : 12
    "26-50 Lines" : 18
    "51-100 Lines" : 14
    "101-200 Lines" : 7
    ">200 Lines" : 3

Loading

---

🧠 Complexity Ranking

xychart-beta
    title "Top Function Complexity"
    x-axis [FunctionA, FunctionB, FunctionC]
    y-axis "Complexity" 0 --> 20
    bar [18, 14, 10]

Loading

---

🧩 Function Dependency Graph

graph TD
FunctionA --> FunctionB
FunctionA --> FunctionC
FunctionB --> FunctionD

Loading

---

🛠 Public Commands

Command
Export-PSModuleMarkdownReport
Export-PSModuleQuantityReport
Get-PSModuleComplexity
Get-PSModuleDependencyGraph
Get-PSModuleDuplicateFunctions
Get-PSModuleHealth
Get-PSModuleLargestFunctions
Get-PSModuleMetrics
Get-PSModuleQuantity
Get-PSModuleRefactoringCandidates
Get-PSModuleSummary
Get-PSModuleUnusedPrivateFunctions

---

🎯 Use Cases

PSModuleQuantityAnalyzer can help with:

• Preparing modules for PowerShell Gallery publication
• Understanding large legacy PowerShell modules
• Detecting dead code
• Improving documentation coverage
• Identifying refactoring candidates
• Visualizing module architecture

---

🧭 Roadmap

Planned improvements:

• Code quality score
• Maintainability index
• Cyclomatic complexity analysis
• Architecture visualizations
• CI/CD integration

---

📜 License

MIT License

---

👤 Author

Holger Zimmermann

Cybersecurity Consultant focusing on:

• Active Directory Security
• PowerShell Automation
• Security Assessments