"If you can't measure it, you can't improve it."
PSCodeHealth allows you to measure the quality and maintainability of your PowerShell code, based on a variety of metrics related to :
- Code length
- Code complexity
- Code smells, styling issues and violations of best practices
- Tests and test coverage
- Comment-based help
It can allow you to ensure that your code is compliant with metrics goals (quality gates). You can use the default (built-in) compliance rules, and you can also customize some (or all) compliance rules to fit your goals.
These features can be leveraged from within you PowerShell release pipeline.
PSCodeHealth can also generate a highly visual HTML report so that you can interpret the results at a glance, and easily share them.
For example, here is what the Summary tab looks like :
And here is an example of what the Style & Best Practices tab looks like :
Before using PSCodeHealth, you need :
- PowerShell 5.x
- The Pester PowerShell module (version 3.4.0 or later)
- The PSScriptAnalyzer PowerShell module