Skip to content

Latest commit

 

History

History
 
 

Rules

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
AlignAssignmentStatement.md
AlignAssignmentStatement.md
 
 
AvoidAssignmentToAutomaticVariable.md
AvoidAssignmentToAutomaticVariable.md
 
 
AvoidDefaultValueForMandatoryParameter.md
AvoidDefaultValueForMandatoryParameter.md
 
 
AvoidDefaultValueSwitchParameter.md
AvoidDefaultValueSwitchParameter.md
 
 
AvoidExclaimOperator.md
AvoidExclaimOperator.md
 
 
AvoidGlobalAliases.md
AvoidGlobalAliases.md
 
 
AvoidGlobalFunctions.md
AvoidGlobalFunctions.md
 
 
AvoidGlobalVars.md
AvoidGlobalVars.md
 
 
AvoidInvokingEmptyMembers.md
AvoidInvokingEmptyMembers.md
 
 
AvoidLongLines.md
AvoidLongLines.md
 
 
AvoidMultipleTypeAttributes.md
AvoidMultipleTypeAttributes.md
 
 
AvoidNullOrEmptyHelpMessageAttribute.md
AvoidNullOrEmptyHelpMessageAttribute.md
 
 
AvoidOverwritingBuiltInCmdlets.md
AvoidOverwritingBuiltInCmdlets.md
 
 
AvoidSemicolonsAsLineTerminators.md
AvoidSemicolonsAsLineTerminators.md
 
 
AvoidShouldContinueWithoutForce.md
AvoidShouldContinueWithoutForce.md
 
 
AvoidTrailingWhitespace.md
AvoidTrailingWhitespace.md
 
 
AvoidUsingBrokenHashAlgorithms.md
AvoidUsingBrokenHashAlgorithms.md
 
 
AvoidUsingCmdletAliases.md
AvoidUsingCmdletAliases.md
 
 
AvoidUsingComputerNameHardcoded.md
AvoidUsingComputerNameHardcoded.md
 
 
AvoidUsingConvertToSecureStringWithPlainText.md
AvoidUsingConvertToSecureStringWithPlainText.md
 
 
AvoidUsingDeprecatedManifestFields.md
AvoidUsingDeprecatedManifestFields.md
 
 
AvoidUsingDoubleQuotesForConstantString.md
AvoidUsingDoubleQuotesForConstantString.md
 
 
AvoidUsingEmptyCatchBlock.md
AvoidUsingEmptyCatchBlock.md
 
 
AvoidUsingInvokeExpression.md
AvoidUsingInvokeExpression.md
 
 
AvoidUsingPlainTextForPassword.md
AvoidUsingPlainTextForPassword.md
 
 
AvoidUsingPositionalParameters.md
AvoidUsingPositionalParameters.md
 
 
AvoidUsingUsernameAndPasswordParams.md
AvoidUsingUsernameAndPasswordParams.md
 
 
AvoidUsingWMICmdlet.md
AvoidUsingWMICmdlet.md
 
 
AvoidUsingWriteHost.md
AvoidUsingWriteHost.md
 
 
DSCDscExamplesPresent.md
DSCDscExamplesPresent.md
 
 
DSCDscTestsPresent.md
DSCDscTestsPresent.md
 
 
DSCReturnCorrectTypesForDSCFunctions.md
DSCReturnCorrectTypesForDSCFunctions.md
 
 
DSCStandardDSCFunctionsInResource.md
DSCStandardDSCFunctionsInResource.md
 
 
DSCUseIdenticalMandatoryParametersForDSC.md
DSCUseIdenticalMandatoryParametersForDSC.md
 
 
DSCUseIdenticalParametersForDSC.md
DSCUseIdenticalParametersForDSC.md
 
 
DSCUseVerboseMessageInDSCResource.md
DSCUseVerboseMessageInDSCResource.md
 
 
MisleadingBacktick.md
MisleadingBacktick.md
 
 
MissingModuleManifestField.md
MissingModuleManifestField.md
 
 
PlaceCloseBrace.md
PlaceCloseBrace.md
 
 
PlaceOpenBrace.md
PlaceOpenBrace.md
 
 
PossibleIncorrectComparisonWithNull.md
PossibleIncorrectComparisonWithNull.md
 
 
PossibleIncorrectUsageOfAssignmentOperator.md
PossibleIncorrectUsageOfAssignmentOperator.md
 
 
PossibleIncorrectUsageOfRedirectionOperator.md
PossibleIncorrectUsageOfRedirectionOperator.md
 
 
ProvideCommentHelp.md
ProvideCommentHelp.md
 
 
README.md
README.md
 
 
ReservedCmdletChar.md
ReservedCmdletChar.md
 
 
ReservedParams.md
ReservedParams.md
 
 
ReviewUnusedParameter.md
ReviewUnusedParameter.md
 
 
ShouldProcess.md
ShouldProcess.md
 
 
UseApprovedVerbs.md
UseApprovedVerbs.md
 
 
UseBOMForUnicodeEncodedFile.md
UseBOMForUnicodeEncodedFile.md
 
 
UseCmdletCorrectly.md
UseCmdletCorrectly.md
 
 
UseCompatibleCmdlets.md
UseCompatibleCmdlets.md
 
 
UseCompatibleCommands.md
UseCompatibleCommands.md
 
 
UseCompatibleSyntax.md
UseCompatibleSyntax.md
 
 
UseCompatibleTypes.md
UseCompatibleTypes.md
 
 
UseConsistentIndentation.md
UseConsistentIndentation.md
 
 
UseConsistentWhitespace.md
UseConsistentWhitespace.md
 
 
UseCorrectCasing.md
UseCorrectCasing.md
 
 
UseDeclaredVarsMoreThanAssignments.md
UseDeclaredVarsMoreThanAssignments.md
 
 
UseLiteralInitializerForHashtable.md
UseLiteralInitializerForHashtable.md
 
 
UseOutputTypeCorrectly.md
UseOutputTypeCorrectly.md
 
 
UsePSCredentialType.md
UsePSCredentialType.md
 
 
UseProcessBlockForPipelineCommand.md
UseProcessBlockForPipelineCommand.md
 
 
UseShouldProcessForStateChangingFunctions.md
UseShouldProcessForStateChangingFunctions.md
 
 
UseSingularNouns.md
UseSingularNouns.md
 
 
UseSupportsShouldProcess.md
UseSupportsShouldProcess.md
 
 
UseToExportFieldsInManifest.md
UseToExportFieldsInManifest.md
 
 
UseUTF8EncodingForHelpFile.md
UseUTF8EncodingForHelpFile.md
 
 
UseUsingScopeModifierInNewRunspaces.md
UseUsingScopeModifierInNewRunspaces.md
 
 

