Fix table to refer to existing md files, add col for Configurable

RuleDocumentation/README.md

@@ -0,0 +1,57 @@
+# PSScriptAnalyzer Rules
+
+## Table of Contents
+
+| Rule | Severity | Configurable |
+|------|----------------------------------|--------------|
+|[AlignAssignmentStatement](./AlignAssignmentStatement.md) | Warning | |
+|[AvoidDefaultValueForMandatoryParameter](./AvoidDefaultValueForMandatoryParameter.md) | Warning | |
+|[AvoidDefaultValueSwitchParameter](./AvoidDefaultValueSwitchParameter.md) | Warning | |
+|[AvoidGlobalAliases](./AvoidGlobalAliases.md) | Warning | |
+|[AvoidGlobalFunctions](./AvoidGlobalFunctions.md) | Warning | |
+|[AvoidGlobalVars](./AvoidGlobalVars.md) | Warning | |
+|[AvoidInvokingEmptyMembers](./AvoidInvokingEmptyMembers.md) | Warning | |
+|[AvoidNullOrEmptyHelpMessageAttribute](./AvoidNullOrEmptyHelpMessageAttribute.md) | Warning | |
+|[AvoidShouldContinueWithoutForce](./AvoidShouldContinueWithoutForce.md) | Warning | |
+|[AvoidUsingCmdletAliases](./AvoidUsingCmdletAliases.md) | Warning | Yes |
+|[AvoidUsingComputerNameHardcoded](./AvoidUsingComputerNameHardcoded.md) | Error | |
+|[AvoidUsingConvertToSecureStringWithPlainText](./AvoidUsingConvertToSecureStringWithPlainText.md) | Error | |
+|[AvoidUsingDeprecatedManifestFields](./AvoidUsingDeprecatedManifestFields.md) | Warning | |
+|[AvoidUsingEmptyCatchBlock](./AvoidUsingEmptyCatchBlock.md) | Warning | |
+|[AvoidUsingInvokeExpression](./AvoidUsingInvokeExpression.md) | Warning | |
+|[AvoidUsingPlainTextForPassword](./AvoidUsingPlainTextForPassword.md) | Warning | |
+|[AvoidUsingPositionalParameters](./AvoidUsingPositionalParameters.md) | Warning | |
+|[AvoidUsingUsernameAndPasswordParams](./AvoidUsingUsernameAndPasswordParams.md) | Error | |
+|[AvoidUsingWMICmdlet](./AvoidUsingWMICmdlet.md) | Warning | |
+|[AvoidUsingWriteHost](./AvoidUsingWriteHost.md) | Warning | |
+|[DSCDscExamplesPresent](./DSCDscExamplesPresent.md) | Information | |
+|[DSCDscTestsPresent](./DSCDscTestsPresent.md) | Information | |
+|[DSCReturnCorrectTypesForDSCFunctions](./DSCReturnCorrectTypesForDSCFunctions.md) | Information | |
+|[DSCStandardDSCFunctionsInResource](./DSCStandardDSCFunctionsInResource.md) | Error | |
+|[DSCUseIdenticalMandatoryParametersForDSC](./DSCUseIdenticalMandatoryParametersForDSC.md) | Error | |
+|[DSCUseIdenticalParametersForDSC](./DSCUseIdenticalParametersForDSC.md) | Error | |
+|[DSCUseVerboseMessageInDSCResource](./DSCUseVerboseMessageInDSCResource.md) | Error | |
+|[MisleadingBacktick](./MisleadingBacktick.md) | Warning | |
+|[MissingModuleManifestField](./MissingModuleManifestField.md) | Warning | |
+|[PossibleIncorrectComparisonWithNull](./PossibleIncorrectComparisonWithNull.md) | Warning | |
+|[ProvideCommentHelp](./ProvideCommentHelp.md) | Information | Yes |
+|[ReservedCmdletChar](./ReservedCmdletChar.md) | Error | |
+|[ReservedParams](./ReservedParams.md) | Error | |
+|[ShouldProcess](./ShouldProcess.md) | Error | |
+|[UseApprovedVerbs](./UseApprovedVerbs.md) | Warning | |
+|[UseBOMForUnicodeEncodedFile](./UseBOMForUnicodeEncodedFile.md) | Warning | |
+|[UseCmdletCorrectly](./UseCmdletCorrectly.md) | Warning | |
+|[UseDeclaredVarsMoreThanAssignments](./UseDeclaredVarsMoreThanAssignments.md) | Warning | |
+|[UseLiteralInitializerForHashtable](./UseLiteralInitializerForHashtable.md) | Warning | |
+|[UseOutputTypeCorrectly](./UseOutputTypeCorrectly.md) | Information | |
+|[UsePSCredentialType](./UsePSCredentialType.md) | Warning | |
+|[UseShouldProcessForStateChangingFunctions](./UseShouldProcessForStateChangingFunctions.md) | Warning | |
+|[UseSingularNouns](./UseSingularNouns.md) | Warning | |
+|[UseSupportsShouldProcess](./UseSupportsShouldProcess.md) | Warning | |
+|[UseToExportFieldsInManifest](./UseToExportFieldsInManifest.md) | Warning | |
+|[UseCompatibleCmdlets](./UseCompatibleCmdlets.md) | Warning | Yes |
+|[PlaceOpenBrace](./PlaceOpenBrace.md) | Warning | Yes |
+|[PlaceCloseBrace](./PlaceCloseBrace.md) | Warning | Yes |
+|[UseConsistentIndentation](./UseConsistentIndentation.md) | Warning | Yes |
+|[UseConsistentWhitespace](./UseConsistentWhitespace.md) | Warning | Yes |
+|[UseUTF8EncodingForHelpFile](./UseUTF8EncodingForHelpFile.md) | Warning | |

