PowerShell / PowerShell/PSScriptAnalyzer

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

オープン
#1,684 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

Area - Formatter Issue - Bug
主要言語
C#
スター
2.2k
フォーク
414
平均マージ
13時間 1分
マージ済み PR(30日)
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. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

Alt+Shift+F を使用し、カンマ区切りのパラメーターと記載されたコードフォーマット設定を指定して、PowerShell ファイルで問題を再現します。フォーマッターの出力を期待される例と比較し、a, b のカンマとスペースが保持されることも確認します。フォーマットが安定し、コードが有効なままであれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
powershell
領域
tooling
issue の種類
バグ
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
45/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。