PowerShell / PowerShell/PSScriptAnalyzer
Invalid reformatting when docker command executed directly from PS
Aberta
Ninguém assumiu esta issue ainda.
Area - Formatter
- Linguagem predominante
- C#
- Estrelas
- 2.2k
- Forks
- 415
- Merge médio
- 13h 1min
- PRs com merge (30d)
- 2
Descrição
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
}
}
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Comece com a reprodução fornecida do Invoke-Formatter e os dois contextos de teste do Pester propostos para comandos Docker incorporados no PowerShell. Rastreie como a formatação trata a vírgula no argumento --secret do Docker. Está concluído quando o comando permanece inalterado e os testes propostos passam.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- docker, powershell
- Domínio
- tooling
- Tipo de issue
- Bug
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 45/100