From be174bc312c8c1baaea26e973ef9137ccc39e9f2 Mon Sep 17 00:00:00 2001 From: Andrew Davidson Date: Thu, 18 Jan 2024 09:36:27 +0000 Subject: [PATCH] Updated readme to remove 2 year old Coming soon banner; code reformat using standard tooling --- README.md | 24 +++++++++++------------- 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 11c9f39..308e0c7 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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:
[https://github.com/indented-automation/ScriptAnalyzerRules](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](https://github.com/PowerShell/PSScriptAnalyzer/tree/master/Tests/Engine/CommunityAnalyzerRules) -* InjectionHunter rules are available here:
[https://www.powershellgallery.com/packages/InjectionHunter](https://www.powershellgallery.com/packages/InjectionHunter)
-[https://github.com/matt2005/InjectionHunter](https://github.com/matt2005/InjectionHunter) +- Extra PSScriptAnalyzer rules (used by SonarQube) are available here:
[https://github.com/indented-automation/ScriptAnalyzerRules](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](https://github.com/PowerShell/PSScriptAnalyzer/tree/master/Tests/Engine/CommunityAnalyzerRules) +- InjectionHunter rules are available here:
[https://www.powershellgallery.com/packages/InjectionHunter](https://www.powershellgallery.com/packages/InjectionHunter)
+ [https://github.com/matt2005/InjectionHunter](https://github.com/matt2005/InjectionHunter) ## Installation