PowerShell / PowerShell/PSScriptAnalyzer
Suggestion: Parameter modification warning
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 2.2k
- Forks
- 414
- Avg merge
- 13h 1m
- Merged PRs (30d)
- 2
Description
Summary of the new feature
User has a function with a a parameter called, for this example, $PassedParam.
Inside the function, the $PassedParam is assigned with a new value.
This cause the type constrainment and the various Validate attributes checks to trigger again.
I propose a warning to suggest the user to treat parameters as read-only
What is the latest version of PSScriptAnalyzer at the point of writing
1.23.0
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the proposed behavior in issue #2059 and locating the existing parameter and assignment analysis in PSScriptAnalyzer. Define the warning's scope around reassignment of validated parameters, then add coverage showing when the warning should be reported and when it should not.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp, powershell
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100