Refactor GetSourceType method

[Haimasker]

• Refactor GetSourceType method into one-liner using lambda
  operator.
• Make code cleaner removing docstrings; The main one is
  provided in base IRule interface.
• Unify GetSourceType method implementation across all rules.

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 common methods for the 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.

[Copilot]

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.

[Copilot]

Pull request overview

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

[bergmeister]

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 @andyleejordan and if so we need to do it all in one go