PowerShell / PowerShell/PSScriptAnalyzer

Consider adding warning rule for Foreach-object break/continue/return

Open
#1,544 3 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Area - Rules Issue - New Rule Up-for-Grabs
Dominant language
C#
Stars
2.2k
Forks
414
Avg merge
13h 1m
Merged PRs (30d)
2

Description

Summary of the new feature

ForEach-Object is great. However, by its name, it's similar to foreach. Using continue/break/return within ForEach-Object to foreach is much different and does something that most people do not expect. It would be great for PSScriptAnalyzer to warn people about using it that way.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing existing PSScriptAnalyzer warning rules and their tests, then inspect how ForEach-Object and loop control statements are represented. Define warning behavior for continue, break, and return, and add coverage for the intended cases. Done means the analyzer reports the documented unexpected forms without false positives.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, powershell
Domain
devtools, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.