PowerShell / PowerShell/PSScriptAnalyzer
`Invoke-ScriptAnalyzer` `-Severity` filters rules rather than diagnostics
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ả
The -Severity parameter of Invoke-ScriptAnalyzer does not do what it says it does.
Parameter help for the -Severity parameter says:
After running Script Analyzer with all rules, this parameter selects rule violations with the specified severity.
...
The parameter filters the rules violations only after running all rules.
...
In reality the parameter filters rules and not diagnostics; both have the concept of Severity (RuleSeverity, and DiagnosticSeverity)
How the -Severity parameter is ultimately used:
-
The user passes
-SeveritytoInvoke-ScriptAnalyzer. Value validated to be one of"Warning", "Error", "Information", "ParseError". -
The
ScriptAnalyzersingleton instance is initialised with this-Severitystring[]value, which is stored as a private member of the singleton object (severity). -
When analyzing a script, the engine determines which rules to run. It uses
IsRuleAllowed()to check each rule. -
IsRuleAllowed()gets a list ofallowedSeverities. It does so by callingGetAllowedSeveritiesInInt().Each
severity(an array of strings) is parsed into the underlyinguintvalue of theDiagnosticSeverityenum type.(I believe this should actually be
RuleSeverityenum. It works as both enums have identical members and underlyinguintvalues).
https://github.com/PowerShell/PSScriptAnalyzer/blob/aba29c31151925bd7180e7dfd578e1bfacdaf2a2/Engine/ScriptAnalyzer.cs#L1929-L1934 -
IsRuleAllowed()then callsIsSeverityAllowed(allowedSeverities, rule)as part of it's decision making on whether to execute a rule. Passing in the list ofallowedSeveritiesand the currentrulebeing considered. -
IsSeverityAllowed(..)then checks ifallowedSeveritiescontains therules severity (callingrule.GetSeverity()and casting it to auint). If it does the rule is allowed to run.
https://github.com/PowerShell/PSScriptAnalyzer/blob/aba29c31151925bd7180e7dfd578e1bfacdaf2a2/Engine/ScriptAnalyzer.cs#L1914-L1921
So there are 2 issues that need to be addressed:
-
There is a disparity between the documentation and implementation. Either:
- The documentation needs updating to match reality OR
- The implementation needs to be updated so
-Severityfilters the output ofDiagnosticRecords.
-
GetAllowedSeveritiesInInt()resolves severities usingDiagnosticSeverityand that is then used to compare torule.GetSeverity()which is aRuleSeverity. It works now as both enums are identical in their definition and are being cast to their underlyinguintvalue. If either was updated this could break. It also does not seem intentional.
@bergmeister - Should we update the documentation as a first pass and revisit behaviour later if it's desired? I will also get the enum corrected to RuleSeverity.
This explains the issue described in #2049 - where a custom rule is emitting error-level DiagnosticRecord but is not showing with -Severity Error, but is with -Severity Warning. -Severity is filtering the rules that are run (by their severity) and all custom rules have Warning severity.
n.b. I have typed the word severity so many times now that it no longer looks like a real word...
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 Engine/Commands/InvokeScriptAnalyzerCommand.cs và Engine/ScriptAnalyzer.cs, đặc biệt là phần khởi tạo mức độ nghiêm trọng và các điểm truy cập GetAllowedSeveritiesInInt(), IsSeverityAllowed() và IsRuleAllowed(). Xác nhận hành vi dự kiến khi lọc các rule thay vì DiagnosticRecords, sau đó đảm bảo tài liệu và việc xử lý mức độ nghiêm trọng phản ánh nhất quán quyết định đó.
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ó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức độ hoạt động
- Ít trao đổi
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 45/100