PowerShell · bergmeister · Jun 5, 2018 · May 6, 2018 · May 14, 2018 · May 16, 2018
diff --git a/Engine/Settings/PSGallery.psd1 b/Engine/Settings/PSGallery.psd1
@@ -21,7 +21,6 @@
                    'PSAvoidUsingConvertToSecureStringWithPlainText',
                    'PSUsePSCredentialType',
                    'PSAvoidUsingUserNameAndPasswordParams',
-                   'PSAvoidUsingFilePath',
                    'PSDSC*'
                    )
 }
diff --git a/Engine/Settings/ScriptSecurity.psd1 b/Engine/Settings/ScriptSecurity.psd1
@@ -3,6 +3,5 @@
                    'PSAvoidUsingComputerNameHardcoded',
                    'PSAvoidUsingConvertToSecureStringWithPlainText',
                    'PSUsePSCredentialType',
-                   'PSAvoidUsingUserNameAndPasswordParams',
-                   'PSAvoidUsingFilePath')
+                   'PSAvoidUsingUserNameAndPasswordParams')
 }
diff --git a/PowerShellBestPractices.md b/PowerShellBestPractices.md
diff --git a/README.md b/README.md
@@ -158,16 +158,10 @@ Pester-based ScriptAnalyzer Tests are located in `path/to/PSScriptAnalyzer/Tests
 
 * Ensure [Pester 4.3.1](https://www.powershellgallery.com/packages/Pester/4.3.1) is installed
 * Copy `path/to/PSScriptAnalyzer/out/PSScriptAnalyzer` to a folder in `PSModulePath`
-* Go the Tests folder in your local repository
-* Run Engine Tests:
+* In the root folder of your local repository, run:
 ``` PowerShell
-cd /path/to/PSScriptAnalyzer/Tests/Engine
-Invoke-Pester
-```
-* Run Tests for Built-in rules:
-``` PowerShell
-cd /path/to/PSScriptAnalyzer/Tests/Rules
-Invoke-Pester
+$testScripts = ".\Tests\Engine",".\Tests\Rules",".\Tests\Documentation"
+Invoke-Pester -Script $testScripts
 ```
 
 [Back to ToC](#table-of-contents)

diff --git a/RuleDocumentation/AvoidGlobalAliases.md b/RuleDocumentation/AvoidGlobalAliases.md
@@ -4,11 +4,12 @@
 
 ## Description
 
-Globally scoped aliases override existing aliases within the sessions with matching names. This name collision can cause difficult to debug issues for consumers of modules and scripts.  
-
+Globally scoped aliases override existing aliases within the sessions with matching names. This name collision can cause difficult to debug issues for consumers of modules and scripts.
 
 To understand more about scoping, see ```Get-Help about_Scopes```.
 
+**NOTE** This rule is not available in PowerShell version 3 and 4 due to the `StaticParameterBinder.BindCommand` API that the rule uses internally.
+
 ## How
 
 Use other scope modifiers for new aliases.

diff --git a/RuleDocumentation/AvoidTrapStatement.md b/RuleDocumentation/AvoidTrapStatement.md
diff --git a/RuleDocumentation/AvoidUninitializedVariable.md b/RuleDocumentation/AvoidUninitializedVariable.md
diff --git a/RuleDocumentation/AvoidUsingFilePath.md b/RuleDocumentation/AvoidUsingFilePath.md
diff --git a/RuleDocumentation/DscExamplesPresent.md → RuleDocumentation/DSCDscExamplesPresent.md b/RuleDocumentation/DscExamplesPresent.md → RuleDocumentation/DSCDscExamplesPresent.md
diff --git a/RuleDocumentation/DscTestsPresent.md → RuleDocumentation/DSCDscTestsPresent.md b/RuleDocumentation/DscTestsPresent.md → RuleDocumentation/DSCDscTestsPresent.md
diff --git a/...tion/ReturnCorrectTypesForDSCFunctions.md → ...n/DSCReturnCorrectTypesForDSCFunctions.md b/...tion/ReturnCorrectTypesForDSCFunctions.md → ...n/DSCReturnCorrectTypesForDSCFunctions.md
diff --git a/...ntation/StandardDSCFunctionsInResource.md → ...tion/DSCStandardDSCFunctionsInResource.md b/...ntation/StandardDSCFunctionsInResource.md → ...tion/DSCStandardDSCFunctionsInResource.md
diff --git a/.../UseIdenticalMandatoryParametersForDSC.md → ...CUseIdenticalMandatoryParametersForDSC.md b/.../UseIdenticalMandatoryParametersForDSC.md → ...CUseIdenticalMandatoryParametersForDSC.md
diff --git a/...mentation/UseIdenticalParametersForDSC.md → ...tation/DSCUseIdenticalParametersForDSC.md b/...mentation/UseIdenticalParametersForDSC.md → ...tation/DSCUseIdenticalParametersForDSC.md
diff --git a/...ntation/UseVerboseMessageInDSCResource.md → ...tion/DSCUseVerboseMessageInDSCResource.md b/...ntation/UseVerboseMessageInDSCResource.md → ...tion/DSCUseVerboseMessageInDSCResource.md
diff --git a/...sibleIncorrectUsageOAssignmentOperator.md → ...ibleIncorrectUsageOfAssignmentOperator.md b/...sibleIncorrectUsageOAssignmentOperator.md → ...ibleIncorrectUsageOfAssignmentOperator.md
diff --git a/RuleDocumentation/README.md b/RuleDocumentation/README.md
@@ -0,0 +1,63 @@
+# PSScriptAnalyzer Rules
+
+## Table of Contents
+
+| Rule | Severity | Configurable |
+|------|----------------------------------|--------------|
+|[AlignAssignmentStatement](./AlignAssignmentStatement.md) | Warning | |
+|[AvoidAssignmentToAutomaticVariable](./AvoidAssignmentToAutomaticVariable.md) | Warning | |
+|[AvoidDefaultValueForMandatoryParameter](./AvoidDefaultValueForMandatoryParameter.md) | Warning | |
+|[AvoidDefaultValueSwitchParameter](./AvoidDefaultValueSwitchParameter.md) | Warning | |
+|[AvoidGlobalAliases<sup>*</sup>](./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 | |
+|[AvoidTrailingWhitespace](./AvoidTrailingWhitespace.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 | |
+|[PossibleIncorrectUsageOfAssignmentOperator](./PossibleIncorrectUsageOfAssignmentOperator.md) | Warning | |
+|[PossibleIncorrectUsageOfRedirectionOperator](./PossibleIncorrectUsageOfRedirectionOperator.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<sup>*</sup>](./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 | |
+
+<sup>*</sup> Rule is not available on all PowerShell versions, editions and/or OS platforms. See the rule's documentation for details.
diff --git a/RuleDocumentation/UseSingularNouns.md b/RuleDocumentation/UseSingularNouns.md
@@ -6,6 +6,8 @@
 
 PowerShell team best practices state cmdlets should use singular nouns and not plurals.
 
+**NOTE** This rule is not available in PowerShell Core due to the PluralizationService API that the rule uses internally.
+
 ## How
 
 Change plurals to singular.
@@ -17,7 +19,7 @@ Change plurals to singular.
 ``` PowerShell
 function Get-Files
 {
-	...
+    ...
 }
 ```
 
@@ -26,6 +28,6 @@ function Get-Files
 ``` PowerShell
 function Get-File
 {
-	...
+    ...
 }
 ```
diff --git a/Rules/Strings.Designer.cs b/Rules/Strings.Designer.cs