PowerShell / PowerShell/PSScriptAnalyzer

Formatting Issue, example included

Open
#1,647 10 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Issue Type: Bug

This is an example of the formatting issue I have been struggling with. It appears that that using a multi-line piping statement, along with the 'Out-Null' is the cause in this situation. Formatting the document adds an additional tab each time this code happens. I have much more involved code then this example that becomes really confusing when this indent issue occurs.

function Test-Format([int]$num) {
	if($num -eq 1){
		Get-ChildItem -Path 'c:\*.*' | Where-Object {$_.name -like 'test1.*'} |
			ForEach-Object{Remove-Item -Path $_ | Out-Null}
		}
		else{
			Get-ChildItem -Path 'c:\*.*' | Where-Object {$_.name -like 'test2.*'} |
				ForEach-Object{Remove-Item -Path $_ | Out-Null}
			}
		}
		Test-format -num 1

Extension version: 2021.2.2
VS Code version: Code 1.54.1 (f30a9b73e8ffc278e71575118b6bf568f04587c8, 2021-03-04T22:38:31.419Z)
OS version: Windows_NT x64 10.0.19042

System Info
Item Value
CPUs Intel(R) Xeon(R) CPU E5-1620 v2 @ 3.70GHz (8 x 3700)
GPU Status 2d_canvas: enabled
gpu_compositing: enabled
multiple_raster_threads: enabled_on
oop_rasterization: enabled
opengl: enabled_on
protected_video_decode: unavailable_off
rasterization: enabled
skia_renderer: enabled_on
video_decode: enabled
vulkan: disabled_off
webgl: enabled
webgl2: enabled
Load (avg) undefined
Memory (System) 31.92GB (22.25GB free)
Process Argv --crash-reporter-id 73837bc4-9684-4f62-8d48-bb5a4bc03bd8
Screen Reader no
VM 0%
A/B Experiments
vsliv368:30146709
vsreu685:30147344
python383:30185418
vspor879:30202332
vspor708:30202333
vspor363:30204092
vstry244cf:30256637
pythonvsdeb440:30248342
pythonvsded773:30248341
pythonvspyt875:30259475
dockersubset:30265998
pythontbcf:30265426
vspre833:30267464

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 issue with the multi-line PowerShell pipeline and Out-Null example in this report, using the stated PSScriptAnalyzer extension and VS Code versions where possible. Trace the formatter entry point that handles pipeline indentation; done means repeated formatting no longer adds extra tabs and the shown if/else structure remains correctly aligned.

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.