From dfdbf4ca7082911ac2be8fb55a76e97de8e195d2 Mon Sep 17 00:00:00 2001 From: Christoph Bergmeister Date: Sat, 3 Mar 2018 13:46:37 +0000 Subject: [PATCH] Remove redundant Readme of RuleDocumentation folder, which is out of date, a maintenance burden and does not provide more useful information other than the severity. Command like Get-ScriptAnalyzerRule are better suited for this --- RuleDocumentation/README.md | 55 ------------------------------------- 1 file changed, 55 deletions(-) delete mode 100644 RuleDocumentation/README.md diff --git a/RuleDocumentation/README.md b/RuleDocumentation/README.md deleted file mode 100644 index 443d5bc26..000000000 --- a/RuleDocumentation/README.md +++ /dev/null @@ -1,55 +0,0 @@ -# PowerShell Script Analyzer Rules - -## Table of Contents - -| Rule | Severity | -|------|----------------------------------| -|[AvoidAlias](./AvoidAlias.md) | Warning | -|[AvoidDefaultTrueValueSwitchParameter](./AvoidDefaultTrueValueSwitchParameter.md) | Warning| -|[AvoidEmptyCatchBlock](./AvoidEmptyCatchBlock.md) | Warning| -|[AvoidGlobalVars](./AvoidGlobalVars.md) | Warning| -|[AvoidInvokingEmptyMembers](./AvoidInvokingEmptyMembers.md) | Warning| -|[AvoidNullOrEmptyHelpMessageAttribute](./AvoidNullOrEmptyHelpMessageAttribute.md) | Warning| -|[AvoidReservedCharInCmdlet](./AvoidReservedCharInCmdlet.md) | Error | -|[AvoidReservedParams](./AvoidReservedParams.md) | Error | -|[AvoidShouldContinueWithoutForce](./AvoidShouldContinueWithoutForce.md) | Warning| -|[AvoidTrapStatement](./AvoidTrapStatement.md) | Warning| -|[AvoidUninitializedVariable](./AvoidUninitializedVariable.md) | Warning| -|[AvoidUsingComputerNameHardcoded](./AvoidUsingComputerNameHardcoded.md) | Error | -|[AvoidUsingConvertToSecureStringWithPlainText](./AvoidUsingConvertToSecureStringWithPlainText.md) | Error | -|[AvoidUsingDeprecatedManifestFields](./AvoidUsingDeprecatedManifestFields.md) | Warning| -|[AvoidUsingFilePath](./AvoidUsingFilePath.md) | Error | -|[AvoidUsingInvokeExpression](./AvoidUsingInvokeExpression.md) | Warning| -|[AvoidUsingPlainTextForPassword](./AvoidUsingPlainTextForPassword.md) | Warning| -|[AvoidUsingPositionalParameters](./AvoidUsingPositionalParameters.md) | Warning| -|[AvoidUsingUsernameAndPasswordParams](./AvoidUsingUsernameAndPasswordParams.md) | Error | -|[AvoidUsingWMICmdlet](./AvoidUsingWMICmdlet.md) | Warning| -|[AvoidUsingWriteHost](./AvoidUsingWriteHost.md) | Warning| -|[DscExamplesPresent](./DscExamplesPresent.md) | Information | -|[DscTestsPresent](./DscTestsPresent.md) | Information | -|[MissingModuleManifestField](./MissingModuleManifestField.md) | Warning| -|[PossibleIncorrectComparisonWithNull](./PossibleIncorrectComparisonWithNull.md) | Warning| -|[ProvideCommentHelp](./ProvideCommentHelp.md) | Information| -|[ProvideDefaultParameterValue](./ProvideDefaultParameterValue.md) | Warning| -|[ProvideVerboseMessage](./ProvideVerboseMessage.md) | Information | -|[ReturnCorrectTypeDSCFunctions](./ReturnCorrectTypeDSCFunctions.md) | Information | -|[UseApprovedVerbs](./UseApprovedVerbs.md) | Warning| -|[UseBOMForUnicodeEncodedFile](./UseBOMForUnicodeEncodedFile.md) | Warning| -|[UseCmdletCorrectly](./UseCmdletCorrectly.md) | Warning| -|[UseDeclaredVarsMoreThanAssignments](./UseDeclaredVarsMoreThanAssignments.md) | Warning| -|[UseIdenticalMandatoryParametersDSC](./UseIdenticalMandatoryParametersDSC.md) | Error | -|[UseIdenticalParametersDSC](./UseIdenticalParametersDSC.md) | Error | -|[UseLiteralInitializerForHashtable](./UseLiteralInitializerForHashtable.md) | Warning | -|[UseOutputTypeCorrectly](./UseOutputTypeCorrectly.md) | Information| -|[UsePSCredentialType](./UsePSCredentialType.md) | Warning| -|[UseShouldProcessCorrectly](./UseShouldProcessCorrectly.md) | Warning| -|[UseShouldProcessForStateChangingFunctions](./UseShouldProcessForStateChangingFunctions.md) | Warning| -|[UseSupportsShouldProcess](./UseSupportsShouldProcess.md) | Warning| -|[UseSingularNouns](./UseSingularNouns.md) | Warning| -|[UseStandardDSCFunctionsInResource](./UseStandardDSCFunctionsInResource.md) | Error | -|[UseToExportFieldsInManifest](./UseToExportFieldsInManifest.md) | Warning| -|[UseCompatibleCmdlets](./UseCompatibleCmdlets.md) | Warning| -|[PlaceOpenBrace](./PlaceOpenBrace.md) | Warning| -|[PlaceCloseBrace](./PlaceCloseBrace.md) | Warning| -|[UseConsistentIndentation](./UseConsistentIndentation.md) | Warning| -|[UseConsistentWhitespace](./UseConsistentWhitespace.md) | Warning|