ruleguard,analyzer: implement rules debugging #104
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/feature/add_debugging_mode
branch
3 times, most recently
from
acf031a
to
be591d4
Compare
When ruleguard is called with -debug-group=<string> arg, it'll print rejected matches explanations to the stderr for the specified rules group. By default, this argument is an empty string that means "no debug". Explanation includes: * Submatch nodes (with types) * Rejection reason (sometimes approx) * Rejected node location Here is an example of how explanations can look like: example.go:4: rejected by rules.go:6 ($s type filter) $s [10]int: a example2.go:9: rejected rules2.go:8 ($s2 is const) $s1 string: v1 $s2 string: "" example2.go:7: rejected rules2.go:8 ($s1 is not const) $s1 string: v1 $s2 string: v2 The debug output format is experimental and can change over time. Any feedback is appreciated. This change also adds Line:int and Group:string fields to the rules info. Line is a rules file line that declared this rule Group is a containing function name Refs #98 Signed-off-by: Iskander Sharipov <quasilyte@gmail.com>
quasilyte
force-pushed
the
quasilyte/feature/add_debugging_mode
branch
from
be591d4
to
6d996d5
Compare
cristaloleg
approved these changes
Oct 30, 2020
quasilyte
added a commit
to go-critic/go-critic
that referenced
this pull request
Oct 30, 2020
See quasilyte/go-ruleguard#104 for more detailed explanation of what "rules debugging" means. The ruleguard dependency was updated. When golangci-lint will be updated, it should be possible to debug rules from it as well (albeit it's less convenient). Here is a minimal example: linters: enable: - gocritic linters-settings: gocritic: enabled-checks: - ruleguard settings: ruleguard: rules: "rules.go" debug: <name> Signed-off-by: Iskander Sharipov <quasilyte@gmail.com>
quasilyte
added a commit
to go-critic/go-critic
that referenced
this pull request
Nov 7, 2020
See quasilyte/go-ruleguard#104 for more detailed explanation of what "rules debugging" means. The ruleguard dependency was updated. When golangci-lint will be updated, it should be possible to debug rules from it as well (albeit it's less convenient). Here is a minimal example: linters: enable: - gocritic linters-settings: gocritic: enabled-checks: - ruleguard settings: ruleguard: rules: "rules.go" debug: <name> Signed-off-by: Iskander Sharipov <quasilyte@gmail.com>
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.
When ruleguard is called with -debug-group= arg,
it'll print rejected matches explanations to the stderr
for the specified rules group.
By default, this argument is an empty string that means "no debug".
Explanation includes:
Here is an example of how explanations can look like:
The debug output format is experimental and can change over time.
Any feedback is appreciated.
This change also adds Line:int and Group:string fields to the rules info.
The debug output format is experimental and can change over time.
Any feedback is appreciated.
Refs #98
Signed-off-by: Iskander Sharipov quasilyte@gmail.com