PowerShell / PowerShell/PSScriptAnalyzer
Format doesn't work for comma `,` separated parameters
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 2.2k
- Forks
- 414
- Avg merge
- 13h 1m
- Merged PRs (30d)
- 2
Description
System Details
System Details Output
### VSCode version: 1.51.1 e5a624b788d92b8d34d1392e4c4d9789406efe8f x64
### VSCode extensions:
janisdd.vscode-edit-csv@0.6.0
ms-python.python@2021.2.633441544
ms-toolsai.jupyter@2021.2.576440691
ms-vscode.cpptools@1.1.3
ms-vscode.hexeditor@1.3.0
ms-vscode.powershell@2020.6.0
redhat.vscode-commons@0.0.6
redhat.vscode-xml@0.16.1
### PSES version: 2.2.0.0
### PowerShell version:
Name Value
---- -----
PSVersion 7.1.3
PSEdition Core
GitCommitId 7.1.3
OS Microsoft Windows 10.0.19043
Platform Win32NT
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion 2.3
SerializationVersion 1.1.0.1
WSManStackVersion 3.0
Issue Description
Create a PowerShell file, input following script, and hit Alt+Shift+F. The file is not formatted.
$a = [pscustomobject]@{
a=1
b=2
}
$a|Select-Object a,b
Related settings in settings.json:
"powershell.codeFormatting.trimWhitespaceAroundPipe": true,
"powershell.codeFormatting.useCorrectCasing": true,
"powershell.codeFormatting.whitespaceBetweenParameters": true,
Expected Behaviour
The format result should look similar to:
$a = [pscustomobject]@{
a = 1
b = 2
}
$a | Select-Object -Property a, b
Actual Behaviour
The file is unchanged.
Here are some other input/output combinations if I change the script a little bit and hit Alt+Shift+F again:
- Case 1 -- looks well except that the space is removed in
a, b.- Input:
$a = [pscustomobject]@{ a=1 b=2 } $a|Select-Object a, b- Output:
$a = [pscustomobject]@{ a = 1 b = 2 } $a | Select-Object a,b - Case 2 -- the necessary comma
,is removed ina ,b, which makes the code invalid.- Input:
$a = [pscustomobject]@{ a=1 b=2 } $a|Select-Object a ,b- Output:
$a = [pscustomobject]@{ a = 1 b = 2 } $a | Select-Object a b - Case 3 -- the space is removed in
a, b.- Input:
$a = [pscustomobject]@{ a = 1 b = 2 } $a | Select-Object a, b- Output:
$a = [pscustomobject]@{ a = 1 b = 2 } $a | Select-Object a,b - Case 4 -- this is the reverse of Case 3. If I keep hitting
Alt+Shift+F, the file will cycle through Case 3 and 4.- Input:
$a = [pscustomobject]@{ a = 1 b = 2 } $a | Select-Object a,b- Output:
$a = [pscustomobject]@{ a = 1 b = 2 } $a | Select-Object a, b
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Reproduce the issue in a PowerShell file using Alt+Shift+F with comma-separated parameters and the listed code-formatting settings. Compare the formatter output with the expected examples, including preserving commas and spaces in a, b; done means formatting is stable and the code remains valid.
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
- 45/100