Add UseConsistentParametersKind rule

[Haimasker]

• 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

• 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.

[Haimasker]

@microsoft-github-policy-service agree

[Haimasker]

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

Thank you in advance.

[bergmeister]

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

[bergmeister]

I would try to better highlight there are only 2 kinds and what the consequences are of mixing them (is it just optical or does one get a compile or runtime error?).

Also, just talking from personal preference: I mix them because if I just need a simple function with arguments that are small enough to fit in one line, then I like the inline option but the moment things get more complicated (e.g. adding attributes/types, which makes inline hard to read), I use param block. We can definitely add this rule as-is since people can enable it if they think it's useful but just wondering whether it would be useful to some folks to have an optional configuration that allows them to enforce using param block when certain criteria are met (e.g. number of params, presence of attributes, etc.)

[hrxn]

tbh, I mix it too.
Inline for small and simple functions.

[Haimasker]

The description was expanded.

[Haimasker]

About personal preference:

1. The rule is disabled by default, so if someone prefers to mix parameters kinds, then this person can do it easily by not enabling the rule.
2. I can describe my real-time scenario where this rule is very useful. In production code it is more useful to have strongly-typed code rather than trying to fit function definition in single line. So in our company we have custom rule for PsScriptAnalyzer which forces user to use OutputType for functions which have param() block. So, to force user to use OutputType for any function I first need to force user to use param() block. And it is achievable due to this UseConsistentParametersKind rule.

I just want to say that this rule can be really useful in combination with some other rules. Hope it will be helpful for someone else as for me :)

If you still have any questions, you are welcome, I will try to reply to it.