PSScriptAnalyzer 1.22.0 changes

MicrosoftDocs · Feb 13, 2024 · 9d428ae · 9d428ae
1 parent e71b302
commit 9d428ae
Show file tree

Hide file tree

Showing 70 changed files with 149 additions and 74 deletions.
diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AlignAssignmentStatement.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AlignAssignmentStatement.md
@@ -1,6 +1,6 @@
 ---
 description: Align assignment statement
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: AlignAssignmentStatement

diff --git a/...ce/docs-conceptual/PSScriptAnalyzer/Rules/AvoidAssignmentToAutomaticVariable.md b/...ce/docs-conceptual/PSScriptAnalyzer/Rules/AvoidAssignmentToAutomaticVariable.md
@@ -1,6 +1,6 @@
 ---
 description: Changing automatic variables might have undesired side effects
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: AvoidAssignmentToAutomaticVariable

diff --git a/...ocs-conceptual/PSScriptAnalyzer/Rules/AvoidDefaultValueForMandatoryParameter.md b/...ocs-conceptual/PSScriptAnalyzer/Rules/AvoidDefaultValueForMandatoryParameter.md
@@ -1,6 +1,6 @@
 ---
 description: Avoid Default Value For Mandatory Parameter
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: AvoidDefaultValueForMandatoryParameter

diff --git a/...ence/docs-conceptual/PSScriptAnalyzer/Rules/AvoidDefaultValueSwitchParameter.md b/...ence/docs-conceptual/PSScriptAnalyzer/Rules/AvoidDefaultValueSwitchParameter.md
@@ -1,6 +1,6 @@
 ---
 description: Switch Parameters Should Not Default To True
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: AvoidDefaultValueSwitchParameter

diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidExclaimOperator.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidExclaimOperator.md
@@ -0,0 +1,44 @@
+---
+description: Avoid exclaim operator
+ms.custom: PSSA v1.22.0
+ms.date: 06/14/2023
+ms.topic: reference
+title: AvoidExclaimOperator
+---
+# AvoidExclaimOperator
+**Severity Level: Warning**
+
+## Description
+
+The negation operator `!` should not be used for readability purposes. Use `-not` instead.
+
+**Note**: This rule is not enabled by default. The user needs to enable it through settings.
+
+## How to Fix
+
+## Example
+### Wrong：
+```PowerShell
+$MyVar = !$true
+```
+
+### Correct:
+```PowerShell
+$MyVar = -not $true
+```
+
+## Configuration
+
+```powershell
+Rules = @{
+    PSAvoidExclaimOperator  = @{
+        Enable = $true
+    }
+}
+```
+
+### Parameters
+
+#### Enable: bool (Default value is `$false`)
+
+Enable or disable the rule during ScriptAnalyzer invocation.
diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalAliases.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalAliases.md
@@ -1,6 +1,6 @@
 ---
 description: Avoid global aliases.
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: AvoidGlobalAliases

diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalFunctions.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalFunctions.md
@@ -1,6 +1,6 @@
 ---
 description: Avoid global functions and aliases
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: AvoidGlobalFunctions

diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalVars.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalVars.md
@@ -1,6 +1,6 @@
 ---
 description: No Global Variables
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: AvoidGlobalVars

diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidInvokingEmptyMembers.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidInvokingEmptyMembers.md
@@ -1,6 +1,6 @@
 ---
 description: Avoid Invoking Empty Members
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: AvoidInvokingEmptyMembers

diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidLongLines.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidLongLines.md
@@ -1,6 +1,6 @@
 ---
 description: Avoid long lines
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: AvoidLongLines

diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidMultipleTypeAttributes.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidMultipleTypeAttributes.md
@@ -1,6 +1,6 @@
 ---
 description: Avoid multiple type specifiers on parameters.
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: AvoidMultipleTypeAttributes

diff --git a/.../docs-conceptual/PSScriptAnalyzer/Rules/AvoidNullOrEmptyHelpMessageAttribute.md b/.../docs-conceptual/PSScriptAnalyzer/Rules/AvoidNullOrEmptyHelpMessageAttribute.md
@@ -1,6 +1,6 @@
 ---
 description: Avoid using null or empty HelpMessage parameter attribute.
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: AvoidNullOrEmptyHelpMessageAttribute

diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidOverwritingBuiltInCmdlets.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidOverwritingBuiltInCmdlets.md
@@ -1,6 +1,6 @@
 ---
 description: Avoid overwriting built in cmdlets
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: AvoidOverwritingBuiltInCmdlets

diff --git a/...ence/docs-conceptual/PSScriptAnalyzer/Rules/AvoidSemicolonsAsLineTerminators.md b/...ence/docs-conceptual/PSScriptAnalyzer/Rules/AvoidSemicolonsAsLineTerminators.md
@@ -1,6 +1,6 @@
 ---
 description: Avoid semicolons as line terminators
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: AvoidSemicolonsAsLineTerminators

