PowerShell · sdwheeler · Oct 5, 2021 · Oct 4, 2021 · Oct 5, 2021
diff --git a/Tests/Documentation/RuleDocumentation.tests.ps1 b/Tests/Documentation/RuleDocumentation.tests.ps1
@@ -1,6 +1,6 @@
 Describe "Validate rule documentation files" {
     BeforeAll {
-        $ruleDocDirectory = Join-Path $PSScriptRoot '../../RuleDocumentation'
+        $ruleDocDirectory = Join-Path $PSScriptRoot '../../docs/Rules'
         $docs = Get-ChildItem $ruleDocDirectory/*.md -Exclude README.md |
             ForEach-Object { "PS" + $_.BaseName} | Sort-Object
 

diff --git a/build.psm1 b/build.psm1
@@ -102,7 +102,7 @@ function Remove-Build
 function Start-DocumentationBuild
 {
     $docsPath = Join-Path $projectRoot docs
-    $markdownDocsPath = Join-Path $docsPath markdown
+    $markdownDocsPath = Join-Path $docsPath Cmdlets
     $outputDocsPath = Join-Path $script:destinationDir en-US
     $platyPS = Get-Module -ListAvailable platyPS
     if ($null -eq $platyPS -or ($platyPS | Sort-Object Version -Descending | Select-Object -First 1).Version -lt [version]0.12)

diff --git a/docs/markdown/Get-ScriptAnalyzerRule.md → docs/Cmdlets/Get-ScriptAnalyzerRule.md b/docs/markdown/Get-ScriptAnalyzerRule.md → docs/Cmdlets/Get-ScriptAnalyzerRule.md
diff --git a/docs/markdown/Invoke-Formatter.md → docs/Cmdlets/Invoke-Formatter.md b/docs/markdown/Invoke-Formatter.md → docs/Cmdlets/Invoke-Formatter.md
diff --git a/docs/markdown/Invoke-ScriptAnalyzer.md → docs/Cmdlets/Invoke-ScriptAnalyzer.md b/docs/markdown/Invoke-ScriptAnalyzer.md → docs/Cmdlets/Invoke-ScriptAnalyzer.md
diff --git a/...Documentation/AlignAssignmentStatement.md → docs/Rules/AlignAssignmentStatement.md b/...Documentation/AlignAssignmentStatement.md → docs/Rules/AlignAssignmentStatement.md
diff --git a/...ion/AvoidAssignmentToAutomaticVariable.md → ...les/AvoidAssignmentToAutomaticVariable.md b/...ion/AvoidAssignmentToAutomaticVariable.md → ...les/AvoidAssignmentToAutomaticVariable.md
diff --git a/...AvoidDefaultValueForMandatoryParameter.md → ...AvoidDefaultValueForMandatoryParameter.md b/...AvoidDefaultValueForMandatoryParameter.md → ...AvoidDefaultValueForMandatoryParameter.md
diff --git a/...ation/AvoidDefaultValueSwitchParameter.md → ...Rules/AvoidDefaultValueSwitchParameter.md b/...ation/AvoidDefaultValueSwitchParameter.md → ...Rules/AvoidDefaultValueSwitchParameter.md
diff --git a/RuleDocumentation/AvoidGlobalAliases.md → docs/Rules/AvoidGlobalAliases.md b/RuleDocumentation/AvoidGlobalAliases.md → docs/Rules/AvoidGlobalAliases.md
diff --git a/RuleDocumentation/AvoidGlobalFunctions.md → docs/Rules/AvoidGlobalFunctions.md b/RuleDocumentation/AvoidGlobalFunctions.md → docs/Rules/AvoidGlobalFunctions.md
diff --git a/RuleDocumentation/AvoidGlobalVars.md → docs/Rules/AvoidGlobalVars.md b/RuleDocumentation/AvoidGlobalVars.md → docs/Rules/AvoidGlobalVars.md
diff --git a/...ocumentation/AvoidInvokingEmptyMembers.md → docs/Rules/AvoidInvokingEmptyMembers.md b/...ocumentation/AvoidInvokingEmptyMembers.md → docs/Rules/AvoidInvokingEmptyMembers.md
diff --git a/RuleDocumentation/AvoidLongLines.md → docs/Rules/AvoidLongLines.md b/RuleDocumentation/AvoidLongLines.md → docs/Rules/AvoidLongLines.md
diff --git a/...umentation/AvoidMultipleTypeAttributes.md → docs/Rules/AvoidMultipleTypeAttributes.md b/...umentation/AvoidMultipleTypeAttributes.md → docs/Rules/AvoidMultipleTypeAttributes.md
diff --git a/...n/AvoidNullOrEmptyHelpMessageAttribute.md → ...s/AvoidNullOrEmptyHelpMessageAttribute.md b/...n/AvoidNullOrEmptyHelpMessageAttribute.md → ...s/AvoidNullOrEmptyHelpMessageAttribute.md
diff --git a/...ntation/AvoidOverwritingBuiltInCmdlets.md → docs/Rules/AvoidOverwritingBuiltInCmdlets.md b/...ntation/AvoidOverwritingBuiltInCmdlets.md → docs/Rules/AvoidOverwritingBuiltInCmdlets.md
diff --git a/...tation/AvoidShouldContinueWithoutForce.md → .../Rules/AvoidShouldContinueWithoutForce.md b/...tation/AvoidShouldContinueWithoutForce.md → .../Rules/AvoidShouldContinueWithoutForce.md
diff --git a/RuleDocumentation/AvoidTrailingWhitespace.md → docs/Rules/AvoidTrailingWhitespace.md b/RuleDocumentation/AvoidTrailingWhitespace.md → docs/Rules/AvoidTrailingWhitespace.md
diff --git a/RuleDocumentation/AvoidUsingCmdletAliases.md → docs/Rules/AvoidUsingCmdletAliases.md b/RuleDocumentation/AvoidUsingCmdletAliases.md → docs/Rules/AvoidUsingCmdletAliases.md
diff --git a/...tation/AvoidUsingComputerNameHardcoded.md → .../Rules/AvoidUsingComputerNameHardcoded.md b/...tation/AvoidUsingComputerNameHardcoded.md → .../Rules/AvoidUsingComputerNameHardcoded.md
diff --git a/...singConvertToSecureStringWithPlainText.md → ...singConvertToSecureStringWithPlainText.md b/...singConvertToSecureStringWithPlainText.md → ...singConvertToSecureStringWithPlainText.md
diff --git a/...ion/AvoidUsingDeprecatedManifestFields.md → ...les/AvoidUsingDeprecatedManifestFields.md b/...ion/AvoidUsingDeprecatedManifestFields.md → ...les/AvoidUsingDeprecatedManifestFields.md
diff --git a/...voidUsingDoubleQuotesForConstantString.md → ...voidUsingDoubleQuotesForConstantString.md b/...voidUsingDoubleQuotesForConstantString.md → ...voidUsingDoubleQuotesForConstantString.md
diff --git a/...ocumentation/AvoidUsingEmptyCatchBlock.md → docs/Rules/AvoidUsingEmptyCatchBlock.md b/...ocumentation/AvoidUsingEmptyCatchBlock.md → docs/Rules/AvoidUsingEmptyCatchBlock.md
diff --git a/...cumentation/AvoidUsingInvokeExpression.md → docs/Rules/AvoidUsingInvokeExpression.md b/...cumentation/AvoidUsingInvokeExpression.md → docs/Rules/AvoidUsingInvokeExpression.md
diff --git a/...ntation/AvoidUsingPlainTextForPassword.md → docs/Rules/AvoidUsingPlainTextForPassword.md b/...ntation/AvoidUsingPlainTextForPassword.md → docs/Rules/AvoidUsingPlainTextForPassword.md
diff --git a/...ntation/AvoidUsingPositionalParameters.md → docs/Rules/AvoidUsingPositionalParameters.md b/...ntation/AvoidUsingPositionalParameters.md → docs/Rules/AvoidUsingPositionalParameters.md
diff --git a/...on/AvoidUsingUsernameAndPasswordParams.md → ...es/AvoidUsingUsernameAndPasswordParams.md b/...on/AvoidUsingUsernameAndPasswordParams.md → ...es/AvoidUsingUsernameAndPasswordParams.md
diff --git a/RuleDocumentation/AvoidUsingWMICmdlet.md → docs/Rules/AvoidUsingWMICmdlet.md b/RuleDocumentation/AvoidUsingWMICmdlet.md → docs/Rules/AvoidUsingWMICmdlet.md
diff --git a/RuleDocumentation/AvoidUsingWriteHost.md → docs/Rules/AvoidUsingWriteHost.md b/RuleDocumentation/AvoidUsingWriteHost.md → docs/Rules/AvoidUsingWriteHost.md
diff --git a/RuleDocumentation/DSCDscExamplesPresent.md → docs/Rules/DSCDscExamplesPresent.md b/RuleDocumentation/DSCDscExamplesPresent.md → docs/Rules/DSCDscExamplesPresent.md
diff --git a/RuleDocumentation/DSCDscTestsPresent.md → docs/Rules/DSCDscTestsPresent.md b/RuleDocumentation/DSCDscTestsPresent.md → docs/Rules/DSCDscTestsPresent.md
diff --git a/...n/DSCReturnCorrectTypesForDSCFunctions.md → ...s/DSCReturnCorrectTypesForDSCFunctions.md b/...n/DSCReturnCorrectTypesForDSCFunctions.md → ...s/DSCReturnCorrectTypesForDSCFunctions.md
diff --git a/...tion/DSCStandardDSCFunctionsInResource.md → ...ules/DSCStandardDSCFunctionsInResource.md b/...tion/DSCStandardDSCFunctionsInResource.md → ...ules/DSCStandardDSCFunctionsInResource.md
diff --git a/...CUseIdenticalMandatoryParametersForDSC.md → ...CUseIdenticalMandatoryParametersForDSC.md b/...CUseIdenticalMandatoryParametersForDSC.md → ...CUseIdenticalMandatoryParametersForDSC.md
diff --git a/...tation/DSCUseIdenticalParametersForDSC.md → .../Rules/DSCUseIdenticalParametersForDSC.md b/...tation/DSCUseIdenticalParametersForDSC.md → .../Rules/DSCUseIdenticalParametersForDSC.md
diff --git a/...tion/DSCUseVerboseMessageInDSCResource.md → ...ules/DSCUseVerboseMessageInDSCResource.md b/...tion/DSCUseVerboseMessageInDSCResource.md → ...ules/DSCUseVerboseMessageInDSCResource.md
diff --git a/RuleDocumentation/MisleadingBacktick.md → docs/Rules/MisleadingBacktick.md b/RuleDocumentation/MisleadingBacktick.md → docs/Rules/MisleadingBacktick.md
diff --git a/...cumentation/MissingModuleManifestField.md → docs/Rules/MissingModuleManifestField.md b/...cumentation/MissingModuleManifestField.md → docs/Rules/MissingModuleManifestField.md
diff --git a/RuleDocumentation/PlaceCloseBrace.md → docs/Rules/PlaceCloseBrace.md b/RuleDocumentation/PlaceCloseBrace.md → docs/Rules/PlaceCloseBrace.md
diff --git a/RuleDocumentation/PlaceOpenBrace.md → docs/Rules/PlaceOpenBrace.md b/RuleDocumentation/PlaceOpenBrace.md → docs/Rules/PlaceOpenBrace.md
diff --git a/...on/PossibleIncorrectComparisonWithNull.md → ...es/PossibleIncorrectComparisonWithNull.md b/...on/PossibleIncorrectComparisonWithNull.md → ...es/PossibleIncorrectComparisonWithNull.md
diff --git a/...ibleIncorrectUsageOfAssignmentOperator.md → ...ibleIncorrectUsageOfAssignmentOperator.md b/...ibleIncorrectUsageOfAssignmentOperator.md → ...ibleIncorrectUsageOfAssignmentOperator.md
diff --git a/...bleIncorrectUsageOfRedirectionOperator.md → ...bleIncorrectUsageOfRedirectionOperator.md b/...bleIncorrectUsageOfRedirectionOperator.md → ...bleIncorrectUsageOfRedirectionOperator.md
diff --git a/RuleDocumentation/ProvideCommentHelp.md → docs/Rules/ProvideCommentHelp.md b/RuleDocumentation/ProvideCommentHelp.md → docs/Rules/ProvideCommentHelp.md
diff --git a/RuleDocumentation/README.md → docs/Rules/README.md b/RuleDocumentation/README.md → docs/Rules/README.md
diff --git a/RuleDocumentation/ReservedCmdletChar.md → docs/Rules/ReservedCmdletChar.md b/RuleDocumentation/ReservedCmdletChar.md → docs/Rules/ReservedCmdletChar.md
diff --git a/RuleDocumentation/ReservedParams.md → docs/Rules/ReservedParams.md b/RuleDocumentation/ReservedParams.md → docs/Rules/ReservedParams.md
diff --git a/RuleDocumentation/ReviewUnusedParameter.md → docs/Rules/ReviewUnusedParameter.md b/RuleDocumentation/ReviewUnusedParameter.md → docs/Rules/ReviewUnusedParameter.md
diff --git a/RuleDocumentation/ShouldProcess.md → docs/Rules/ShouldProcess.md b/RuleDocumentation/ShouldProcess.md → docs/Rules/ShouldProcess.md
diff --git a/RuleDocumentation/UseApprovedVerbs.md → docs/Rules/UseApprovedVerbs.md b/RuleDocumentation/UseApprovedVerbs.md → docs/Rules/UseApprovedVerbs.md
diff --git a/...umentation/UseBOMForUnicodeEncodedFile.md → docs/Rules/UseBOMForUnicodeEncodedFile.md b/...umentation/UseBOMForUnicodeEncodedFile.md → docs/Rules/UseBOMForUnicodeEncodedFile.md
diff --git a/RuleDocumentation/UseCmdletCorrectly.md → docs/Rules/UseCmdletCorrectly.md b/RuleDocumentation/UseCmdletCorrectly.md → docs/Rules/UseCmdletCorrectly.md
diff --git a/RuleDocumentation/UseCompatibleCmdlets.md → docs/Rules/UseCompatibleCmdlets.md b/RuleDocumentation/UseCompatibleCmdlets.md → docs/Rules/UseCompatibleCmdlets.md
diff --git a/RuleDocumentation/UseCompatibleCommands.md → docs/Rules/UseCompatibleCommands.md b/RuleDocumentation/UseCompatibleCommands.md → docs/Rules/UseCompatibleCommands.md
diff --git a/RuleDocumentation/UseCompatibleSyntax.md → docs/Rules/UseCompatibleSyntax.md b/RuleDocumentation/UseCompatibleSyntax.md → docs/Rules/UseCompatibleSyntax.md
diff --git a/RuleDocumentation/UseCompatibleTypes.md → docs/Rules/UseCompatibleTypes.md b/RuleDocumentation/UseCompatibleTypes.md → docs/Rules/UseCompatibleTypes.md
diff --git a/...Documentation/UseConsistentIndentation.md → docs/Rules/UseConsistentIndentation.md b/...Documentation/UseConsistentIndentation.md → docs/Rules/UseConsistentIndentation.md
diff --git a/RuleDocumentation/UseConsistentWhitespace.md → docs/Rules/UseConsistentWhitespace.md b/RuleDocumentation/UseConsistentWhitespace.md → docs/Rules/UseConsistentWhitespace.md
diff --git a/RuleDocumentation/UseCorrectCasing.md → docs/Rules/UseCorrectCasing.md b/RuleDocumentation/UseCorrectCasing.md → docs/Rules/UseCorrectCasing.md
diff --git a/...ion/UseDeclaredVarsMoreThanAssignments.md → ...les/UseDeclaredVarsMoreThanAssignments.md b/...ion/UseDeclaredVarsMoreThanAssignments.md → ...les/UseDeclaredVarsMoreThanAssignments.md
diff --git a/...tion/UseLiteralInitializerForHashtable.md → ...ules/UseLiteralInitializerForHashtable.md b/...tion/UseLiteralInitializerForHashtable.md → ...ules/UseLiteralInitializerForHashtable.md
diff --git a/RuleDocumentation/UseOutputTypeCorrectly.md → docs/Rules/UseOutputTypeCorrectly.md b/RuleDocumentation/UseOutputTypeCorrectly.md → docs/Rules/UseOutputTypeCorrectly.md
diff --git a/RuleDocumentation/UsePSCredentialType.md → docs/Rules/UsePSCredentialType.md b/RuleDocumentation/UsePSCredentialType.md → docs/Rules/UsePSCredentialType.md
diff --git a/...tion/UseProcessBlockForPipelineCommand.md → ...ules/UseProcessBlockForPipelineCommand.md b/...tion/UseProcessBlockForPipelineCommand.md → ...ules/UseProcessBlockForPipelineCommand.md
diff --git a/...ShouldProcessForStateChangingFunctions.md → ...ShouldProcessForStateChangingFunctions.md b/...ShouldProcessForStateChangingFunctions.md → ...ShouldProcessForStateChangingFunctions.md
diff --git a/RuleDocumentation/UseSingularNouns.md → docs/Rules/UseSingularNouns.md b/RuleDocumentation/UseSingularNouns.md → docs/Rules/UseSingularNouns.md
diff --git a/...Documentation/UseSupportsShouldProcess.md → docs/Rules/UseSupportsShouldProcess.md b/...Documentation/UseSupportsShouldProcess.md → docs/Rules/UseSupportsShouldProcess.md
diff --git a/...umentation/UseToExportFieldsInManifest.md → docs/Rules/UseToExportFieldsInManifest.md b/...umentation/UseToExportFieldsInManifest.md → docs/Rules/UseToExportFieldsInManifest.md
diff --git a/...cumentation/UseUTF8EncodingForHelpFile.md → docs/Rules/UseUTF8EncodingForHelpFile.md b/...cumentation/UseUTF8EncodingForHelpFile.md → docs/Rules/UseUTF8EncodingForHelpFile.md
diff --git a/...on/UseUsingScopeModifierInNewRunspaces.md → ...es/UseUsingScopeModifierInNewRunspaces.md b/...on/UseUsingScopeModifierInNewRunspaces.md → ...es/UseUsingScopeModifierInNewRunspaces.md