Refactor rules methods by Haimasker · Pull Request #2182 · PowerShell/PSScriptAnalyzer · GitHub

Refactor methods into one-liners using lambda operator.
Unify methods style across all rules.
Add automatic code style check into build process.

PR Summary

Motivation:
I consider these changes useful, because such refactoring allows to reduce the total amount of code in the rules, thereby the developer will be more focused on the logic of the rule itself. In the future, it is planned to complete refactoring with other code style rules.

PR Checklist

PR has a meaningful title
- Use the present tense and imperative mood when describing your changes
Summarized changes
Change is not breaking
Make sure all .cs, .ps1 and .psm1 files have the correct copyright header
Make sure you've added a new test if existing tests do not effectively test the code changed and/or updated documentation
This PR is ready to merge and is not Work in Progress.
- If the PR is work in progress, please add the prefix WIP: to the beginning of the title and remove the prefix when the PR is ready.

Pull request overview

This PR refactors rule metadata to expose SourceType as a property rather than a GetSourceType() method, and renames the enum backing that metadata to RuleSourceType, updating the engine and built-in rules to match. The goal is to reduce boilerplate and standardize how built-in rules report their origin.

Changes:

Replace GetSourceType() implementations across built-in rules (and the rule template) with a SourceType property.
Rename SourceType enum to RuleSourceType and update IRule/RuleInfo/command plumbing accordingly.
Apply minor whitespace/formatting cleanups in touched rule files.

Reviewed changes