RuleDocumentation/UseSingularNouns.md

@@ -17,7 +17,7 @@ Change plurals to singular.
 ``` PowerShell
 function Get-Files
 {
-	...
+    ...
 }
 ```
 
@@ -26,6 +26,6 @@ function Get-Files
 ``` PowerShell
 function Get-File
 {
-	...
+    ...
 }
 ```

Tests/Docmentation/RuleDocumentation.tests.ps1

@@ -0,0 +1,56 @@
+$directory = Split-Path -Parent $MyInvocation.MyCommand.Path
+$testRootDirectory = Split-Path -Parent $directory
+$repoRootDirectory = Split-Path -Parent $testRootDirectory
+$ruleDocDirectory = Join-Path $repoRootDirectory RuleDocumentation
+
+Import-Module PSScriptAnalyzer
+Import-Module (Join-Path $testRootDirectory "PSScriptAnalyzerTestHelper.psm1")
+
+Describe "Validate rule documentation files" {
+    BeforeAll {
+        $docs = Get-ChildItem $ruleDocDirectory/*.md -Exclude README.md |
+            ForEach-Object { "PS" + $_.BaseName} | Sort-Object
+        $rules = Get-ScriptAnalyzerRule | ForEach-Object RuleName | Sort-Object
+        $rulesDocsDiff = Compare-Object -ReferenceObject $rules -DifferenceObject $docs -SyncWindow 25
+
+        $readmeLinks = @{}
+        $readmeRules = Get-Content -LiteralPath $ruleDocDirectory/README.md |
+            Foreach-Object { if ($_ -match '^\s*\|\s*\[([^]]+)\]\(([^)]+)\)\s*\|') {
+                $ruleName = $matches[1]
+                $readmeLinks["$ruleName"] = $matches[2]
+                "PS${ruleName}"
+            }} |
+            Sort-Object
+        $rulesReadmeDiff = Compare-Object -ReferenceObject $rules -DifferenceObject $readmeRules -SyncWindow 25
+    }
+
+    It "Every rule must have a rule documentation file" {
+        $rulesDocsDiff | Where-Object SideIndicator -eq "<=" | Foreach-Object InputObject | Should -BeNullOrEmpty
+    }
+    It "Every rule documentation file must have a corresponding rule" {
+        $rulesDocsDiff | Where-Object SideIndicator -eq "=>" | Foreach-Object InputObject | Should -BeNullOrEmpty
+    }
+
+    It "Every rule must have an entry in the rule documentation README.md file" {
+        $rulesReadmeDiff | Where-Object SideIndicator -eq "<=" | Foreach-Object InputObject | Should -BeNullOrEmpty
+    }
+    It "Every entry in the rule documentation README.md file must correspond to a rule" {
+        $rulesReadmeDiff | Where-Object SideIndicator -eq "=>" | Foreach-Object InputObject | Should -BeNullOrEmpty
+    }
+
+    It "Every entry in the rule documentation README.md file must have a valid link to the documentation file" {
+        foreach ($key in $readmeLinks.Keys) {
+            $link = $readmeLinks[$key]
+            $filePath = Join-Path $ruleDocDirectory $link
+            $filePath | Should -Exist
+        }
+    }
+    It "Every rule name in the rule documentation README.md file must match the documentation file's basename" {
+        foreach ($key in $readmeLinks.Keys) {
+            $link = $readmeLinks[$key]
+            $filePath = Join-Path $ruleDocDirectory $link
+            $fileName = Split-Path $filePath -Leaf
+            $fileName | Should -BeExactly "${key}.md"
+        }
+    }
+}