README.md

description ms.custom ms.date ms.topic title
List of PSScriptAnalyzer rules
PSSA v1.21.0
06/28/2023
reference
List of PSScriptAnalyzer rules

PSScriptAnalyzer Rules

The PSScriptAnalyzer contains the following rule definitions.

Rule Severity Enabled by default Configurable
AlignAssignmentStatement Warning No Yes
AvoidAssignmentToAutomaticVariable Warning Yes
AvoidDefaultValueForMandatoryParameter Warning Yes
AvoidDefaultValueSwitchParameter Warning Yes
AvoidExclaimOperator Warning No
AvoidGlobalAliases1 Warning Yes
AvoidGlobalFunctions Warning Yes
AvoidGlobalVars Warning Yes
AvoidInvokingEmptyMembers Warning Yes
AvoidLongLines Warning No Yes
AvoidMultipleTypeAttributes1 Warning Yes
AvoidNullOrEmptyHelpMessageAttribute Warning Yes
AvoidOverwritingBuiltInCmdlets Warning Yes Yes
AvoidSemicolonsAsLineTerminators Warning No
AvoidShouldContinueWithoutForce Warning Yes
AvoidTrailingWhitespace Warning Yes
AvoidUsingBrokenHashAlgorithms Warning Yes
AvoidUsingCmdletAliases Warning Yes Yes2
AvoidUsingComputerNameHardcoded Error Yes
AvoidUsingConvertToSecureStringWithPlainText Error Yes
AvoidUsingDeprecatedManifestFields Warning Yes
AvoidUsingDoubleQuotesForConstantString Information No
AvoidUsingEmptyCatchBlock Warning Yes
AvoidUsingInvokeExpression Warning Yes
AvoidUsingPlainTextForPassword Warning Yes
AvoidUsingPositionalParameters Warning Yes
AvoidUsingUsernameAndPasswordParams Error Yes
AvoidUsingWMICmdlet Warning Yes
AvoidUsingWriteHost Warning Yes
DSCDscExamplesPresent Information Yes
DSCDscTestsPresent Information Yes
DSCReturnCorrectTypesForDSCFunctions Information Yes
DSCStandardDSCFunctionsInResource Error Yes
DSCUseIdenticalMandatoryParametersForDSC Error Yes
DSCUseIdenticalParametersForDSC Error Yes
DSCUseVerboseMessageInDSCResource Error Yes
MisleadingBacktick Warning Yes
MissingModuleManifestField Warning Yes
PlaceCloseBrace Warning No Yes
PlaceOpenBrace Warning No Yes
PossibleIncorrectComparisonWithNull Warning Yes
PossibleIncorrectUsageOfAssignmentOperator Warning Yes
PossibleIncorrectUsageOfRedirectionOperator Warning Yes
ProvideCommentHelp Information Yes Yes
ReservedCmdletChar Error Yes
ReservedParams Error Yes
ReviewUnusedParameter Warning Yes
ShouldProcess Warning Yes
UseApprovedVerbs Warning Yes
UseBOMForUnicodeEncodedFile Warning Yes
UseCmdletCorrectly Warning Yes
UseCompatibleCmdlets Warning Yes Yes2
UseCompatibleCommands Warning No Yes
UseCompatibleSyntax Warning No Yes
UseCompatibleTypes Warning No Yes
UseConsistentIndentation Warning No Yes
UseConsistentWhitespace Warning No Yes
UseCorrectCasing Information No Yes
UseDeclaredVarsMoreThanAssignments Warning Yes
UseLiteralInitializerForHashtable Warning Yes
UseOutputTypeCorrectly Information Yes
UseProcessBlockForPipelineCommand Warning Yes
UsePSCredentialType Warning Yes
UseShouldProcessForStateChangingFunctions Warning Yes
UseSingularNouns Warning Yes
UseSupportsShouldProcess Warning Yes
UseToExportFieldsInManifest Warning Yes
UseUsingScopeModifierInNewRunspaces Warning Yes
UseUTF8EncodingForHelpFile Warning Yes
  • 1 Rule is not available on all PowerShell versions, editions, or OS platforms. See the rule's documentation for details.
  • 2 The rule a configurable property, but the rule can't be disabled like other configurable rules.