PowerShell / PowerShell/PSScriptAnalyzer

Invalid reformatting when docker command executed directly from PS

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

還沒有人認領這個 Issue。

Area - Formatter
主要語言
C#
星號
2.2k
分支
415
平均合併
13 小時 1 分鐘
30 天內合併 PR
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

Image

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
        }
    }

貢獻指南

開啟貢獻指南

從這裡開始

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

研究方向

從提供的 Invoke-Formatter 重現以及針對嵌入 PowerShell 的 Docker 命令所提出的兩個 Pester 測試情境開始。追蹤格式化如何處理 Docker --secret 引數中的逗號。命令保持不變且所提出的測試通過,即表示完成。

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

評估

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

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

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