diff --git a/...rence/docs-conceptual/PSScriptAnalyzer/Rules/AvoidShouldContinueWithoutForce.md b/...rence/docs-conceptual/PSScriptAnalyzer/Rules/AvoidShouldContinueWithoutForce.md
@@ -1,6 +1,6 @@
 ---
 description: Avoid Using ShouldContinue Without Boolean Force Parameter
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: AvoidShouldContinueWithoutForce

diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidTrailingWhitespace.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidTrailingWhitespace.md
@@ -1,6 +1,6 @@
 ---
 description: Avoid trailing whitespace
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: AvoidTrailingWhitespace

diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingBrokenHashAlgorithms.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingBrokenHashAlgorithms.md
@@ -1,6 +1,6 @@
 ---
 description: Avoid using broken hash algorithms
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: AvoidUsingBrokenHashAlgorithms

diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingCmdletAliases.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingCmdletAliases.md
@@ -1,6 +1,6 @@
 ---
 description: Avoid Using Cmdlet Aliases or omitting the 'Get-' prefix.
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: AvoidUsingCmdletAliases

diff --git a/...rence/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingComputerNameHardcoded.md b/...rence/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingComputerNameHardcoded.md
@@ -1,6 +1,6 @@
 ---
 description: Avoid Using ComputerName Hardcoded
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: AvoidUsingComputerNameHardcoded

diff --git a/...nceptual/PSScriptAnalyzer/Rules/AvoidUsingConvertToSecureStringWithPlainText.md b/...nceptual/PSScriptAnalyzer/Rules/AvoidUsingConvertToSecureStringWithPlainText.md
@@ -1,6 +1,6 @@
 ---
 description: Avoid Using SecureString With Plain Text
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: AvoidUsingConvertToSecureStringWithPlainText

diff --git a/...ce/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingDeprecatedManifestFields.md b/...ce/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingDeprecatedManifestFields.md
@@ -1,6 +1,6 @@
 ---
 description: Avoid Using Deprecated Manifest Fields
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: AvoidUsingDeprecatedManifestFields

diff --git a/...cs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingDoubleQuotesForConstantString.md b/...cs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingDoubleQuotesForConstantString.md
@@ -1,6 +1,6 @@
 ---
 description: Avoid using double quotes if the string is constant.
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: AvoidUsingDoubleQuotesForConstantString

diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingEmptyCatchBlock.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingEmptyCatchBlock.md
@@ -1,6 +1,6 @@
 ---
 description: Avoid Using Empty Catch Block
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: AvoidUsingEmptyCatchBlock

diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingInvokeExpression.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingInvokeExpression.md
@@ -1,6 +1,6 @@
 ---
 description: Avoid Using Invoke-Expression
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: AvoidUsingInvokeExpression

diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingPlainTextForPassword.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingPlainTextForPassword.md
@@ -1,6 +1,6 @@
 ---
 description: Avoid Using Plain Text For Password Parameter
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: AvoidUsingPlainTextForPassword

diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingPositionalParameters.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingPositionalParameters.md
@@ -1,6 +1,6 @@
 ---
 description: Avoid Using Positional Parameters
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: AvoidUsingPositionalParameters
@@ -24,7 +24,7 @@ supplied. A simple example where the risk of using positional parameters is negl
 
 ```powershell
 Rules = @{
-    AvoidUsingPositionalParameters = @{
+    PSAvoidUsingPositionalParameters = @{
         CommandAllowList = 'az', 'Join-Path'
         Enable           = $true
     }
@@ -33,7 +33,7 @@ Rules = @{
 
 ### Parameters
 
-#### AvoidUsingPositionalParameters: string[] (Default value is 'az')
+#### CommandAllowList: string[] (Default value is 'az')
 
 Commands to be excluded from this rule. `az` is excluded by default because starting with version 2.40.0 the entrypoint of the AZ CLI became an `az.ps1` script but this script does not have any named parameters and just passes them on using `$args` as is to the Python process that it starts, therefore it is still a CLI and not a PowerShell command.
 

diff --git a/...e/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingUsernameAndPasswordParams.md b/...e/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingUsernameAndPasswordParams.md
@@ -1,6 +1,6 @@
 ---
 description: Avoid Using Username and Password Parameters
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: AvoidUsingUsernameAndPasswordParams

diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingWMICmdlet.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingWMICmdlet.md
@@ -1,6 +1,6 @@
 ---
 description: Avoid Using Get-WMIObject, Remove-WMIObject, Invoke-WmiMethod, Register-WmiEvent, Set-WmiInstance
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: AvoidUsingWMICmdlet

diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingWriteHost.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingWriteHost.md
@@ -1,6 +1,6 @@
 ---
 description: Avoid Using Write-Host
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: AvoidUsingWriteHost

diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCDscExamplesPresent.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCDscExamplesPresent.md
@@ -1,6 +1,6 @@
 ---
 description: DSC examples are present
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: DSCDscExamplesPresent

diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCDscTestsPresent.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCDscTestsPresent.md
@@ -1,6 +1,6 @@
 ---
 description: Dsc tests are present
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: DSCDscTestsPresent

diff --git a/.../docs-conceptual/PSScriptAnalyzer/Rules/DSCReturnCorrectTypesForDSCFunctions.md b/.../docs-conceptual/PSScriptAnalyzer/Rules/DSCReturnCorrectTypesForDSCFunctions.md
@@ -1,6 +1,6 @@
 ---
 description: Return Correct Types For DSC Functions
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: DSCReturnCorrectTypesForDSCFunctions

diff --git a/...nce/docs-conceptual/PSScriptAnalyzer/Rules/DSCStandardDSCFunctionsInResource.md b/...nce/docs-conceptual/PSScriptAnalyzer/Rules/DSCStandardDSCFunctionsInResource.md
@@ -1,6 +1,6 @@
 ---
 description: Use Standard Get/Set/Test TargetResource functions in DSC Resource
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: DSCStandardDSCFunctionsInResource

diff --git a/...s-conceptual/PSScriptAnalyzer/Rules/DSCUseIdenticalMandatoryParametersForDSC.md b/...s-conceptual/PSScriptAnalyzer/Rules/DSCUseIdenticalMandatoryParametersForDSC.md
@@ -1,6 +1,6 @@
 ---
 description: Use identical mandatory parameters for DSC Get/Test/Set TargetResource functions
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: DSCUseIdenticalMandatoryParametersForDSC

diff --git a/...rence/docs-conceptual/PSScriptAnalyzer/Rules/DSCUseIdenticalParametersForDSC.md b/...rence/docs-conceptual/PSScriptAnalyzer/Rules/DSCUseIdenticalParametersForDSC.md
@@ -1,6 +1,6 @@
 ---
 description: Use Identical Parameters For DSC Test and Set Functions
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: DSCUseIdenticalParametersForDSC

diff --git a/...nce/docs-conceptual/PSScriptAnalyzer/Rules/DSCUseVerboseMessageInDSCResource.md b/...nce/docs-conceptual/PSScriptAnalyzer/Rules/DSCUseVerboseMessageInDSCResource.md
@@ -1,6 +1,6 @@
 ---
 description: Use verbose message in DSC resource
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: DSCUseVerboseMessageInDSCResource

diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/MisleadingBacktick.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/MisleadingBacktick.md
@@ -1,6 +1,6 @@
 ---
 description: Misleading Backtick
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: MisleadingBacktick

diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/MissingModuleManifestField.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/MissingModuleManifestField.md
@@ -1,6 +1,6 @@
 ---
 description: Module Manifest Fields
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: MissingModuleManifestField

diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/PlaceCloseBrace.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/PlaceCloseBrace.md
@@ -1,6 +1,6 @@
 ---
 description: Place close braces
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: PlaceCloseBrace

diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/PlaceOpenBrace.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/PlaceOpenBrace.md
@@ -1,6 +1,6 @@
 ---
 description: Place open braces consistently
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: PlaceOpenBrace

diff --git a/...e/docs-conceptual/PSScriptAnalyzer/Rules/PossibleIncorrectComparisonWithNull.md b/...e/docs-conceptual/PSScriptAnalyzer/Rules/PossibleIncorrectComparisonWithNull.md
@@ -1,6 +1,6 @@
 ---
 description: Null Comparison
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: PossibleIncorrectComparisonWithNull

diff --git a/...conceptual/PSScriptAnalyzer/Rules/PossibleIncorrectUsageOfAssignmentOperator.md b/...conceptual/PSScriptAnalyzer/Rules/PossibleIncorrectUsageOfAssignmentOperator.md
@@ -1,6 +1,6 @@
 ---
 description: Equal sign is not an assignment operator. Did you mean the equality operator \'-eq\'?
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: PossibleIncorrectUsageOfAssignmentOperator

diff --git a/...onceptual/PSScriptAnalyzer/Rules/PossibleIncorrectUsageOfRedirectionOperator.md b/...onceptual/PSScriptAnalyzer/Rules/PossibleIncorrectUsageOfRedirectionOperator.md
@@ -1,6 +1,6 @@
 ---
 description: \'>\' is not a comparison operator. Use \'-gt\' (greater than) or \'-ge\' (greater or equal).
-ms.custom: PSSA v1.21.0
+ms.custom: PSSA v1.22.0
 ms.date: 06/28/2023
 ms.topic: reference
 title: PossibleIncorrectUsageOfRedirectionOperator