tools/agentlint: add linter for river tags #2891
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tpaschalis
reviewed
Feb 1, 2023
| Run: run, | ||
| } | ||
|
|
||
| var noLintRegex = regexp.MustCompile(`//\s*nolint:rivertags`) |
There was a problem hiding this comment.
In some places in our codebase we do something like this: //nolint:golint,rivertags. Can we amend the regex to catch this as well?
There was a problem hiding this comment.
Sure! Doing it at the regex level felt ugly, but I changed my approach to support this 👍
tpaschalis
reviewed
Feb 1, 2023
| } else if len(nameParts) > 1 { | ||
| diagnostics = append(diagnostics, "attr field names must not contain `.`") | ||
| } | ||
| for _, name := range nameParts { |
There was a problem hiding this comment.
There's always going to be 1 element in nameParts here, right?
There was a problem hiding this comment.
Yeah, I'm iterating over it anyway just in case they incorrectly put more than one, it's still useful (imo) to show the various errors across all the name fragments..
github-actions
bot
added
the
frozen-due-to-age
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Extend tools/agentlint with a linter for
rivertags, which will help catch improper usages of tags where unit tests for unmarshaling aren't present (first seen in #2629).Linting rules can be skipped when necessary by adding a
//nolint:rivertagscomment.