dsl: add MatchComment method to the DSL module #222
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
AlekSi
reviewed
Apr 6, 2021
| Every **rule** definition starts with a [`Match()`](https://godoc.org/github.com/quasilyte/go-ruleguard/dsl#Matcher.Match) or [`MatchComment()`](https://godoc.org/github.com/quasilyte/go-ruleguard/dsl#Matcher.MatchComment) method call. | ||
|
|
||
| * For `Match()`, you specify one or more [AST patterns](https://github.com/mvdan/gogrep) that should represent what kind of Go code a rule is supposed to match. | ||
| * For `MatchComment()`, you provide one or more regular expressions that sould match a comment of interest. |
AlekSi
reviewed
Apr 6, 2021
|
|
||
| // Good. No information loss in this case. | ||
| // "// nolint foo bar" => "//nolint foo bar" | ||
| m.MatchComment(`// nolint(?P<rest>)`).Suggest(`//nolint$rest`) |
There was a problem hiding this comment.
In practice, that should be able to handle several spaces after // and optional :
There was a problem hiding this comment.
I removed this part from the docs.
See PR with actual implementation.
AlekSi
reviewed
Apr 6, 2021
| // Single-line // comments are passed line-by-line. | ||
| // | ||
| // Hint: if you want to match a plain text and don't want to do meta char escaping, | ||
| // prepend `\Q` to your pattern. `\Qf(x)` will match `f(x)` as a plain text |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.