sindresorhus/eslint-plugin-unicorn

prevent-abbreviations: when multiple replacements are defined, suggest each through ESLint's suggest API

Closed

#767 opened on Jun 3, 2020

View on GitHubContributor guide
 (4 comments) (3 reactions) (0 assignees)JavaScript (468 forks)user submission
enhancementhelp wanted

Repository metrics

Stars
 (5,022 stars)
PR merge metrics
 (Avg merge 1d 16h) (399 merged PRs in 30d)

Description

Currently, the prevent-abbreviations autofixer only applies when there is only a single replacement defined. But when multiple replacements are there (if the abbreviation is ambiguous) the violation has to be fixed manually.

It would be nice if the replacements were all suggested to the user in the editor/IDE to pick from. ESLint has the suggest API for this: https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions

Contributor guide

Research direction
Examine the current implementation of the `prevent abbreviations` rule in eslint plugin unicorn to understand how it handles replacements. Then, implement the ESLint suggestion API (https://eslint.org/docs/developer guide/working with rules#providing suggestions) to offer each possible replacement as a suggestion when multiple replacements are defined for an abbreviation. Refer to the issue discussion and the rule source code.
Tech stack
javascript
Domain
developer experiencetooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
familiarity with ESLint plugin developmentunderstanding of suggestion API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40