leparduk/psqualitycheck

This module provides an interface to a set of Pester tests that enable the enforcement of quality control rules for PowerShell scripts and modules.

PSQualityCheck

Summary

NEW PSQualityCheck v2.0.0 and COMING SOON! its companion module PSQualityTempate

This is a PowerShell module which runs a series of Pester 5 tests to validate code quality. It uses a combination of Pester tests, PSScriptAnalyzer and a set of quality standards to ensure consistent quality on PowerShell scripts and modules.

For more information please see the wiki here Wiki

Releases

PowerShell Gallery

GitHub

Release Version

Plans

If you want to see the plans and the progress of the steps within, click Release Plans

History

Is available here Release History

Prerequisites

This module requires:

• PowerShell 5.1 or PowerShell 7.1 or later
• Pester 5.1 or later
• PSScriptAnalyzer 1.19.1 or later
• ModuleBuilder 2.0.0 or later (to build)
• PowerShellGet 2.2.5 or later (to build)
• InvokeBuild 5.8.0 pr later (to build)
• Cofl.Util 1.2.2 or later (to build)

Optional items:

• Extra PSScriptAnalyzer rules (used by SonarQube) are available here:
  https://github.com/indented-automation/ScriptAnalyzerRules
• Extra PSScriptAnalyzer rules (used by VSCode) are available here:
  https://github.com/PowerShell/PSScriptAnalyzer/tree/master/Tests/Engine/CommunityAnalyzerRules
• InjectionHunter rules are available here:
  https://www.powershellgallery.com/packages/InjectionHunter
  https://github.com/matt2005/InjectionHunter

Installation

From the PSGallery:

Install-Module -Name PSQualityCheck

Usage

See the Usage page

Tests Results

See the Test Results page