sindresorhus/eslint-plugin-unicorn

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

Open

#881 建立於 2020年10月20日

在 GitHub 查看
 (1 留言) (1 反應) (0 負責人)JavaScript (5,022 star) (468 fork)user submission
docsenhancementhelp wanted

描述

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.

貢獻者指南

技術棧
javascriptnodejs
領域
toolingdeveloper experience
議題類型
refactor
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
ESLint plugin developmentknowledge of unicorn rules
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
30
研究方向
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.