Automattic / Automattic/harper
Linters that have "opposite" linters should offer to "switch over" as well as current "disable".
- Dominant language
- Rust
- Stars
- 15.4k
- Forks
- 627
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 102
Description
A few linters have ad-hoc two-way or multi-way settings. (See this feature request about adding proper support for them: https://github.com/Automattic/harper/issues/2396)
- `OxfordComma` vs `NoOxfordComma`
- `ViciousCycle` vs `ViciousCircle` vs `ViciousCircleOrCycle`
When one of these gets flagged and the user doesn't share Harper's default setting, they should be able to switch it over right there instead of needing to hunt through the settings.
What users probably do now is just turn it off, not realizing that they can have the other version that they don't like suggested as corrections for the one Harper has by default.
Contributor guide
Research direction
Start by reading the linked feature request in issue #2396, then locate the implementations of OxfordComma, NoOxfordComma, ViciousCycle, ViciousCircle, and ViciousCircleOrCycle. Compare their current disable action with the settings behavior. Done means users who do not share Harper’s default can switch to the alternative directly from a flagged finding.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100