Skip to content

chore: Linter rule for properly formatted api errors #2123

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jun 7, 2022
Merged

chore: Linter rule for properly formatted api errors #2123

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
6970d2b
chore: Linter rule for properly formatted api errors
Emyrk Jun 7, 2022
0ca30a0
Fix all linting errors
Emyrk Jun 7, 2022
0e66d8a
Update comment
Emyrk Jun 7, 2022
5134987
Fix error check in test
Emyrk Jun 7, 2022
b813011
fixup! Fix error check in test
Emyrk Jun 7, 2022
173cf26
Remove comment
Emyrk Jun 7, 2022
1b2ef83
Add omitempty to 'Detail' field
Emyrk Jun 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update comment
  • Loading branch information
@Emyrk
Emyrk committed Jun 7, 2022
commit 0e66d8a5bdc037fee96f1bbac99d1211093eed90
7 changes: 6 additions & 1 deletion scripts/rules.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,12 +120,17 @@ func InTx(m dsl.Matcher) {
// error messages for the api. A proper sentence includes proper capitalization
// and ends with punctuation.
// There are ways around the linter, but this should work in the common cases.
// Example:
// Message:
func HttpAPIErrorMessage(m dsl.Matcher) {
m.Import("github.com/coder/coder/coderd/httpapi")

isNotProperError := func(v dsl.Var) bool {
return v.Type.Is("string") &&
// Either starts with a lowercase, or ends without punctuation
// Either starts with a lowercase, or ends without punctuation.
// The reason I don't check for NOT ^[A-Z].*[.!?]$ is because there
// are some exceptions. Any string starting with a formatting
// directive (%s) for example is exempt.
(m["m"].Text.Matches(`^"[a-z].*`) ||
m["m"].Text.Matches(`.*[^.!?]"$`))
}
Expand Down