Skip to content

Commit

Permalink
Updated readme to remove 2 year old Coming soon banner; code reformat…
Browse files Browse the repository at this point in the history
… using standard tooling
  • Loading branch information
andrewrdavidson committed Jan 18, 2024
1 parent b0acf02 commit be174bc
Showing 1 changed file with 11 additions and 13 deletions.
24 changes: 11 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

## 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](https://github.com/andrewrdavidson/PSQualityCheck/wiki)
Expand Down Expand Up @@ -32,20 +30,20 @@ Is available here [Release History](https://github.com/andrewrdavidson/PSQuality

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)
- 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:<br/>[https://github.com/indented-automation/ScriptAnalyzerRules](https://github.com/indented-automation/ScriptAnalyzerRules)
* Extra PSScriptAnalyzer rules (used by VSCode) are available here:<br/>[https://github.com/PowerShell/PSScriptAnalyzer/tree/master/Tests/Engine/CommunityAnalyzerRules](https://github.com/PowerShell/PSScriptAnalyzer/tree/master/Tests/Engine/CommunityAnalyzerRules)
* InjectionHunter rules are available here:<br/>[https://www.powershellgallery.com/packages/InjectionHunter](https://www.powershellgallery.com/packages/InjectionHunter)<br/>
[https://github.com/matt2005/InjectionHunter](https://github.com/matt2005/InjectionHunter)
- Extra PSScriptAnalyzer rules (used by SonarQube) are available here:<br/>[https://github.com/indented-automation/ScriptAnalyzerRules](https://github.com/indented-automation/ScriptAnalyzerRules)
- Extra PSScriptAnalyzer rules (used by VSCode) are available here:<br/>[https://github.com/PowerShell/PSScriptAnalyzer/tree/master/Tests/Engine/CommunityAnalyzerRules](https://github.com/PowerShell/PSScriptAnalyzer/tree/master/Tests/Engine/CommunityAnalyzerRules)
- InjectionHunter rules are available here:<br/>[https://www.powershellgallery.com/packages/InjectionHunter](https://www.powershellgallery.com/packages/InjectionHunter)<br/>
[https://github.com/matt2005/InjectionHunter](https://github.com/matt2005/InjectionHunter)

## Installation

Expand Down

0 comments on commit be174bc

Please sign in to comment.