PowerShell / PowerShell/PSScriptAnalyzer
Invalid reformatting when docker command executed directly from PS
Đang mở
Chưa có ai nhận issue này.
Area - Formatter
- Ngôn ngữ chính
- C#
- Star
- 2.2k
- Fork
- 414
- Merge trung bình
- 13 giờ 1 phút
- Pull request đã merge (30 ngày)
- 2
Mô tả
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
}
}
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu với bản tái hiện Invoke-Formatter được cung cấp và hai ngữ cảnh kiểm thử Pester được đề xuất cho các lệnh Docker được nhúng trong PowerShell. Theo dõi cách quá trình định dạng xử lý dấu phẩy trong đối số --secret của Docker. Hoàn tất khi lệnh không thay đổi và các kiểm thử được đề xuất đều đạt.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- docker, powershell
- Lĩnh vực
- tooling
- Loại issue
- Lỗi
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 45/100