PowerShell / PowerShell/PSScriptAnalyzer

Rule to enforce new line after a statement

Open
#794 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

If Invoke-Formatter is given a single line script, then it fails to format the script properly.

PS> $settings = Import-PowerShellDataFile .\path\to\module\Settings\CodeFormatting.psd1
PS> $settings.Rules.PSPlaceOpenBrace.IgnoreOneLineBlock = $false
PS> $settings.Rules.PSPlaceCloseBrace.IgnoreOneLineBlock = $false
PS> Invoke-Formatter -ScriptDefinition 'function foo{param($a)foreach($foo in (1..10)){$_}}' -Settings $settings
function foo {
    param($a)foreach ($foo in (1..10)) {
        $_
    }
}

the foreach statement should be on its own line.

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

Reproduce the issue with Invoke-Formatter using the single-line function and the settings from .\path\to\module\Settings\CodeFormatting.psd1. Trace how the formatter handles the embedded foreach statement. Done means the foreach statement is placed on its own line while the shown brace settings remain respected.

Written by the indexing model from the issue text.

Assessment

Tech stack
powershell
Domain
tooling
Issue type
Bug
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.