Add configuration section to all rules#439
Merged
sdwheeler merged 3 commits intoJul 21, 2026
Merged
Conversation
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the PSScriptAnalyzer rule documentation to consistently include a Default state line and a Configure rule section (or equivalent configuration guidance), and refreshes metadata/link formatting across the rules reference.
Changes:
- Adds/standardizes Default state and Configure rule sections across many rule reference pages.
- Normalizes/updates link references (moving to reference-style links in several pages).
- Updates the rules index table to reflect default-state/configurability changes.
Reviewed changes
Copilot reviewed 76 out of 76 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AlignAssignmentStatement.md | Adds default-state/configuration guidance. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidAssignmentToAutomaticVariable.md | Adds default-state/configuration guidance and refactors description text. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidDefaultValueForMandatoryParameter.md | Adds default-state/configuration guidance. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidDefaultValueSwitchParameter.md | Adds default-state/configuration guidance. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidExclaimOperator.md | Adds default-state/configuration guidance and restructures parameters section. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalAliases.md | Adds default-state/configuration guidance. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalFunctions.md | Adds default-state/configuration guidance. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalVars.md | Adds default-state/configuration guidance and link-reference block. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidInvokingEmptyMembers.md | Adds default-state/configuration guidance. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidLongLines.md | Adds default-state/configuration guidance and streamlines description. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidMultipleTypeAttributes.md | Adds default-state/configuration guidance. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidNullOrEmptyHelpMessageAttribute.md | Adds default-state/configuration guidance. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidOverwritingBuiltInCmdlets.md | Adds default-state/configuration guidance and updates example settings snippet. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidReservedWordsAsFunctionNames.md | Adds default-state/configuration guidance. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidSemicolonsAsLineTerminators.md | Adds default-state/configuration guidance and streamlines description. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidShouldContinueWithoutForce.md | Adds default-state/configuration guidance and link-reference block. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidTrailingWhitespace.md | Adds default-state/configuration guidance and link-reference block. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingAllowUnencryptedAuthentication.md | Adds default-state/configuration guidance and link-reference block. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingBrokenHashAlgorithms.md | Adds default-state/configuration guidance and link-reference block. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingCmdletAliases.md | Adds default-state/configuration guidance. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingComputerNameHardcoded.md | Adds default-state/configuration guidance and link-reference block. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingConvertToSecureStringWithPlainText.md | Adds default-state/configuration guidance and link-reference block. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingDeprecatedManifestFields.md | Adds default-state/configuration guidance and link-reference block. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingDoubleQuotesForConstantString.md | Adds default-state/configuration guidance and parameters section. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingEmptyCatchBlock.md | Adds default-state/configuration guidance and link-reference block. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingInvokeExpression.md | Adds default-state/configuration guidance and link-reference block. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingPlainTextForPassword.md | Adds default-state/configuration guidance and link-reference block. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingPositionalParameters.md | Adds default-state/configuration guidance and parameters section. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingUsernameAndPasswordParams.md | Adds default-state/configuration guidance and link-reference block. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingWMICmdlet.md | Adds default-state/configuration guidance and link-reference block. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingWriteHost.md | Adds default-state/configuration guidance and link-reference block. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCDscExamplesPresent.md | Adds default-state/configuration guidance. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCDscTestsPresent.md | Adds default-state/configuration guidance. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCReturnCorrectTypesForDSCFunctions.md | Adds default-state/configuration guidance. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCStandardDSCFunctionsInResource.md | Adds default-state/configuration guidance. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCUseIdenticalMandatoryParametersForDSC.md | Adds default-state/configuration guidance. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCUseIdenticalParametersForDSC.md | Adds default-state/configuration guidance. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/DSCUseVerboseMessageInDSCResource.md | Adds default-state/configuration guidance. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/MisleadingBacktick.md | Adds default-state/configuration guidance and updates compliant example. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/MissingModuleManifestField.md | Adds default-state/configuration guidance and link-reference block. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/PlaceCloseBrace.md | Adds default-state/configuration guidance and renames configuration heading. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/PlaceOpenBrace.md | Adds default-state/configuration guidance and renames configuration heading. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/PossibleIncorrectComparisonWithNull.md | Adds default-state/configuration guidance. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/PossibleIncorrectUsageOfAssignmentOperator.md | Adds default-state/configuration guidance and link-reference block. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/PossibleIncorrectUsageOfRedirectionOperator.md | Adds default-state/configuration guidance. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/ProvideCommentHelp.md | Normalizes severity wording, adds default state, and renames configuration heading. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/README.md | Updates the rules index table (default state/configurable columns). |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/ReservedCmdletChar.md | Adds default-state/configuration guidance. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/ReservedParams.md | Adds default-state/configuration guidance. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/ReviewUnusedParameter.md | Adds configuration guidance and link-reference block. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/ShouldProcess.md | Adds default-state/configuration guidance and link-reference block. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseApprovedVerbs.md | Adds default-state/configuration guidance and link-reference block. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseBOMForUnicodeEncodedFile.md | Adds default-state/configuration guidance and link-reference block. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCmdletCorrectly.md | Adds default-state/configuration guidance and link-reference block. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleCmdlets.md | Adds default-state/configuration guidance and link-reference block. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleCommands.md | Moves suppression section and adds default-state/configuration guidance. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleSyntax.md | Adds default-state/configuration guidance. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCompatibleTypes.md | Moves suppression section and adds default-state/configuration guidance. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConstrainedLanguageMode.md | Adds default-state indicator. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConsistentIndentation.md | Adds default-state indicator and adjusts description text. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConsistentParametersKind.md | Adds default-state/configuration guidance and parameters section. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConsistentParameterSetName.md | Adds default-state indicator and renames configuration heading. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConsistentWhitespace.md | Adds default-state indicator and parameters/config guidance. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseCorrectCasing.md | Adds default-state indicator and renames configuration heading. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseDeclaredVarsMoreThanAssignments.md | Adds default-state/configuration guidance. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseLiteralInitializerForHashtable.md | Adds default-state/configuration guidance. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseOutputTypeCorrectly.md | Adds default-state/configuration guidance and link-reference block. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseProcessBlockForPipelineCommand.md | Adds default-state/configuration guidance. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UsePSCredentialType.md | Adds default-state/configuration guidance. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseShouldProcessForStateChangingFunctions.md | Adds configuration guidance and link-reference block. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseSingleValueFromPipelineParameter.md | Adds default-state/configuration guidance and parameters section. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseSingularNouns.md | Adds default-state indicator and renames configuration heading. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseSupportsShouldProcess.md | Adds default-state/configuration guidance. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseToExportFieldsInManifest.md | Adds default-state/configuration guidance. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseUsingScopeModifierInNewRunspaces.md | Adds default-state/configuration guidance. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseUTF8EncodingForHelpFile.md | Adds default-state/configuration guidance and converts links to reference-style. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
sdwheeler
commented
Jul 21, 2026
sdwheeler
left a comment
sdwheeler
left a comment
Collaborator
Author
There was a problem hiding this comment.
See suggestions
Co-authored-by: Sean Wheeler <sean.wheeler@microsoft.com>
|
Learn Build status updates of commit 0906d75: ✅ Validation status: passed
This comment lists only the first 25 files in the pull request. |
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Summary
Add configuration section to all rules
PR Checklist