PowerShell / PowerShell/PSScriptAnalyzer
PSAvoidUsingCmdletAliases triggers on GherkinStep
Chưa có ai nhận issue này.
- 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ả
Gherkin (including in Pester) has a few aliases which you are meant to use when creating steps.
Alias And -> GherkinStep 4.2.0 Pester
Alias But -> GherkinStep 4.2.0 Pester
Alias Given -> GherkinStep 4.2.0 Pester
Alias Then -> GherkinStep 4.2.0 Pester
Alias When -> GherkinStep 4.2.0 Pester
These are valid uses of the alias and shouldn't trigger analyzer warnings.
Steps to reproduce
Create a Gherkin (Pester) step file like Blah.Steps.ps1
Given "something" {
}
Then Invoke-ScriptAnalyzer Blah.Steps.ps1
Expected behavior
No issues.
Actual behavior
RuleName Severity ScriptName Line Message
-------- -------- ---------- ---- -------
PSAvoidUsingCmdletAliases Warning Blah.Steps 1 'Given' is an alias of 'GherkinStep'. Alias can introduce
.ps1 possible problems and make scripts hard to maintain. Please
consider changing alias to its full content.
Environment data
Name Value
---- -----
PSVersion 5.1.14393.1944
PSEdition Desktop
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0...}
BuildVersion 10.0.14393.1944
CLRVersion 4.0.30319.42000
WSManStackVersion 3.0
PSRemotingProtocolVersion 2.3
SerializationVersion 1.1.0.1
1.16.1
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
Tái hiện cảnh báo với ví dụ Blah.Steps.ps1 bằng cách chạy Invoke-ScriptAnalyzer, tập trung vào PSAvoidUsingCmdletAliases và các alias GherkinStep. Được xem là hoàn thành khi Given, And, But, When và Then được sử dụng làm các bước Gherkin của Pester không tạo ra vấn đề nào cho trình phân tích, trong khi các alias thông thường vẫn được rule bao phủ.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- csharp, 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
- Đặc tả rõ ràng
- Mức phù hợp với người mới
- 35/100