jsx-eslint/eslint-plugin-react

react/boolean-prop-naming interface does not work

Open

#3,285 建立於 2022年5月9日

在 GitHub 查看
 (14 留言) (21 反應) (0 負責人)JavaScript (8,630 star) (2,797 fork)batch import
enhancementhelp wantedtypescript

描述

The react/boolean-prop-naming rule does not work when using an interface with TypeScript but it works with a type

This shows an error like it should:

type Props = {
  done: boolean; // Shows error
}

This doesn't show an error like it should:

interface Props {
  done: boolean; // No error
}

My usage of the rule:

"react/boolean-prop-naming": [
      "error",
      {
        "rule": "^(is|has)[A-Z]([A-Za-z0-9]?)+",
        "message": "It is better if your prop ({{ propName }}) starts with `is` or `has`"
      }
    ],

Versions:

  • eslint - 8.15.0
  • eslint-plugin-react 7.29.4

貢獻者指南

技術棧
javascripttypescriptreact
領域
developer experiencefrontend
議題類型
bug
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
active
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Basic knowledge of ESLint plugin architectureUnderstanding of TypeScript ASTFamiliarity with react/boolean prop naming rule
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
40
研究方向
Investigate the implementation of the react/boolean prop naming rule in the eslint plugin react repository. The bug is that the rule fails to detect boolean props when using TypeScript interfaces but works with type aliases. Look at the rule's source code, likely in lib/rules/boolean prop naming.js, to understand how it extracts prop types. Check if it uses TypeScript's type checker differently for interfaces vs types. Add a test case with an interface to reproduce the issue and then modify the rule to handle TSInterfaceDeclaration nodes similarly to TSTypeAliasDeclaration. Review any existing comments or linked issues for additional context.