sindresorhus/eslint-plugin-unicorn

Rule proposal: `id-match`

Closed

#1,545 opened on Oct 11, 2021

View on GitHubContributor guide
 (9 comments) (1 reaction) (0 assignees)JavaScript (468 forks)user submission
help wantednew rule

Repository metrics

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

Description

When working with external libraries, it is often undesirable to rename their exports for the sole purpose of conforming with id-match rule.

This has been proposed as addition to ESLint in https://github.com/eslint/eslint/issues/14005, but ultimately it was rejected:

I think this falls under our policies of not adding new options to stylistic rules, so in my opinion the best course of action would be to make a custom rule/plugin.

This rule would be equivalent to id-match with an additional option ignoreImports that would ignore named imports.

Fail

Assuming that rule does not permit IDs with $:

const ContraImageFragment$key = '';

Pass

Assuming that this rule is configured to ignore imports:

import type { ContraImageFragment$key } from '@/__generated__/ContraImageFragment.graphql';

Happy to contribute to the codebase.

Contributor guide

Research direction
Review the existing id match rule implementation in ESLint core and in eslint plugin unicorn. Look at other rules with similar 'ignoreImports' options for pattern. Examine the linked ESLint issue (eslint/eslint#14005) for detailed reasoning. Then implement an additional option to ignore named imports in the id match rule.
Tech stack
javascript
Domain
toolingdeveloper 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
Node.jsJavaScriptESLint plugin development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60