checkers: add ruleguard checker #907
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
quasilyte
force-pushed
the
quasilyte/addChecker/ruleguard
branch
from
79280cb
to
ffa1ccb
Compare
|
I'm going to add tests as well. |
quasilyte
force-pushed
the
quasilyte/addChecker/ruleguard
branch
from
ffa1ccb
to
0d01422
Compare
|
Done. Now we have integration tests for ruleguard. |
cristaloleg
previously approved these changes
Mar 18, 2020
checkers/ruleguard_checker.go
Outdated
| Usage: "path to a gorules file", | ||
| }, | ||
| } | ||
| info.Summary = "Detects custom rules violations" |
There was a problem hiding this comment.
Sounds depressive. Allows users to define custom rules, WDYT ?
checkers/ruleguard_checker.go
Outdated
| } | ||
|
|
||
| func (c *ruleguardChecker) WalkFile(f *ast.File) { | ||
| // Rule set is nil if no rules were loaded from a rules file. |
checkers/ruleguard_checker.go
Outdated
| return c | ||
| } | ||
|
|
||
| // We can handle initialization errors easier when we make |
checkers/ruleguard_checker.go
Outdated
| fset := token.NewFileSet() | ||
| rset, err := ruleguard.ParseRules(rulesFilename, fset, bytes.NewReader(data)) | ||
| if err != nil { | ||
| log.Printf("init ruleguard: %v", err) |
There was a problem hiding this comment.
what about: ruleguard init error: %#v ? it's a bit easier to grep then.
| Sizes: c.ctx.SizesInfo, | ||
| Fset: c.ctx.FileSet, | ||
| Report: func(n ast.Node, msg string, _ *ruleguard.Suggestion) { | ||
| // TODO(quasilyte): investigate whether we should add a rule name as |
There was a problem hiding this comment.
imo - yes :) but it's a minor one
quasilyte
force-pushed
the
quasilyte/addChecker/ruleguard
branch
from
0d01422
to
dd33c1c
Compare
This is part of the ruleguard integration experiment. Hopefully, we can get some feedback to improve the way it's integrated. The simplest way to try it out: gocritic check -enable ruleguard -@ruleguard.rules <gorules> <target> Where: <gorules> is a path to a Go rules file <target> is a linting target An example gorules file can be found here: https://github.com/quasilyte/go-ruleguard/blob/master/rules.go Visit https://github.com/quasilyte/go-ruleguard for more info on the ruleguard. Updates #873 Updates #869 Updates #837 Updates #836 Updates #831 Signed-off-by: Iskander Sharipov <quasilyte@gmail.com>
quasilyte
force-pushed
the
quasilyte/addChecker/ruleguard
branch
from
dd33c1c
to
f09aa99
Compare
cristaloleg
approved these changes
Mar 18, 2020
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.
This is part of the ruleguard integration experiment.
Hopefully, we can get some feedback to improve the way it's integrated.
The simplest way to try it out:
Where:
An example gorules file can be found here: https://github.com/quasilyte/go-ruleguard/blob/master/rules.go
Visit https://github.com/quasilyte/go-ruleguard for more info on the ruleguard.
Updates #873
Updates #869
Updates #837
Updates #836
Updates #831
Signed-off-by: Iskander Sharipov quasilyte@gmail.com