Skip to content

Latest commit

 

History

History
 
 

RuleDocumentation

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
 
 
AvoidGlobalAliases.md
AvoidGlobalAliases.md
 
 
AvoidGlobalFunctions.md
AvoidGlobalFunctions.md
 
 
AvoidGlobalVars.md
AvoidGlobalVars.md
 
 
AvoidInvokingEmptyMembers.md
AvoidInvokingEmptyMembers.md
 
 
AvoidLongLines.md
AvoidLongLines.md
 
 
AvoidNullOrEmptyHelpMessageAttribute.md
AvoidNullOrEmptyHelpMessageAttribute.md
 
 
AvoidOverwritingBuiltInCmdlets.md
AvoidOverwritingBuiltInCmdlets.md
 
 
AvoidShouldContinueWithoutForce.md
AvoidShouldContinueWithoutForce.md
 
 
AvoidTrailingWhitespace.md
AvoidTrailingWhitespace.md
 
 
AvoidUsingCmdletAliases.md
AvoidUsingCmdletAliases.md
 
 
AvoidUsingComputerNameHardcoded.md
AvoidUsingComputerNameHardcoded.md
 
 
AvoidUsingConvertToSecureStringWithPlainText.md
AvoidUsingConvertToSecureStringWithPlainText.md
 
 
AvoidUsingDeprecatedManifestFields.md
AvoidUsingDeprecatedManifestFields.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
 
 

README.md

PSScriptAnalyzer Rules

Table of Contents

Rule Severity Configurable
AlignAssignmentStatement Warning
AvoidAssignmentToAutomaticVariable Warning
AvoidDefaultValueForMandatoryParameter Warning
AvoidDefaultValueSwitchParameter Warning
AvoidGlobalAliases* Warning
AvoidGlobalFunctions Warning
AvoidGlobalVars Warning
AvoidInvokingEmptyMembers Warning
AvoidLongLines Warning
AvoidOverwritingBuiltInCmdlets Warning
AvoidNullOrEmptyHelpMessageAttribute Warning
AvoidShouldContinueWithoutForce Warning
AvoidUsingCmdletAliases Warning Yes
AvoidUsingComputerNameHardcoded Error
AvoidUsingConvertToSecureStringWithPlainText Error
AvoidUsingDeprecatedManifestFields Warning
AvoidUsingEmptyCatchBlock Warning
AvoidUsingInvokeExpression Warning
AvoidUsingPlainTextForPassword Warning
AvoidUsingPositionalParameters Warning
AvoidTrailingWhitespace Warning
AvoidUsingUsernameAndPasswordParams Error
AvoidUsingWMICmdlet Warning
AvoidUsingWriteHost Warning
DSCDscExamplesPresent Information
DSCDscTestsPresent Information
DSCReturnCorrectTypesForDSCFunctions Information
DSCStandardDSCFunctionsInResource Error
DSCUseIdenticalMandatoryParametersForDSC Error
DSCUseIdenticalParametersForDSC Error
DSCUseVerboseMessageInDSCResource Error
MisleadingBacktick Warning
MissingModuleManifestField Warning
PossibleIncorrectComparisonWithNull Warning
PossibleIncorrectUsageOfAssignmentOperator Warning
PossibleIncorrectUsageOfRedirectionOperator Warning
ProvideCommentHelp Information Yes
ReservedCmdletChar Error
ReservedParams Error
ReviewUnusedParameter Warning
ShouldProcess Error
UseApprovedVerbs Warning
UseBOMForUnicodeEncodedFile Warning
UseCmdletCorrectly Warning
UseCorrectCasing Information
UseDeclaredVarsMoreThanAssignments Warning
UseLiteralInitializerForHashtable Warning
UseOutputTypeCorrectly Information
UseProcessBlockForPipelineCommand Warning
UsePSCredentialType Warning
UseShouldProcessForStateChangingFunctions Warning
UseSingularNouns* Warning
UseSupportsShouldProcess Warning
UseToExportFieldsInManifest Warning
UseCompatibleCmdlets Warning Yes
UseCompatibleCommands Warning Yes
UseCompatibleSyntax Warning Yes
UseCompatibleTypes Warning Yes
PlaceOpenBrace Warning Yes
PlaceCloseBrace Warning Yes
UseConsistentIndentation Warning Yes
UseConsistentWhitespace Warning Yes
UseUTF8EncodingForHelpFile Warning

* Rule is not available on all PowerShell versions, editions and/or OS platforms. See the rule's documentation for details.