sindresorhus/eslint-plugin-unicorn

Inconsistency in rule option names ("checkFoo" vs "ignoreFoo")

Open

#881 opened on Oct 20, 2020

View on GitHub
 (1 comment) (1 reaction) (0 assignees)JavaScript (5,022 stars) (468 forks)user submission
docsenhancementhelp wanted

Description

Grepping the docs for "ignore" and "check" I find these option names:

  • With "ignore":
    • expiring-todo-comments:
      • ignoreDatesOnPullRequests
    • import-index:
      • ignoreImports
  • With "check":
    • prevent-abbreviations:
      • checkDefaultAndNamespaceImports
      • checkShorthandImports
      • checkProperties
      • checkDefaultAndNamespaceImports
      • checkVariables
      • checkFilenames
    • no-null:
      • checkStrictEquality
    • import-style:
      • checkImport
      • checkDynamicImport
      • checkExportFrom
      • checkRequire
    • no-keyword-prefix:
      • checkProperties

The "check" names seem to win for now, so I think all new options should be named like "checkFoo" instead of "ignoreFoo". Not sure should we and how to automatically enforce this, maybe with a prevent-abbreviations replacement.

Contributor guide

Tech stack
javascriptnodejs
Domain
toolingdeveloper experience
Issue type
refactor
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.
mostly clear
Prerequisites
ESLint plugin developmentknowledge of unicorn rules
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Review the rule options listed in the issue, then examine the source code of each rule (e.g., rules/prevent abbreviations.js, rules/no null.js) to identify all occurrences of 'check' and 'ignore' prefixes. Determine the preferred convention (checkFoo) and rename all 'ignoreFoo' options accordingly. Update the documentation for each rule. Consider using a codemod to automate renaming for users. No linked PRs or comments indicating ongoing work.