Invalid reformatting when docker command executed directly from PS
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 45/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- docker, powershell
- Domain
- tooling
Research direction
Start with the supplied Invoke-Formatter reproduction and the two proposed Pester test contexts for Docker commands embedded in PowerShell. Trace how formatting handles the comma in the Docker --secret argument. Done means the command remains unchanged and the proposed tests pass.
Written by the indexing model from the issue text.
Description
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
}
}
- Dominant language
- C#
- Stars
- 2.2k
- Forks
- 415
- Avg merge
- 13h 1m
- Merged PRs (30d)
- 2
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from PowerShell/PSScriptAnalyzer
-
Up-for-Grabs
Difficulty 1/5 1-3 hours Newbie friendliness 78/100
PowerShell/PSScriptAnalyzer#2213 · 2 comments ·
-
Difficulty 3/5 1-2 days Newbie friendliness 72/100
PowerShell/PSScriptAnalyzer#2217 · 1 comment ·
-
PSUseConsistentIndentation double-indents attribute bodies that open a scriptblock (`[Attr({ … })]`) Open
Difficulty 3/5 1-2 days Newbie friendliness 70/100
PowerShell/PSScriptAnalyzer#2216 · 2 comments ·
-
Difficulty 3/5 1-2 days Newbie friendliness 68/100
PowerShell/PSScriptAnalyzer#2211 ·
-
`PSPlaceOpenBrace` and `PSPlaceCloseBrace` leave trailing whitespace when expanding one-line blocks Open
Difficulty 3/5 1-2 days Newbie friendliness 70/100
PowerShell/PSScriptAnalyzer#2210 ·
All issues in PowerShell/PSScriptAnalyzer
Similar issues
-
:watch: Not Triaged dotnet-fsharp/svc
Difficulty 1/5 Under an hour Newbie friendliness 90/100
-
Client customer-reported needs-team-attention question Service Attention WebPubSub
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Azure/azure-sdk-for-net#63292 · 3 comments · 1 reaction ·
-
Issue-Enhancement Needs-Triage
Difficulty 1/5 Under an hour Newbie friendliness 86/100
PowerShell/PowerShell#28061 · 2 reactions ·
-
dependencies needs-team-triage server-Azure.Mcp
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
aspnet-core/svc aspnetcore-signalr/subsvc doc-enhancement Pri2 SignalR
Difficulty 1/5 Under an hour Newbie friendliness 88/100
dotnet/AspNetCore.Docs#37729 ·