Add convenience functions for ErrorsCount, WarningsCount, Errors andWarnings
#392
Conversation
diag/diagnostics.go
Outdated
| func (diags Diagnostics) ErrorsCount() int { | ||
| count := 0 | ||
|
|
||
| for _, d := range diags { | ||
| if SeverityError == d.Severity() { | ||
| count++ | ||
| } | ||
| } | ||
|
|
||
| return count | ||
| } | ||
|
|
||
| // WarningsCount returns the number of Diagnostic in Diagnostics that are SeverityWarning. | ||
| func (diags Diagnostics) WarningsCount() int { |
There was a problem hiding this comment.
Nit: both those *Count methods could be implemented as a len(Call_to_non_Count_methods).
There was a problem hiding this comment.
Good point. Fixed.
.changelog/392.txt
Outdated
| @@ -0,0 +1,3 @@ | |||
| ```release-note:feature | |||
There was a problem hiding this comment.
Nit: Typically features are "big" features whereas enhancements cover everything else
| ```release-note:feature | |
| ```release-note:enhancement |
| expected diag.Diagnostics | ||
| } | ||
| tests := map[string]testCase{ | ||
| "errors": { |
There was a problem hiding this comment.
Nit: Might be good to check what happens when:
- There is a
nildiag.Diagnostics, it should return nil or emptydiag.Diagnostics - There is an empty
diag.Diagnostics, it should return emptydiag.Diagnostics - There are only warning diagnostics, it should return empty
diag.Diagnostics
There was a problem hiding this comment.
Added additional test coverage.
| expected diag.Diagnostics | ||
| } | ||
| tests := map[string]testCase{ | ||
| "errors": { |
There was a problem hiding this comment.
Nit: Might be good to check what happens when:
- There is a
nildiag.Diagnostics, it should return nil or emptydiag.Diagnostics - There is an empty
diag.Diagnostics, it should return emptydiag.Diagnostics - There are only error diagnostics, it should return empty
diag.Diagnostics
There was a problem hiding this comment.
Added additional test coverage.
| expected int | ||
| } | ||
| tests := map[string]testCase{ | ||
| "errors": { |
There was a problem hiding this comment.
Nit: Similar to the Errors testing, I think we should cover some additional cases just to ensure it returns 0 instead of panics, etc.
There was a problem hiding this comment.
Added additional test coverage.
| expected int | ||
| } | ||
| tests := map[string]testCase{ | ||
| "errors": { |
There was a problem hiding this comment.
Nit: Similar to the Warning testing, I think we should cover some additional cases just to ensure it returns 0 instead of panics, etc.
There was a problem hiding this comment.
Added additional test coverage.
One use-case is in the instance where we're running |
|
To add to the "use cases": it's useful when writing tests to count the expected errors, instead of just checking |
|
I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions. |
Closes: #391
Adds the following convenience functions to Diagnostics:
ErrorsCount()WarningsCount()Errors()Warnings()