From feb07a17b2710c1433d81f1996de58c756cd770e Mon Sep 17 00:00:00 2001 From: Christoph Bergmeister Date: Wed, 31 Aug 2022 12:05:39 +0100 Subject: [PATCH 1/6] PSSA 1.21.0 docs changes from PSSA repo --- .../Rules/AlignAssignmentStatement.md | 2 +- .../Rules/AvoidAssignmentToAutomaticVariable.md | 2 +- .../AvoidDefaultValueForMandatoryParameter.md | 2 +- .../Rules/AvoidDefaultValueSwitchParameter.md | 2 +- .../PSScriptAnalyzer/Rules/AvoidGlobalAliases.md | 2 +- .../PSScriptAnalyzer/Rules/AvoidGlobalFunctions.md | 2 +- .../PSScriptAnalyzer/Rules/AvoidGlobalVars.md | 2 +- .../Rules/AvoidInvokingEmptyMembers.md | 2 +- .../PSScriptAnalyzer/Rules/AvoidLongLines.md | 2 +- .../Rules/AvoidMultipleTypeAttributes.md | 14 +++----------- .../Rules/AvoidNullOrEmptyHelpMessageAttribute.md | 2 +- .../Rules/AvoidOverwritingBuiltInCmdlets.md | 2 +- .../Rules/AvoidSemicolonsAsLineTerminators.md | 6 ++---- .../Rules/AvoidShouldContinueWithoutForce.md | 2 +- .../Rules/AvoidTrailingWhitespace.md | 2 +- .../Rules/AvoidUsingCmdletAliases.md | 2 +- .../Rules/AvoidUsingComputerNameHardcoded.md | 2 +- ...AvoidUsingConvertToSecureStringWithPlainText.md | 2 +- .../Rules/AvoidUsingDeprecatedManifestFields.md | 2 +- .../AvoidUsingDoubleQuotesForConstantString.md | 2 +- .../Rules/AvoidUsingEmptyCatchBlock.md | 2 +- .../Rules/AvoidUsingInvokeExpression.md | 2 +- .../Rules/AvoidUsingPlainTextForPassword.md | 2 +- .../Rules/AvoidUsingPositionalParameters.md | 2 +- .../Rules/AvoidUsingUsernameAndPasswordParams.md | 2 +- .../PSScriptAnalyzer/Rules/AvoidUsingWMICmdlet.md | 6 +++--- .../PSScriptAnalyzer/Rules/AvoidUsingWriteHost.md | 2 +- .../Rules/DSCDscExamplesPresent.md | 2 +- .../PSScriptAnalyzer/Rules/DSCDscTestsPresent.md | 2 +- .../Rules/DSCReturnCorrectTypesForDSCFunctions.md | 2 +- .../Rules/DSCStandardDSCFunctionsInResource.md | 2 +- .../DSCUseIdenticalMandatoryParametersForDSC.md | 2 +- .../Rules/DSCUseIdenticalParametersForDSC.md | 2 +- .../Rules/DSCUseVerboseMessageInDSCResource.md | 2 +- .../PSScriptAnalyzer/Rules/MisleadingBacktick.md | 2 +- .../Rules/MissingModuleManifestField.md | 2 +- .../PSScriptAnalyzer/Rules/PlaceCloseBrace.md | 2 +- .../PSScriptAnalyzer/Rules/PlaceOpenBrace.md | 2 +- .../Rules/PossibleIncorrectComparisonWithNull.md | 2 +- .../PossibleIncorrectUsageOfAssignmentOperator.md | 4 ++-- .../PossibleIncorrectUsageOfRedirectionOperator.md | 2 +- .../PSScriptAnalyzer/Rules/ProvideCommentHelp.md | 8 ++++---- .../PSScriptAnalyzer/Rules/README.md | 4 ++-- .../PSScriptAnalyzer/Rules/ReservedCmdletChar.md | 2 +- .../PSScriptAnalyzer/Rules/ReservedParams.md | 2 +- .../Rules/ReviewUnusedParameter.md | 2 +- .../PSScriptAnalyzer/Rules/ShouldProcess.md | 11 +++-------- .../PSScriptAnalyzer/Rules/UseApprovedVerbs.md | 4 ++-- .../Rules/UseBOMForUnicodeEncodedFile.md | 2 +- .../PSScriptAnalyzer/Rules/UseCmdletCorrectly.md | 2 +- .../PSScriptAnalyzer/Rules/UseCompatibleCmdlets.md | 2 +- .../Rules/UseCompatibleCommands.md | 2 +- .../PSScriptAnalyzer/Rules/UseCompatibleSyntax.md | 2 +- .../PSScriptAnalyzer/Rules/UseCompatibleTypes.md | 2 +- .../Rules/UseConsistentIndentation.md | 2 +- .../Rules/UseConsistentWhitespace.md | 2 +- .../PSScriptAnalyzer/Rules/UseCorrectCasing.md | 2 +- .../Rules/UseLiteralInitializerForHashtable.md | 2 +- .../Rules/UseOutputTypeCorrectly.md | 2 +- .../PSScriptAnalyzer/Rules/UsePSCredentialType.md | 2 +- .../Rules/UseProcessBlockForPipelineCommand.md | 2 +- .../UseShouldProcessForStateChangingFunctions.md | 2 +- .../PSScriptAnalyzer/Rules/UseSingularNouns.md | 2 +- .../Rules/UseSupportsShouldProcess.md | 2 +- .../Rules/UseToExportFieldsInManifest.md | 2 +- .../Rules/UseUTF8EncodingForHelpFile.md | 2 +- .../Rules/UseUsingScopeModifierInNewRunspaces.md | 2 +- .../docs-conceptual/PSScriptAnalyzer/overview.md | 2 +- .../PSScriptAnalyzer/Get-ScriptAnalyzerRule.md | 2 +- .../PSScriptAnalyzer/Invoke-Formatter.md | 8 ++++---- .../PSScriptAnalyzer/Invoke-ScriptAnalyzer.md | 4 ++-- .../PSScriptAnalyzer/PSScriptAnalyzer.md | 4 ++-- 72 files changed, 90 insertions(+), 105 deletions(-) diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AlignAssignmentStatement.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AlignAssignmentStatement.md index cb98d7f..9265e53 100644 --- 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.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: AlignAssignmentStatement diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidAssignmentToAutomaticVariable.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidAssignmentToAutomaticVariable.md index e72c2f5..6e51795 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidAssignmentToAutomaticVariable.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidAssignmentToAutomaticVariable.md @@ -1,6 +1,6 @@ --- description: Changing automatic variables might have undesired side effects -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: AvoidAssignmentToAutomaticVariable diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidDefaultValueForMandatoryParameter.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidDefaultValueForMandatoryParameter.md index 756b59c..8ad74a1 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidDefaultValueForMandatoryParameter.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidDefaultValueForMandatoryParameter.md @@ -1,6 +1,6 @@ --- description: Avoid Default Value For Mandatory Parameter -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: AvoidDefaultValueForMandatoryParameter diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidDefaultValueSwitchParameter.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidDefaultValueSwitchParameter.md index 01bd20b..8a79762 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidDefaultValueSwitchParameter.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidDefaultValueSwitchParameter.md @@ -1,6 +1,6 @@ --- description: Switch Parameters Should Not Default To True -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: AvoidDefaultValueSwitchParameter diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalAliases.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalAliases.md index 8ec95d8..8415815 100644 --- 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.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: AvoidGlobalAliases diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalFunctions.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalFunctions.md index 5b5cc47..86870b3 100644 --- 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.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: AvoidGlobalFunctions diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalVars.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalVars.md index 7a6d094..0927c2b 100644 --- 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.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: AvoidGlobalVars diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidInvokingEmptyMembers.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidInvokingEmptyMembers.md index f3e4f7f..45ad729 100644 --- 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.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: AvoidInvokingEmptyMembers diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidLongLines.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidLongLines.md index 4f46074..edc5e30 100644 --- 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.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: AvoidLongLines diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidMultipleTypeAttributes.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidMultipleTypeAttributes.md index f0c25e4..03b6af8 100644 --- 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.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: AvoidMultipleTypeAttributes @@ -12,7 +12,7 @@ title: AvoidMultipleTypeAttributes ## Description Parameters should not have more than one type specifier. Multiple type specifiers on parameters -cause runtime errors. +can cause runtime errors. ## How @@ -28,14 +28,10 @@ function Test-Script [CmdletBinding()] Param ( - [String] - $Param1, - [switch] - [bool] + [int] $Switch ) - ... } ``` @@ -47,12 +43,8 @@ function Test-Script [CmdletBinding()] Param ( - [String] - $Param1, - [switch] $Switch ) - ... } ``` diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidNullOrEmptyHelpMessageAttribute.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidNullOrEmptyHelpMessageAttribute.md index 9f07ddc..fa94592 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidNullOrEmptyHelpMessageAttribute.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidNullOrEmptyHelpMessageAttribute.md @@ -1,6 +1,6 @@ --- description: Avoid using null or empty HelpMessage parameter attribute. -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: AvoidNullOrEmptyHelpMessageAttribute diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidOverwritingBuiltInCmdlets.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidOverwritingBuiltInCmdlets.md index ef3f627..e25b3b5 100644 --- 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.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: AvoidOverwritingBuiltInCmdlets diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidSemicolonsAsLineTerminators.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidSemicolonsAsLineTerminators.md index 09a8a1b..0ce1cbc 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidSemicolonsAsLineTerminators.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidSemicolonsAsLineTerminators.md @@ -1,11 +1,10 @@ --- description: Avoid semicolons as line terminators ms.custom: PSSA v1.21.0 -ms.date: 07/25/2022 +ms.date: 06/15/2022 ms.topic: reference title: AvoidSemicolonsAsLineTerminators --- - # AvoidSemicolonsAsLineTerminators **Severity Level: Warning** @@ -14,8 +13,7 @@ title: AvoidSemicolonsAsLineTerminators Lines should not end with a semicolon. -> [!NOTE] -> This rule is not enabled by default. The user needs to enable it through settings. +**Note**: This rule is not enabled by default. The user needs to enable it through settings. ## Example diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidShouldContinueWithoutForce.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidShouldContinueWithoutForce.md index 7f9a2e4..e19b370 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidShouldContinueWithoutForce.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidShouldContinueWithoutForce.md @@ -1,6 +1,6 @@ --- description: Avoid Using ShouldContinue Without Boolean Force Parameter -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: AvoidShouldContinueWithoutForce diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidTrailingWhitespace.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidTrailingWhitespace.md index 8e172b4..1decf9a 100644 --- 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.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: AvoidTrailingWhitespace diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingCmdletAliases.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingCmdletAliases.md index defe60c..a2c2b01 100644 --- 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.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: AvoidUsingCmdletAliases diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingComputerNameHardcoded.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingComputerNameHardcoded.md index 423f23e..7cf3c6d 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingComputerNameHardcoded.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingComputerNameHardcoded.md @@ -1,6 +1,6 @@ --- description: Avoid Using ComputerName Hardcoded -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: AvoidUsingComputerNameHardcoded diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingConvertToSecureStringWithPlainText.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingConvertToSecureStringWithPlainText.md index c269d26..02e2033 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingConvertToSecureStringWithPlainText.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingConvertToSecureStringWithPlainText.md @@ -1,6 +1,6 @@ --- description: Avoid Using SecureString With Plain Text -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: AvoidUsingConvertToSecureStringWithPlainText diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingDeprecatedManifestFields.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingDeprecatedManifestFields.md index ac42739..9c64d6a 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingDeprecatedManifestFields.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingDeprecatedManifestFields.md @@ -1,6 +1,6 @@ --- description: Avoid Using Deprecated Manifest Fields -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: AvoidUsingDeprecatedManifestFields diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingDoubleQuotesForConstantString.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingDoubleQuotesForConstantString.md index 9d1730f..464f1c0 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingDoubleQuotesForConstantString.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingDoubleQuotesForConstantString.md @@ -1,6 +1,6 @@ --- description: Avoid using double quotes if the string is constant. -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: AvoidUsingDoubleQuotesForConstantString diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingEmptyCatchBlock.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingEmptyCatchBlock.md index a49d8ee..9d675e7 100644 --- 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.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: AvoidUsingEmptyCatchBlock diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingInvokeExpression.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingInvokeExpression.md index eedf812..ba37de8 100644 --- 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.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: AvoidUsingInvokeExpression diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingPlainTextForPassword.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingPlainTextForPassword.md index f2b8478..6f6ba04 100644 --- 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.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: AvoidUsingPlainTextForPassword diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingPositionalParameters.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingPositionalParameters.md index 4c31ede..2c92b6e 100644 --- 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.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: AvoidUsingPositionalParameters diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingUsernameAndPasswordParams.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingUsernameAndPasswordParams.md index f2fc0d2..cb8a6cf 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingUsernameAndPasswordParams.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingUsernameAndPasswordParams.md @@ -1,6 +1,6 @@ --- description: Avoid Using Username and Password Parameters -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: AvoidUsingUsernameAndPasswordParams diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingWMICmdlet.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingWMICmdlet.md index 3a934b2..3adb521 100644 --- 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.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: AvoidUsingWMICmdlet @@ -48,12 +48,12 @@ Change to the equivalent CIM based cmdlet. ```powershell Get-WmiObject -Query 'Select * from Win32_Process where name LIKE "myprocess%"' | Remove-WmiObject -Invoke-WmiMethod ?Class Win32_Process ?Name "Create" ?ArgumentList @{ CommandLine = "notepad.exe" } +Invoke-WmiMethod -Class Win32_Process -Name "Create" -ArgumentList @{ CommandLine = "notepad.exe" } ``` ### Correct ```powershell Get-CimInstance -Query 'Select * from Win32_Process where name LIKE "myprocess%"' | Remove-CIMInstance -Invoke-CimMethod ?ClassName Win32_Process ?MethodName "Create" ?Arguments @{ CommandLine = "notepad.exe" } +Invoke-CimMethod -ClassName Win32_Process -MethodName "Create" -Arguments @{ CommandLine = "notepad.exe" } ``` diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingWriteHost.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingWriteHost.md index 96cf22a..44dc220 100644 --- 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.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: AvoidUsingWriteHost diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCDscExamplesPresent.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCDscExamplesPresent.md index b018208..084eb55 100644 --- 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.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: DSCDscExamplesPresent diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCDscTestsPresent.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCDscTestsPresent.md index 4b1d66f..583a805 100644 --- 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.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: DSCDscTestsPresent diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCReturnCorrectTypesForDSCFunctions.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCReturnCorrectTypesForDSCFunctions.md index 3c9f9eb..2b92d98 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCReturnCorrectTypesForDSCFunctions.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCReturnCorrectTypesForDSCFunctions.md @@ -1,6 +1,6 @@ --- description: Return Correct Types For DSC Functions -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: DSCReturnCorrectTypesForDSCFunctions diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCStandardDSCFunctionsInResource.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCStandardDSCFunctionsInResource.md index dde0f88..843f2d6 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCStandardDSCFunctionsInResource.md +++ b/reference/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.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: DSCStandardDSCFunctionsInResource diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCUseIdenticalMandatoryParametersForDSC.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCUseIdenticalMandatoryParametersForDSC.md index 64a3d73..5f6f021 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCUseIdenticalMandatoryParametersForDSC.md +++ b/reference/docs-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.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: DSCUseIdenticalMandatoryParametersForDSC diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCUseIdenticalParametersForDSC.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCUseIdenticalParametersForDSC.md index 3282278..35d3bb4 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCUseIdenticalParametersForDSC.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCUseIdenticalParametersForDSC.md @@ -1,6 +1,6 @@ --- description: Use Identical Parameters For DSC Test and Set Functions -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: DSCUseIdenticalParametersForDSC diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCUseVerboseMessageInDSCResource.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCUseVerboseMessageInDSCResource.md index b491152..cf58a30 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCUseVerboseMessageInDSCResource.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCUseVerboseMessageInDSCResource.md @@ -1,6 +1,6 @@ --- description: Use verbose message in DSC resource -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: DSCUseVerboseMessageInDSCResource diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/MisleadingBacktick.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/MisleadingBacktick.md index 10bb962..3f89503 100644 --- 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.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: MisleadingBacktick diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/MissingModuleManifestField.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/MissingModuleManifestField.md index da7a7fa..d72f09e 100644 --- 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.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: MissingModuleManifestField diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/PlaceCloseBrace.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/PlaceCloseBrace.md index ef48fe1..4a55e3a 100644 --- 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.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: PlaceCloseBrace diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/PlaceOpenBrace.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/PlaceOpenBrace.md index 181398b..0c873e6 100644 --- 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.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: PlaceOpenBrace diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/PossibleIncorrectComparisonWithNull.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/PossibleIncorrectComparisonWithNull.md index 83f64b6..671f491 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/PossibleIncorrectComparisonWithNull.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/PossibleIncorrectComparisonWithNull.md @@ -1,6 +1,6 @@ --- description: Null Comparison -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: PossibleIncorrectComparisonWithNull diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/PossibleIncorrectUsageOfAssignmentOperator.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/PossibleIncorrectUsageOfAssignmentOperator.md index c822d53..5737b53 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/PossibleIncorrectUsageOfAssignmentOperator.md +++ b/reference/docs-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.20.0 +description: Equal sign is not an assignment operator. Did you mean the equality operator \'-eq\'? +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: PossibleIncorrectUsageOfAssignmentOperator diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/PossibleIncorrectUsageOfRedirectionOperator.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/PossibleIncorrectUsageOfRedirectionOperator.md index 08ddc16..9956b92 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/PossibleIncorrectUsageOfRedirectionOperator.md +++ b/reference/docs-conceptual/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.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: PossibleIncorrectUsageOfRedirectionOperator diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/ProvideCommentHelp.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/ProvideCommentHelp.md index 9e9a430..885c035 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/ProvideCommentHelp.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/ProvideCommentHelp.md @@ -1,6 +1,6 @@ --- description: Basic Comment Help -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: ProvideCommentHelp @@ -17,9 +17,9 @@ presence of comment based help and not on the validity or format. For assistance on comment based help, use the command `Get-Help about_comment_based_help` or the following articles: -- [Writing Comment-based Help](/powershell/scripting/developer/help/writing-comment-based-help-topics) -- [Writing Help for PowerShell Cmdlets](/powershell/scripting/developer/help/writing-help-for-windows-powershell-cmdlets) -- [Create XML-based help using PlatyPS](/powershell/scripting/dev-cross-plat/create-help-using-platyps) +- [Writing Comment-based Help](https://docs.microsoft.com/powershell/scripting/developer/help/writing-comment-based-help-topics) +- [Writing Help for PowerShell Cmdlets](https://docs.microsoft.com/powershell/scripting/developer/help/writing-help-for-windows-powershell-cmdlets) +- [Create XML-based help using PlatyPS](https://docs.microsoft.com/powershell/scripting/dev-cross-plat/create-help-using-platyps) ## Configuration diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/README.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/README.md index 528d5ad..aaac74f 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/README.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/README.md @@ -1,6 +1,6 @@ --- description: List of PSScriptAnalyzer rules -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: List of PSScriptAnalyzer rules @@ -57,7 +57,7 @@ The PSScriptAnalyzer contains the following rule definitions. | [ReservedCmdletChar](./ReservedCmdletChar.md) | Error | Yes | | | [ReservedParams](./ReservedParams.md) | Error | Yes | | | [ReviewUnusedParameter](./ReviewUnusedParameter.md) | Warning | Yes | | -| [ShouldProcess](./ShouldProcess.md) | Error | Yes | | +| [ShouldProcess](./ShouldProcess.md) | Warning | Yes | | | [UseApprovedVerbs](./UseApprovedVerbs.md) | Warning | Yes | | | [UseBOMForUnicodeEncodedFile](./UseBOMForUnicodeEncodedFile.md) | Warning | Yes | | | [UseCmdletCorrectly](./UseCmdletCorrectly.md) | Warning | Yes | | diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/ReservedCmdletChar.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/ReservedCmdletChar.md index 49e405a..fc9dc64 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/ReservedCmdletChar.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/ReservedCmdletChar.md @@ -1,6 +1,6 @@ --- description: Reserved Cmdlet Chars -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: ReservedCmdletChar diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/ReservedParams.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/ReservedParams.md index cda6356..768b660 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/ReservedParams.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/ReservedParams.md @@ -1,6 +1,6 @@ --- description: Reserved Parameters -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: ReservedParams diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/ReviewUnusedParameter.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/ReviewUnusedParameter.md index c944072..309bcd4 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/ReviewUnusedParameter.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/ReviewUnusedParameter.md @@ -1,6 +1,6 @@ --- description: ReviewUnusedParameter -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: ReviewUnusedParameter diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/ShouldProcess.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/ShouldProcess.md index 908bc5d..ed95493 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/ShouldProcess.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/ShouldProcess.md @@ -1,6 +1,6 @@ --- description: Should Process -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 03/24/2022 ms.topic: reference title: ShouldProcess @@ -14,7 +14,7 @@ title: ShouldProcess If a cmdlet declares the `SupportsShouldProcess` attribute, then it should also call `ShouldProcess`. A violation is any function which either declares `SupportsShouldProcess` attribute but makes no calls to `ShouldProcess` or it calls `ShouldProcess` but does not declare -`SupportsShouldProcess` +`SupportsShouldProcess`. For more information, see the following articles: @@ -26,7 +26,7 @@ For more information, see the following articles: To fix a violation of this rule, please call `ShouldProcess` method when a cmdlet declares `SupportsShouldProcess` attribute. Or please add `SupportsShouldProcess` attribute argument when -calling `ShouldProcess` +calling `ShouldProcess`. ## Example @@ -66,10 +66,5 @@ function Set-File { $Content | Out-File -FilePath $Path } - else - { - # Code that should be processed if doing a WhatIf operation - # Must NOT change anything outside of the function / script - } } ``` diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseApprovedVerbs.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseApprovedVerbs.md index 3d71188..7343b71 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseApprovedVerbs.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseApprovedVerbs.md @@ -1,6 +1,6 @@ --- description: Cmdlet Verbs -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: UseApprovedVerbs @@ -16,7 +16,7 @@ All cmdlets must used approved verbs. Approved verbs can be found by running the command `Get-Verb`. Additional documentation on approved verbs can be found in the microsoft docs page -[Approved Verbs for PowerShell Commands](/powershell/scripting/developer/cmdlet/approved-verbs-for-windows-powershell-commands). +[Approved Verbs for PowerShell Commands](https://docs.microsoft.com/powershell/scripting/developer/cmdlet/approved-verbs-for-windows-powershell-commands). Some unapproved verbs are documented on the approved verbs page and point to approved alternatives. Try searching for the verb you used to find its approved form. For example, searching for `Read`, `Open`, or `Search` leads you to `Get`. diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseBOMForUnicodeEncodedFile.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseBOMForUnicodeEncodedFile.md index 56e1fa1..1c4c0f4 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseBOMForUnicodeEncodedFile.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseBOMForUnicodeEncodedFile.md @@ -1,6 +1,6 @@ --- description: Use BOM encoding for non-ASCII files -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: UseBOMForUnicodeEncodedFile diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCmdletCorrectly.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCmdletCorrectly.md index 5786c26..158dade 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCmdletCorrectly.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCmdletCorrectly.md @@ -1,6 +1,6 @@ --- description: Use Cmdlet Correctly -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: UseCmdletCorrectly diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleCmdlets.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleCmdlets.md index 931a67d..6a9d62d 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleCmdlets.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleCmdlets.md @@ -1,6 +1,6 @@ --- description: Use compatible cmdlets -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: UseCompatibleCmdlets diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleCommands.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleCommands.md index 5a0708d..3eb6503 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleCommands.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleCommands.md @@ -1,6 +1,6 @@ --- description: Use compatible commands -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: UseCompatibleCommands diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleSyntax.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleSyntax.md index b2d7aeb..5a98ea3 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleSyntax.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleSyntax.md @@ -1,6 +1,6 @@ --- description: Use compatible syntax -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: UseCompatibleSyntax diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleTypes.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleTypes.md index 6ea6e25..cd9da00 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleTypes.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleTypes.md @@ -1,6 +1,6 @@ --- description: Use compatible types -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: UseCompatibleTypes diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConsistentIndentation.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConsistentIndentation.md index d593c58..de5979f 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConsistentIndentation.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConsistentIndentation.md @@ -1,6 +1,6 @@ --- description: Use consistent indentation -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: UseConsistentIndentation diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConsistentWhitespace.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConsistentWhitespace.md index 5544e36..3438c60 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConsistentWhitespace.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConsistentWhitespace.md @@ -1,6 +1,6 @@ --- description: Use whitespaces -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: UseConsistentWhitespace diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCorrectCasing.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCorrectCasing.md index b35954c..8d8dd28 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCorrectCasing.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCorrectCasing.md @@ -1,6 +1,6 @@ --- description: Use exact casing of cmdlet/function/parameter name. -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: UseCorrectCasing diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseLiteralInitializerForHashtable.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseLiteralInitializerForHashtable.md index b8ce225..d7ff68f 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseLiteralInitializerForHashtable.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseLiteralInitializerForHashtable.md @@ -1,6 +1,6 @@ --- description: Create hashtables with literal initializers -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: UseLiteralInitializerForHashtable diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseOutputTypeCorrectly.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseOutputTypeCorrectly.md index c151271..ee531d1 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseOutputTypeCorrectly.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseOutputTypeCorrectly.md @@ -1,6 +1,6 @@ --- description: Use OutputType Correctly -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: UseOutputTypeCorrectly diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UsePSCredentialType.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UsePSCredentialType.md index 756e6b2..85e7ed2 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UsePSCredentialType.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UsePSCredentialType.md @@ -1,6 +1,6 @@ --- description: Use PSCredential type. -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: UsePSCredentialType diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseProcessBlockForPipelineCommand.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseProcessBlockForPipelineCommand.md index b16b07c..3bb5d2f 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseProcessBlockForPipelineCommand.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseProcessBlockForPipelineCommand.md @@ -1,6 +1,6 @@ --- description: Use process block for command that accepts input from pipeline. -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: UseProcessBlockForPipelineCommand diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseShouldProcessForStateChangingFunctions.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseShouldProcessForStateChangingFunctions.md index b763a2d..84f79bb 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseShouldProcessForStateChangingFunctions.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseShouldProcessForStateChangingFunctions.md @@ -1,6 +1,6 @@ --- description: Use ShouldProcess For State Changing Functions -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: UseShouldProcessForStateChangingFunctions diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseSingularNouns.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseSingularNouns.md index b885a22..9dc24a0 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseSingularNouns.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseSingularNouns.md @@ -1,6 +1,6 @@ --- description: Cmdlet Singular Noun -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: UseSingularNouns diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseSupportsShouldProcess.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseSupportsShouldProcess.md index 16b489e..20ec0b2 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseSupportsShouldProcess.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseSupportsShouldProcess.md @@ -1,6 +1,6 @@ --- description: Use SupportsShouldProcess -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: UseSupportsShouldProcess diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseToExportFieldsInManifest.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseToExportFieldsInManifest.md index 469abbf..9b3bbaa 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseToExportFieldsInManifest.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseToExportFieldsInManifest.md @@ -1,6 +1,6 @@ --- description: Use the *ToExport module manifest fields. -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: UseToExportFieldsInManifest diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseUTF8EncodingForHelpFile.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseUTF8EncodingForHelpFile.md index 6db26d4..9452d2b 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseUTF8EncodingForHelpFile.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseUTF8EncodingForHelpFile.md @@ -1,6 +1,6 @@ --- description: Use UTF8 Encoding For Help File -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: UseUTF8EncodingForHelpFile diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseUsingScopeModifierInNewRunspaces.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseUsingScopeModifierInNewRunspaces.md index 65de58e..b17a471 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseUsingScopeModifierInNewRunspaces.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseUsingScopeModifierInNewRunspaces.md @@ -1,6 +1,6 @@ --- description: Use 'Using:' scope modifier in RunSpace ScriptBlocks -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/18/2021 ms.topic: reference title: UseUsingScopeModifierInNewRunspaces diff --git a/reference/docs-conceptual/PSScriptAnalyzer/overview.md b/reference/docs-conceptual/PSScriptAnalyzer/overview.md index a6664fa..f0affa4 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/overview.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/overview.md @@ -28,7 +28,7 @@ standard style, is easier to read, and is more maintainable. Supported PowerShell Versions and Platforms - Windows PowerShell 3.0 or greater -- PowerShell 7.0.3 or greater on Windows/Linux/macOS +- PowerShell 7.0.11 or greater on Windows/Linux/macOS Install using PowerShellGet 2.x: diff --git a/reference/ps-modules/PSScriptAnalyzer/Get-ScriptAnalyzerRule.md b/reference/ps-modules/PSScriptAnalyzer/Get-ScriptAnalyzerRule.md index 5aa735e..2efa052 100644 --- a/reference/ps-modules/PSScriptAnalyzer/Get-ScriptAnalyzerRule.md +++ b/reference/ps-modules/PSScriptAnalyzer/Get-ScriptAnalyzerRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Windows.PowerShell.ScriptAnalyzer.dll-Help.xml Module Name: PSScriptAnalyzer -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/07/2021 online version: https://docs.microsoft.com/powershell/module/psscriptanalyzer/get-scriptanalyzerrule?view=ps-modules&wt.mc_id=ps-gethelp schema: 2.0.0 diff --git a/reference/ps-modules/PSScriptAnalyzer/Invoke-Formatter.md b/reference/ps-modules/PSScriptAnalyzer/Invoke-Formatter.md index 7587d1a..6e4b3a6 100644 --- a/reference/ps-modules/PSScriptAnalyzer/Invoke-Formatter.md +++ b/reference/ps-modules/PSScriptAnalyzer/Invoke-Formatter.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Windows.PowerShell.ScriptAnalyzer.dll-Help.xml Module Name: PSScriptAnalyzer -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/07/2021 online version: https://docs.microsoft.com/powershell/module/psscriptanalyzer/invoke-formatter?view=ps-modules&wt.mc_id=ps-gethelp schema: 2.0.0 @@ -104,7 +104,7 @@ Aliases: Required: False Position: 3 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` @@ -121,7 +121,7 @@ Aliases: Required: True Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` @@ -137,7 +137,7 @@ Aliases: Required: False Position: 2 Default value: CodeFormatting -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` diff --git a/reference/ps-modules/PSScriptAnalyzer/Invoke-ScriptAnalyzer.md b/reference/ps-modules/PSScriptAnalyzer/Invoke-ScriptAnalyzer.md index 2263f16..32d8b1c 100644 --- a/reference/ps-modules/PSScriptAnalyzer/Invoke-ScriptAnalyzer.md +++ b/reference/ps-modules/PSScriptAnalyzer/Invoke-ScriptAnalyzer.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Windows.PowerShell.ScriptAnalyzer.dll-Help.xml Module Name: PSScriptAnalyzer -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/07/2021 online version: https://docs.microsoft.com/powershell/module/psscriptanalyzer/invoke-scriptanalyzer?view=ps-modules&wt.mc_id=ps-gethelp schema: 2.0.0 @@ -514,7 +514,7 @@ following keys: The keys and values in the profile are interpreted as if they were standard parameters and values of `Invoke-ScriptAnalyzer`, similar to splatting. For more information, see -[about_Splatting](/powershell/module/microsoft.powershell.com/about/about_splatting). +[about_Splatting](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_splatting). ```yaml Type: Object diff --git a/reference/ps-modules/PSScriptAnalyzer/PSScriptAnalyzer.md b/reference/ps-modules/PSScriptAnalyzer/PSScriptAnalyzer.md index 557cb2e..1db78a5 100644 --- a/reference/ps-modules/PSScriptAnalyzer/PSScriptAnalyzer.md +++ b/reference/ps-modules/PSScriptAnalyzer/PSScriptAnalyzer.md @@ -1,10 +1,10 @@ --- Download Help Link: https://aka.ms/ps-modules-help -Help Version: 1.20.0 +Help Version: 1.21.0 Locale: en-US Module Guid: d6245802-193d-4068-a631-8863a4342a18 Module Name: PSScriptAnalyzer -ms.custom: PSSA v1.20.0 +ms.custom: PSSA v1.21.0 ms.date: 10/07/2021 --- From 068fb137a3887ec897c30172a94282bf1f4100ff Mon Sep 17 00:00:00 2001 From: Christoph Bergmeister Date: Wed, 31 Aug 2022 21:20:32 +0100 Subject: [PATCH 2/6] Revert changes with absolute to relative link as those links are different between PSSA vs MicrosoftDocs --- .../PSScriptAnalyzer/Rules/ProvideCommentHelp.md | 6 +++--- .../PSScriptAnalyzer/Rules/UseApprovedVerbs.md | 2 +- .../ps-modules/PSScriptAnalyzer/Invoke-ScriptAnalyzer.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/ProvideCommentHelp.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/ProvideCommentHelp.md index 885c035..ddf13d8 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/ProvideCommentHelp.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/ProvideCommentHelp.md @@ -17,9 +17,9 @@ presence of comment based help and not on the validity or format. For assistance on comment based help, use the command `Get-Help about_comment_based_help` or the following articles: -- [Writing Comment-based Help](https://docs.microsoft.com/powershell/scripting/developer/help/writing-comment-based-help-topics) -- [Writing Help for PowerShell Cmdlets](https://docs.microsoft.com/powershell/scripting/developer/help/writing-help-for-windows-powershell-cmdlets) -- [Create XML-based help using PlatyPS](https://docs.microsoft.com/powershell/scripting/dev-cross-plat/create-help-using-platyps) +- [Writing Comment-based Help](/powershell/scripting/developer/help/writing-comment-based-help-topics) +- [Writing Help for PowerShell Cmdlets](/powershell/scripting/developer/help/writing-help-for-windows-powershell-cmdlets) +- [Create XML-based help using PlatyPS](/powershell/scripting/dev-cross-plat/create-help-using-platyps) ## Configuration diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseApprovedVerbs.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseApprovedVerbs.md index 7343b71..cd1fd9c 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseApprovedVerbs.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseApprovedVerbs.md @@ -16,7 +16,7 @@ All cmdlets must used approved verbs. Approved verbs can be found by running the command `Get-Verb`. Additional documentation on approved verbs can be found in the microsoft docs page -[Approved Verbs for PowerShell Commands](https://docs.microsoft.com/powershell/scripting/developer/cmdlet/approved-verbs-for-windows-powershell-commands). +[Approved Verbs for PowerShell Commands](/powershell/scripting/developer/cmdlet/approved-verbs-for-windows-powershell-commands). Some unapproved verbs are documented on the approved verbs page and point to approved alternatives. Try searching for the verb you used to find its approved form. For example, searching for `Read`, `Open`, or `Search` leads you to `Get`. diff --git a/reference/ps-modules/PSScriptAnalyzer/Invoke-ScriptAnalyzer.md b/reference/ps-modules/PSScriptAnalyzer/Invoke-ScriptAnalyzer.md index 32d8b1c..f7c8b96 100644 --- a/reference/ps-modules/PSScriptAnalyzer/Invoke-ScriptAnalyzer.md +++ b/reference/ps-modules/PSScriptAnalyzer/Invoke-ScriptAnalyzer.md @@ -514,7 +514,7 @@ following keys: The keys and values in the profile are interpreted as if they were standard parameters and values of `Invoke-ScriptAnalyzer`, similar to splatting. For more information, see -[about_Splatting](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_splatting). +[about_Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting). ```yaml Type: Object From 00ed70120d999f268d31d7bbe8f7bd848f57c03b Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Wed, 31 Aug 2022 16:33:07 -0500 Subject: [PATCH 3/6] Update reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidSemicolonsAsLineTerminators.md --- .../PSScriptAnalyzer/Rules/AvoidSemicolonsAsLineTerminators.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidSemicolonsAsLineTerminators.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidSemicolonsAsLineTerminators.md index 0ce1cbc..65fa0d9 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidSemicolonsAsLineTerminators.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidSemicolonsAsLineTerminators.md @@ -13,7 +13,8 @@ title: AvoidSemicolonsAsLineTerminators Lines should not end with a semicolon. -**Note**: This rule is not enabled by default. The user needs to enable it through settings. +> [!NOTE] +> This rule is not enabled by default. The user needs to enable it through settings. ## Example From 5f816758e4fdfa8b5b3e642e94f8b5e041f895c6 Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Wed, 31 Aug 2022 16:40:28 -0500 Subject: [PATCH 4/6] Update version in TOC --- reference/docs-conceptual/toc.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/reference/docs-conceptual/toc.yml b/reference/docs-conceptual/toc.yml index f6aee6e..81c9d0a 100644 --- a/reference/docs-conceptual/toc.yml +++ b/reference/docs-conceptual/toc.yml @@ -27,7 +27,7 @@ items: href: PlatyPS/overview.md - name: Create help using PlatyPS href: PlatyPS/create-help-using-platyps.md - - name: PSScriptAnalyzer v1.20 + - name: PSScriptAnalyzer v1.21 items: - name: Overview href: PSScriptAnalyzer/overview.md From c99d53d2c4f917f8884a3d38f0e97f2787733b28 Mon Sep 17 00:00:00 2001 From: Christoph Bergmeister Date: Sat, 24 Sep 2022 21:11:19 +0100 Subject: [PATCH 5/6] Update with changes from https://github.com/PowerShell/PSScriptAnalyzer/pull/1844 --- .../PSScriptAnalyzer/Rules/ProvideCommentHelp.md | 2 +- .../docs-conceptual/PSScriptAnalyzer/Rules/ShouldProcess.md | 5 +++++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/ProvideCommentHelp.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/ProvideCommentHelp.md index ddf13d8..1afcc39 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/ProvideCommentHelp.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/ProvideCommentHelp.md @@ -19,7 +19,7 @@ following articles: - [Writing Comment-based Help](/powershell/scripting/developer/help/writing-comment-based-help-topics) - [Writing Help for PowerShell Cmdlets](/powershell/scripting/developer/help/writing-help-for-windows-powershell-cmdlets) -- [Create XML-based help using PlatyPS](/powershell/scripting/dev-cross-plat/create-help-using-platyps) +- [Create XML-based help using PlatyPS](/powershell/utility-modules/platyps/create-help-using-platyps) ## Configuration diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/ShouldProcess.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/ShouldProcess.md index ed95493..8a506a1 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/ShouldProcess.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/ShouldProcess.md @@ -66,5 +66,10 @@ function Set-File { $Content | Out-File -FilePath $Path } + else + { + # Code that should be processed if doing a WhatIf operation + # Must NOT change anything outside of the function / script + } } ``` From 2cc973fbfa2c062768b1a46e77792d32b02ae040 Mon Sep 17 00:00:00 2001 From: Christoph Bergmeister Date: Thu, 29 Sep 2022 21:33:58 +0100 Subject: [PATCH 6/6] Update AvoidUsingPositionalParameters docs from last PR --- .../Rules/AvoidUsingPositionalParameters.md | 21 +++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingPositionalParameters.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingPositionalParameters.md index 2c92b6e..4cecb29 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingPositionalParameters.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingPositionalParameters.md @@ -20,6 +20,27 @@ rule from being too noisy, this rule gets only triggered when there are 3 or mor supplied. A simple example where the risk of using positional parameters is negligible, is `Test-Path $Path`. +## Configuration + +```powershell +Rules = @{ + AvoidUsingPositionalParameters = @{ + CommandAllowList = 'az', 'Join-Path' + Enable = $true + } +} +``` + +### Parameters + +#### AvoidUsingPositionalParameters: 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. + +#### Enable: bool (Default value is `$true`) + +Enable or disable the rule during ScriptAnalyzer invocation. + ## How Use full parameter names when calling commands.