GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — PSReviewUnusedParameter false positive for ValueFromPipeline by liamjpeters · Pull Request #2072 · PowerShell/PSScriptAnalyzer

Conversation

@liamjpeters

@liamjpeters Liam Peters (liamjpeters) commented Mar 3, 2025 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

PR Summary

Whether good practice or not, a parameter defined with ValueFromPipeline is flagged as unused when referred to by $_ or $PSItem within the process block of a function.

This PR checks for ValueFromPipeline when the parameter's usage is inspected. If set, $_ and $PSItem count towards it's usage when seen in a process block.

Fixes #1840

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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@liamjpeters
Liam Peters (liamjpeters) marked this pull request as ready for review March 4, 2025 09:36
@liamjpeters
Liam Peters (liamjpeters) requested review from Andy Jordan (andyleejordan) and Christoph Bergmeister (bergmeister) as code owners March 4, 2025 09:36
andyleejordan
Andy Jordan (andyleejordan) approved these changes Mar 5, 2025
View reviewed changes
Comment thread Rules/ReviewUnusedParameter.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.
@andyleejordan
Andy Jordan (andyleejordan) enabled auto-merge (squash) March 6, 2025 20:00
auto-merge was automatically disabled March 10, 2025 19:30

Head branch was pushed to by a user without write access

bergmeister
Christoph Bergmeister (bergmeister) approved these changes Mar 13, 2025
View reviewed changes

@bergmeister Christoph Bergmeister (bergmeister) left a comment •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Collaborator

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

LGTM, thanks, retriggered CI

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Liam Peters (liamjpeters) and others added 5 commits March 13, 2025 10:05
@liamjpeters @andyleejordan
Check for ValueFromPipeline
b09c4e8
@liamjpeters @andyleejordan
Check whether each scriptblock being analysed has a process block tha…
a379e1f 
…t directly contains variable usage of $_ or $PSItem. Then when we encounted a parameter with ValueFromPipeline set, we consider whether we saw usage within a process block by automatic variable.
@liamjpeters @andyleejordan
Amend tests to consider process block
06141fc
@liamjpeters @andyleejordan
Update Rules/ReviewUnusedParameter.cs
8258436 
Co-authored-by: Andy Jordan <[email protected]>
@liamjpeters @andyleejordan
Update Rules/ReviewUnusedParameter.cs
d83b1d9
@andyleejordan
Andy Jordan (andyleejordan) force-pushed the #1840PSReviewUnusedParameterVsValueFromPipeline branch from 95e1486 to d83b1d9 Compare March 13, 2025 17:05
@andyleejordan
Andy Jordan (andyleejordan) merged commit 1d394ee into PowerShell:main Mar 13, 2025
@liamjpeters
Liam Peters (liamjpeters) deleted the #1840PSReviewUnusedParameterVsValueFromPipeline branch August 7, 2025 12:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bergmeister Christoph Bergmeister (bergmeister) bergmeister approved these changes
+1 more reviewer
@andyleejordan Andy Jordan (andyleejordan) andyleejordan approved these changes
Reviewers whose approvals may not affect merge requirements

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

PSReviewUnusedParameter false positive for ValueFromPipeline and current process item $_

Uh oh!

There was an error while loading. Please reload this page.

3 participants

@liamjpeters @andyleejordan @bergmeister
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.