typetools / typetools/checker-framework

Purity warning checker name

Open
#2,581 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
1.1k
Forks
440
Avg merge
1d 12h
Merged PRs (30d)
134

Description

It is surprising that when -AcheckPurityAnnotations and -ArequirePrefixInWarningSuppressions are supplied, purity warnings are prefixed by a specific checker name, such as "fenum:purity..." or "formatter:purity...". I feel it would be better if they were prefixed by "purity:".

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by searching the Java sources for -AcheckPurityAnnotations, -ArequirePrefixInWarningSuppressions, and the "purity:" warning prefix. Trace how the checker name is selected for purity warnings and identify the relevant tests. Done means purity warnings consistently use the "purity:" prefix when these options are supplied, with tests covering the changed behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
devtools
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.