PowerShell / PowerShell/PSScriptAnalyzer

Format doesn't work for comma `,` separated parameters

未關閉
#1,684 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

Area - Formatter Issue - Bug
主要語言
C#
星號
2.2k
分支
415
平均合併
13 小時 1 分鐘
30 天內合併 PR
2

描述

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 in a ,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
    

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

研究方向

在 PowerShell 檔案中使用 Alt+Shift+F,搭配以逗號分隔的參數和列出的程式碼格式設定來重現此問題。將格式化程式的輸出與預期範例進行比較,包括保留 a, b 中的逗號和空格;當格式化穩定且程式碼仍然有效時,即表示完成。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
powershell
領域
tooling
Issue 類型
缺陷
難度
3/5
預估耗時
1-2 天
活躍度
停滯
描述清晰度
基本清楚
新手友好度
45/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。