Copilot reviewed 83 out of 83 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
Utils/RuleMaker.psm1	Updates the rule-generation template to emit the new SourceType property.
Rules/UseVerboseMessageInDSCResource.cs	Replaces GetSourceType() with SourceType property.
Rules/UseUTF8EncodingForHelpFile.cs	Replaces GetSourceType() with SourceType property.
Rules/UseUsingScopeModifierInNewRunspaces.cs	Replaces GetSourceType() with SourceType property; whitespace cleanup.
Rules/UseToExportFieldsInManifest.cs	Replaces GetSourceType() with SourceType property; whitespace cleanup.
Rules/UseSupportsShouldProcess.cs	Replaces GetSourceType() with SourceType property.
Rules/UseStandardDSCFunctionsInResource.cs	Replaces GetSourceType() with SourceType property; whitespace cleanup.
Rules/UseSingularNouns.cs	Replaces GetSourceType() override with SourceType override; whitespace cleanup.
Rules/UseSingleValueFromPipelineParameter.cs	Replaces GetSourceType() override with SourceType override; whitespace cleanup.
Rules/UseShouldProcessForStateChangingFunctions.cs	Replaces GetSourceType() with SourceType property; whitespace cleanup.
Rules/UseShouldProcessCorrectly.cs	Replaces GetSourceType() with SourceType property.
Rules/UsePSCredentialType.cs	Replaces GetSourceType() with SourceType property.
Rules/UseProcessBlockForPipelineCommand.cs	Replaces GetSourceType() with SourceType property; whitespace cleanup.
Rules/UseOutputTypeCorrectly.cs	Replaces GetSourceType() with SourceType property.
Rules/UseLiteralInitializerForHashtable.cs	Replaces GetSourceType() with SourceType property.
Rules/UseIdenticalParametersDSC.cs	Replaces GetSourceType() with SourceType property; whitespace cleanup.
Rules/UseIdenticalMandatoryParametersDSC.cs	Replaces GetSourceType() with SourceType property.
Rules/UseDeclaredVarsMoreThanAssignments.cs	Replaces GetSourceType() with SourceType property.
Rules/UseCorrectCasing.cs	Replaces GetSourceType() override with SourceType override.
Rules/UseConstrainedLanguageMode.cs	Replaces GetSourceType() override with SourceType override; whitespace cleanup.
Rules/UseConsistentWhitespace.cs	Replaces GetSourceType() override with SourceType override; whitespace cleanup.
Rules/UseConsistentParametersKind.cs	Replaces GetSourceType() override with SourceType override.
Rules/UseConsistentParameterSetName.cs	Replaces GetSourceType() override with SourceType override.
Rules/UseConsistentIndentation.cs	Replaces GetSourceType() override with SourceType override; whitespace cleanup.
Rules/UseCompatibleCmdlets.cs	Replaces GetSourceType() with SourceType property.
Rules/UseCmdletCorrectly.cs	Replaces GetSourceType() with SourceType property.
Rules/UseBOMForUnicodeEncodedFile.cs	Replaces GetSourceType() with SourceType property; whitespace cleanup.
Rules/UseApprovedVerbs.cs	Replaces GetSourceType() with SourceType property.
Rules/ReviewUnusedParameter.cs	Replaces GetSourceType() with SourceType property; whitespace cleanup.
Rules/ReturnCorrectTypesForDSCFunctions.cs	Replaces GetSourceType() with SourceType property; whitespace cleanup.
Rules/ProvideCommentHelp.cs	Replaces GetSourceType() override with SourceType override.
Rules/PossibleIncorrectUsageOfRedirectionOperator.cs	Replaces GetSourceType() with SourceType property.
Rules/PossibleIncorrectUsageOfAssignmentOperator.cs	Replaces GetSourceType() with SourceType property.
Rules/PossibleIncorrectComparisonWithNull.cs	Replaces GetSourceType() with SourceType property; whitespace cleanup.
Rules/PlaceOpenBrace.cs	Replaces GetSourceType() override with SourceType override.
Rules/PlaceCloseBrace.cs	Replaces GetSourceType() override with SourceType override.
Rules/MissingModuleManifestField.cs	Replaces GetSourceType() with SourceType property; whitespace cleanup.
Rules/MisleadingBacktick.cs	Replaces GetSourceType() with SourceType property.
Rules/DscTestsPresent.cs	Replaces GetSourceType() with SourceType property; whitespace cleanup.
Rules/DscExamplesPresent.cs	Replaces GetSourceType() with SourceType property; whitespace cleanup.
Rules/CompatibilityRules/UseCompatibleSyntax.cs	Replaces GetSourceType() override with SourceType override.
Rules/CompatibilityRules/CompatibilityRule.cs	Replaces GetSourceType() override with SourceType override.
Rules/AvoidUsingWriteHost.cs	Replaces GetSourceType() with SourceType property.
Rules/AvoidUsingWMICmdlet.cs	Replaces GetSourceType() with SourceType property; whitespace cleanup.
Rules/AvoidUsingPlainTextForPassword.cs	Replaces GetSourceType() with SourceType property.
Rules/AvoidUsingInvokeExpression.cs	Replaces GetSourceType() override with SourceType override.
Rules/AvoidUsingDoubleQuotesForConstantString.cs	Replaces GetSourceType() override with SourceType override; whitespace cleanup.
Rules/AvoidUsingDeprecatedManifestFields.cs	Replaces GetSourceType() with SourceType property.
Rules/AvoidUsingConvertToSecureStringWithPlainText.cs	Replaces GetSourceType() override with SourceType override.
Rules/AvoidUsingComputerNameHardcoded.cs	Replaces GetSourceType() override with SourceType override.
Rules/AvoidUsingBrokenHashAlgorithms.cs	Replaces GetSourceType() override with SourceType override.
Rules/AvoidUsingAllowUnencryptedAuthentication.cs	Replaces GetSourceType() override with SourceType override.
Rules/AvoidUserNameAndPasswordParams.cs	Replaces GetSourceType() with SourceType property; whitespace cleanup.
Rules/AvoidTrailingWhitespace.cs	Replaces GetSourceType() with SourceType property.
Rules/AvoidShouldContinueWithoutForce.cs	Replaces GetSourceType() with SourceType property; whitespace cleanup.
Rules/AvoidSemicolonsAsLineTerminators.cs	Replaces GetSourceType() override with SourceType override.
Rules/AvoidReservedWordsAsFunctionNames.cs	Replaces GetSourceType() with SourceType property; whitespace cleanup.
Rules/AvoidReservedParams.cs	Replaces GetSourceType() with SourceType property.
Rules/AvoidReservedCharInCmdlet.cs	Replaces GetSourceType() with SourceType property; whitespace cleanup.
Rules/AvoidPositionalParameters.cs	Replaces GetSourceType() override with SourceType override; whitespace cleanup.
Rules/AvoidOverwritingBuiltInCmdlets.cs	Replaces GetSourceType() override with SourceType override.
Rules/AvoidNullOrEmptyHelpMessageAttribute.cs	Replaces GetSourceType() with SourceType property; whitespace cleanup.
Rules/AvoidMultipleTypeAttributes.cs	Replaces GetSourceType() with SourceType property; whitespace cleanup.
Rules/AvoidLongLines.cs	Replaces GetSourceType() override with SourceType override; whitespace cleanup.
Rules/AvoidInvokingEmptyMembers.cs	Replaces GetSourceType() with SourceType property; whitespace cleanup.
Rules/AvoidGlobalVars.cs	Replaces GetSourceType() with SourceType property.
Rules/AvoidGlobalFunctions.cs	Replaces GetSourceType() with SourceType property.
Rules/AvoidGlobalAliases.cs	Replaces GetSourceType() with SourceType property.
Rules/AvoidExclaimOperator.cs	Replaces GetSourceType() override with SourceType override; whitespace cleanup.
Rules/AvoidEmptyCatchBlock.cs	Replaces GetSourceType() with SourceType property.
Rules/AvoidDefaultValueForMandatoryParameter.cs	Replaces GetSourceType() with SourceType property; whitespace cleanup.
Rules/AvoidDefaultTrueValueSwitchParameter.cs	Replaces GetSourceType() with SourceType property.
Rules/AvoidAssignmentToAutomaticVariable.cs	Replaces GetSourceType() with SourceType property.
Rules/AvoidAlias.cs	Replaces GetSourceType() with SourceType property; whitespace cleanup.
Rules/AlignAssignmentStatement.cs	Replaces GetSourceType() override with SourceType override; whitespace cleanup.
Engine/Generic/RuleSourceType.cs	Renames the enum type from SourceType to RuleSourceType; updates doc comment.
Engine/Generic/RuleInfo.cs	Updates RuleInfo.SourceType and constructors to use RuleSourceType.
Engine/Generic/IRule.cs	Changes the rule contract from GetSourceType() to a SourceType property.
Engine/Generic/ExternalRule.cs	Updates external rule implementation to SourceType property.
Engine/Generic/ConfigurableRule.cs	Replaces abstract GetSourceType() with abstract SourceType property.
Engine/Generic/AvoidParameterGeneric.cs	Replaces abstract GetSourceType() with abstract SourceType property.
Engine/Generic/AvoidCmdletGeneric.cs	Replaces abstract GetSourceType() with abstract SourceType property.
Engine/Commands/GetScriptAnalyzerRuleCommand.cs	Switches to reading rule.SourceType when producing RuleInfo.

