sindresorhus/eslint-plugin-unicorn

`prevent-abbreviations` - Allow multi-part exceptions

Closed

#1,839 opened on Jun 2, 2022

View on GitHubContributor guide
 (0 comments) (0 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

I want to allow this abbr elementRef: ElementRef as it a well known term in Angular

replacements:[
  // those don't work
   elementRef: false,
   ElementRef: false,
   Ref: false,

  // only this works
    ref: false
]

I want to allow ref inside elementRef only also, mixed-case should be respected, thus Ref should only match Ref and elementRef but not ref

elementRef in the configuration above doesn't match itself, but in docs:

Camelcase replacements will only match complete identifiers. For example errCb will only match errCb and ErrCb. It will not match fooErrCb or errCbFoo.

Contributor guide

Research direction
Examine the current implementation of the `prevent abbreviations` rule in `rules/prevent abbreviations.js` to understand how it matches exceptions. The rule currently only allows single word exceptions; modify the matching logic to support multi part exceptions like `elementRef` while preserving case sensitivity. Check the rule's documentation and test files for existing patterns.
Tech stack
javascript
Domain
developer experience
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.
Half day
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.
Clear
Prerequisites
JavaScriptESLint rule development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50