X Tutup
Skip to content

Add UseConsistentParametersKind rule#2149

Open
Haimasker wants to merge 3 commits intoPowerShell:mainfrom
Haimasker:use-correct-parameters-definition-type-rule
Open

Add UseConsistentParametersKind rule#2149
Haimasker wants to merge 3 commits intoPowerShell:mainfrom
Haimasker:use-correct-parameters-definition-type-rule

Conversation

@Haimasker
Copy link

@Haimasker Haimasker commented Jan 3, 2026

  • Consistent function parameters definition

  • Rule is disabled by default

  • Possible types of preferred function parameters are: "Inline", "ParamBlock"

PR Summary

This PSScriptAnalyzer rule enforces uniform parameter definitions ("Inline" or "ParamBlock") across functions, improving code readability and maintainability.

Key Benefits:

  1. Consistency: Standardizes parameter style project-wide, making code easier to read and extend.
  2. Advanced Attributes: param block provides CmdletBinding(), OutputType(), and other advanced attributes. On the other hand, these attributes can be blocked by using inline parameters.

PR Checklist

@Haimasker
Copy link
Author

Haimasker commented Jan 3, 2026

@microsoft-github-policy-service agree

@Haimasker
Copy link
Author

Haimasker commented Jan 27, 2026

@sdwheeler @michaeltlombardi @bergmeister
Sorry for additional tagging, but when a merge request review can be expected?

Thank you in advance.

bergmeister
bergmeister reviewed Jan 27, 2026
View reviewed changes
Copy link
Collaborator

@bergmeister bergmeister left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution and sorry for late review. I added Andy as well as he is the main code owner.
The rule might be a bit controversial as for some folks there is no 'correct' kind, therefore I suggest to name rule UseConsistentParametersKind for consistency with other rule names

@Haimasker Haimasker force-pushed the use-correct-parameters-definition-type-rule branch from 0337dfe to eb46fe4 Compare February 14, 2026 10:18
@Haimasker Haimasker changed the title Add UseCorrectParametersKind rule Add UseConsistentParametersKind rule Feb 14, 2026
@Haimasker
Add UseCorrectParametersKind rule
ebd9efa 
* Consistent function parameters definition

* Rule is disabled by default

* Possible types of preferred function parameters are: "Inline",
"ParamBlock"
@Haimasker Haimasker force-pushed the use-correct-parameters-definition-type-rule branch from eb46fe4 to ebd9efa Compare February 14, 2026 11:06
@Haimasker
Copy link
Author

Haimasker commented Mar 1, 2026

@sdwheeler @michaeltlombardi
Since you are the code owners of the repository, could you please review the PR?

@bergmeister
Copy link
Collaborator

bergmeister commented Mar 6, 2026

@Haimasker Already pinged @andyleejordan internally a couple weeks ago as he is main maintainer, it's on his list, please be patient.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bergmeister bergmeister bergmeister approved these changes

@sdwheeler sdwheeler Awaiting requested review from sdwheeler sdwheeler is a code owner

@michaeltlombardi michaeltlombardi Awaiting requested review from michaeltlombardi michaeltlombardi is a code owner

@andyleejordan andyleejordan Awaiting requested review from andyleejordan

+1 more reviewer

@hrxn hrxn hrxn left review comments

Reviewers whose approvals may not affect merge requirements

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Haimasker @bergmeister @hrxn
X Tutup