Update documentation and improve rule skipping logic in PSScriptAnalyzer tests

Author: MariusStorhaug

README.md

@@ -98,6 +98,8 @@ For detailed documentation on the format of the settings file, see the
 ## References and Links
 
 - [PSScriptAnalyzer Documentation](https://learn.microsoft.com/powershell/module/psscriptanalyzer/)
-- [GitHub Super-Linter](https://github.com/github/super-linter)
+- [PSScriptAnalyzer Module Overview](https://learn.microsoft.com/en-us/powershell/utility-modules/psscriptanalyzer/overview?view=ps-modules)
+- [PSScriptAnalyzer Rules](https://learn.microsoft.com/en-us/powershell/utility-modules/psscriptanalyzer/rules/readme?view=ps-modules)
 - [PSScriptAnalyzer GitHub Repository](https://github.com/PowerShell/PSScriptAnalyzer)
 - [Custom Rules in PSScriptAnalyzer](https://docs.microsoft.com/powershell/scripting/developer/hosting/psscriptanalyzer-extensibility)
+- [GitHub Super-Linter](https://github.com/github/super-linter)

scripts/tests/PSScriptAnalyzer/PSScriptAnalyzer.Tests.ps1

@@ -22,15 +22,19 @@ BeforeDiscovery {
     $Severeties = $ruleObjects | Select-Object -ExpandProperty Severity -Unique
     foreach ($ruleObject in $ruleObjects) {
         $skip = if ($ruleObject.RuleName -in $settings.ExcludeRules) {
+            Write-Verbose "Skipping rule [$($ruleObject.RuleName)] - Because it is in the exclude list" -Verbose
             $true
         } elseif ($settings.IncludeRules -and $ruleObject.RuleName -notin $settings.IncludeRules) {
-            $skip = $true
+            Write-Verbose "Skipping rule [$($ruleObject.RuleName)] - Because it is not in the include list" -Verbose
+            $true
         } elseif ($settings.Severity -and $ruleObject.Severity -notin $settings.Severity) {
-            $skip = $true
+            Write-Verbose "Skipping rule [$($ruleObject.RuleName)] - Because it is not in the severity list" -Verbose
+            $true
         } elseif ($settings.Rules -and $settings.Rules.ContainsKey($ruleObject.RuleName) -and -not $settings.Rules[$ruleObject.RuleName].Enabled) {
-            $skip = $true
+            Write-Verbose "Skipping rule [$($ruleObject.RuleName)] - Because it is disabled" -Verbose
+            $true
         } else {
-            $skip = $false
+            $false
         }
 
         $rules.Add(

tests/srcTestRepo/tests/Custom.Settings.psd1

@@ -59,7 +59,6 @@
         'PSProvideCommentHelp'
         'PSUseConsistentIndentation'
     )
-    IncludeDefaultRules = $false
     Severity            = @(
         'Error'
         'Warning'