jsx-eslint/eslint-plugin-react

react/boolean-prop-naming interface does not work

Open

#3285 opened on May 9, 2022

View on GitHub
 (14 comments) (21 reactions) (0 assignees)JavaScript (8,630 stars) (2,797 forks)batch import
enhancementhelp wantedtypescript

Description

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

Contributor guide

Tech stack
javascripttypescriptreact
Domain
developer experiencefrontend
Issue type
bug
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.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic knowledge of ESLint plugin architectureUnderstanding of TypeScript ASTFamiliarity with react/boolean prop naming rule
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
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.