Comments suppressed due to low confidence (1)

Engine/Generic/RuleSourceType.cs:10

Renaming the public enum SourceType to RuleSourceType (and changing the rule contract from GetSourceType() to a SourceType property) is a breaking API change for any external rule implementations or consumers compiled against previous versions. If maintaining compatibility is required, consider keeping SourceType (or providing an [Obsolete] shim) and adding the new property/mapping without removing the old symbols until a major version bump.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Pull request overview

Copilot reviewed 77 out of 79 changed files in this pull request and generated 4 comments.

since the only value of this is to reduce number of lines of code and there are still many others methods left, it leaves state after this PR inconsistent. I think we have to make a decision first whether we want to go through this or not Andy Jordan (@andyleejordan) and if so we need to do it all in one go

since the only value of this is to reduce number of lines of code and there are still many others methods left, it leaves state after this PR inconsistent. I think we have to make a decision first whether we want to go through this or not Andy Jordan (@andyleejordan) and if so we need to do it all in one go

This seems like something that could all be done in go by Opus 4.7 pretty easily. Let's not piecemeal it.

Let's not piecemeal it.

Sure. I am marking request as "wip", will finish it soon.

* Refactor methods into one-liners using lambda operator. * Add automatic code style check into build process.

Pull request overview

Copilot reviewed 83 out of 85 changed files in this pull request and generated 1 comment.

Denis Melnikov (Haimasker) requested review from a team and Christoph Bergmeister (bergmeister) as code owners May 4, 2026 15:41

Copilot AI review requested due to automatic review settings May 4, 2026 15:41

Copilot started reviewing on behalf of Denis Melnikov (Haimasker) May 4, 2026 15:43 View session

Copilot AI reviewed May 4, 2026

View reviewed changes

Comment thread Engine/Generic/IRule.cs Outdated

Denis Melnikov (Haimasker) changed the title Refactor GetSourceType method WIP: Refactor GetSourceType method May 4, 2026

Denis Melnikov (Haimasker) force-pushed the replace-getter-method-with-property branch from dd25a91 to 23c7f9e Compare May 5, 2026 19:36

