PowerShell / PowerShell/PSScriptAnalyzer

Invoke-Formatter loses one level of identation after chain with more than 2 commands and script blocks

Open
#1,378 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Steps to reproduce

Input script, formatted already as expected.

Function a {
    Function b {
        Get-Content blah | ? {
            $_ -match foo    
        } | Set-Content bleh

        $AnotherStatement = 1
    }

    Write-Host "hi"
    b
    exit 1
}

a

Expected behavior

The example above after formatted looks the same.

Actual behavior

After a chain of more than 2 commands which spans several lines, the formatter loses one level of indentation. Using $(...) triggers the same problem.

Function a {
    Function b {
        Get-Content blah | ? {
            $_ -match foo
        } | Set-Content bleh

    $AnotherStatement = 1
}

Write-Host "hi"
b
exit 1
}

a

Environment data

> $PSVersionTable
Name                           Value
----                           -----
PSVersion                      5.1.15063.1805
PSEdition                      Desktop
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0...}
BuildVersion                   10.0.15063.1805
CLRVersion                     4.0.30319.42000
WSManStackVersion              3.0
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1

> (Get-Module -ListAvailable PSScriptAnalyzer).Version | ForEach-Object { $_.ToString() }
1.18.3

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 reproducing the reported behavior with Invoke-Formatter and the PowerShell script in the issue, including the multi-command pipeline and the $(...) variant. Trace the formatter entry point and verify that formatting preserves the original indentation of statements following these chains and script blocks.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.