sindresorhus/eslint-plugin-unicorn

`prevent-abbreviations`: Smarter `whitelist` option possibly deprecating `ignore` option

Closed

#930 opened on Dec 9, 2020

View on GitHubContributor guide
 (1 comment) (6 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

There are now two options to exclude an identifier from linting: older whitelist and newer ignore. I think whitelist alone would suffice with the following modification.

We could make whitelist match any subsequence of the split identifier. For example (following up this https://github.com/sindresorhus/eslint-plugin-unicorn/issues/567#issuecomment-591007369): For fooE2eBar all of these would be checked against whitelist:

  • foo
  • e
  • 2
  • bar
  • barE
  • e2
  • 2e
  • eBar
  • fooE2
  • e2e
  • 2eBar
  • fooE2e
  • e2eBar
  • fooE2eBar

And if any of them is in the whitelist that subsequence is ignored.

But in my opinion it should not ignore the whole identifier if only subsequence matches whitelist.

For example, if the user had e2e in their whitelist, e2eErr should still be fixed to e2eError.

From https://github.com/sindresorhus/eslint-plugin-unicorn/pull/891#issuecomment-713729469

Contributor guide

Research direction
Investigate the current implementation of the prevent abbreviations rule, particularly the whitelist and ignore options. Review the linked PR #891 and comment #713729469 to understand prior discussions. Evaluate whether the proposed subsequence matching approach is feasible and if it can replace the ignore option. Consider edge cases like overlapping subsequences and impact on performance. Then propose a design and implement the change.
Tech stack
javascript
Domain
tooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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
Knowledge of ESLint plugin developmentUnderstanding of prevent abbreviations ruleFamiliarity with Node.js and JavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30