Denis Melnikov (Haimasker) changed the title WIP: Refactor GetSourceType method Refactor GetSourceType method May 5, 2026

Christoph Bergmeister (bergmeister) requested a review from Copilot May 7, 2026 21:10

Copilot started reviewing on behalf of Christoph Bergmeister (bergmeister) May 7, 2026 21:11 View session

Copilot AI reviewed May 7, 2026

View reviewed changes

Comment thread Utils/RuleMaker.psm1

Comment thread Engine/Generic/ConfigurableRule.cs

Comment thread Engine/Generic/AvoidCmdletGeneric.cs

Comment thread Engine/Generic/AvoidParameterGeneric.cs

Christoph Bergmeister (bergmeister) reviewed May 7, 2026

View reviewed changes

Denis Melnikov (Haimasker) changed the title Refactor GetSourceType method wip: Refactor GetSourceType method May 17, 2026

Denis Melnikov (Haimasker) force-pushed the replace-getter-method-with-property branch from 23c7f9e to 1632c12 Compare June 20, 2026 17:10

Refactor rules methods

8358c0c

* Refactor methods into one-liners using lambda operator. * Add automatic code style check into build process.

Denis Melnikov (Haimasker) force-pushed the replace-getter-method-with-property branch from 1632c12 to 8358c0c Compare June 20, 2026 18:07

Denis Melnikov (Haimasker) changed the title wip: Refactor GetSourceType method Refactor rules methods Jun 20, 2026

Denis Melnikov (Haimasker) requested review from Christoph Bergmeister (bergmeister) and Copilot June 20, 2026 18:15

Copilot started reviewing on behalf of Denis Melnikov (Haimasker) June 20, 2026 18:16 View session

Copilot AI reviewed Jun 20, 2026

View reviewed changes

+              function Test-CodeStyle
+              {
+                  if ( -not $script:DotnetExe ) {
+                      $script:DotnetExe = Get-DotnetExe
+                  }
+                  $dotnetArgs = "format",
+                      "--verify-no-changes",
+                      "style"
+                  $formatOutput = & $script:DotnetExe $dotnetArgs 2>&1
+                  if ( $LASTEXITCODE -ne 0 ) {
+                      Write-Verbose -Verbose -Message "dotnet is $(${script:DotnetExe}.Source)"
+                      $dotnetArgs | Foreach-Object {"dotnetArg: $_"} | Write-Verbose -Verbose
+                      Get-PSCallStack | Write-Verbose -Verbose
+                      Write-Verbose -Verbose -Message "$formatOutput"
+                      throw "Please, fix code style via running 'dotnet format style' command."
+                  }
+              }

Refactor rules methods by Haimasker · Pull Request #2182 · PowerShell/PSScriptAnalyzer · GitHub

Uh oh!

Refactor rules methods - #2182

Refactor rules methods#2182
Denis Melnikov (Haimasker) wants to merge 1 commit into
PowerShell:mainfrom
Haimasker:replace-getter-method-with-property

Denis Melnikov (Haimasker) commented May 4, 2026 •
edited
Loading

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Christoph Bergmeister (bergmeister) left a comment

Uh oh!

Andy Jordan (andyleejordan) commented May 15, 2026

Uh oh!

Denis Melnikov (Haimasker) commented May 17, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Refactor rules methods by Haimasker · Pull Request #2182 · PowerShell/PSScriptAnalyzer · GitHub

Uh oh!

Refactor rules methods - #2182

Refactor rules methods#2182Denis Melnikov (Haimasker) wants to merge 1 commit intoPowerShell:mainPowerShell/PSScriptAnalyzer:mainfrom Haimasker:replace-getter-method-with-propertyHaimasker/PSScriptAnalyzer:replace-getter-method-with-propertyCopy head branch name to clipboard

Conversation

Denis Melnikov (Haimasker) commented May 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

PR Checklist

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Christoph Bergmeister (bergmeister) left a comment

Choose a reason for hiding this comment

Uh oh!

Andy Jordan (andyleejordan) commented May 15, 2026

Uh oh!

Denis Melnikov (Haimasker) commented May 17, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Refactor rules methods#2182
Denis Melnikov (Haimasker) wants to merge 1 commit into
PowerShell:mainfrom
Haimasker:replace-getter-method-with-property

Denis Melnikov (Haimasker) commented May 4, 2026 •
edited
Loading