typetools / typetools/checker-framework
Need to we have unique checker: prefix for suppressions to differentiate from checkstyle:
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 1.1k
- Forks
- 440
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 134
Description
For a Java project, which uses both Checkstyle and Checkers Framework, there is a need for ease of maintenance and gradual code quality improvements to differentiate in easy way which Suppressions belong to which part.
For checkstyle example is such identifiable by "checkstyle:" prefix:
@SuppressWarnings("checkstyle:RecordComponentNumber")
For Checkers FW (without usage of -ArequirePrefixInWarningSuppressions flag) is such:
@SuppressWarnings("argument")
and so for Checkers FW would like to have some dedicated flag like:
-AglobalPrefixInWarningSuppressions="checker:"
and/or have that by default to be handled by Checkers FW if specified inside @SuppressWarnings clause.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing how Checkers Framework handles @SuppressWarnings and the existing -ArequirePrefixInWarningSuppressions flag. Compare that behavior with the checkstyle: example and determine the intended semantics for a checker: prefix or a global prefix option. Done means the requested suppression-prefix behavior is specified and consistently supported.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- devtools
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100