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
派生
414
平均合并
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 摘要。