PowerShell / PowerShell/PSScriptAnalyzer
Invalid reformatting when docker command executed directly from PS
オープン
まだ誰も着手していません。
Area - Formatter
- 主要言語
- C#
- スター
- 2.2k
- フォーク
- 414
- 平均マージ
- 13時間 1分
- マージ済み PR(30日)
- 2
説明
Steps to reproduce
$def = @"
docker build --secret id=NUGET_USER,env=NUGET_USER
"@
Invoke-Formatter -ScriptDefinition $def
Expected behavior
Unchanged:
docker build --secret id=NUGET_USER,env=NUGET_USER
Actual behavior
A whitespace added:
docker build --secret id=NUGET_USER, env=NUGET_USER
Environment data
> $PSVersionTable
Name Value
---- -----
PSVersion 7.4.7
PSEdition Core
GitCommitId 7.4.7
OS Microsoft Windows 10.0.26100
Platform Win32NT
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion 2.3
SerializationVersion 1.1.0.1
WSManStackVersion 3.0
> (Get-Module -ListAvailable PSScriptAnalyzer).Version | ForEach-Object { $_.ToString() }
1.24.0 # (latest from `main`, imported by `Import-Module .\out\PSScriptAnalyzer\1.24.0\PSScriptAnalyzer.psd1`
Possible tests to repro:
Context "When a comma is not followed by a space" {
It "Should not find violation if there are no whitespaces after a comma for a docker command parameter" {
$def = 'docker build --secret id=NUGET_USER,env=NUGET_USER'
Invoke-ScriptAnalyzer -ScriptDefinition $def -Settings $settings | Should -Be $null
}
}
Context "When non-PS commands are embedded" {
It "Docker parameters are kept intact" {
$def = @"
docker build -t local.rgm-service.image . -f BaseMonitor.Dockerfile --secret id=NUGET_USER,env=NUGET_USER --secret id=NUGET_TOKEN,env=NUGET_TOKEN
"@
Invoke-Formatter -ScriptDefinition $def | Should -Be $def
}
}
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
提供された Invoke-Formatter の再現例と、PowerShell に埋め込まれた Docker コマンド用に提案された 2 つの Pester テストコンテキストから始めます。Docker の --secret 引数に含まれるコンマをフォーマット処理がどのように扱うかを追跡します。コマンドが変更されず、提案されたテストが成功すれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- docker, powershell
- 領域
- tooling
- issue の種類
- バグ
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 45/100