jsx-eslint/eslint-plugin-react

react/boolean-prop-naming interface does not work

Open

#3,285 opened on May 9, 2022

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

Repository metrics

Stars
 (8,630 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Examine the rule implementation in eslint plugin react to see how it traverses type definitions; note that it works with `type` but not `interface`. Look for where Props type is resolved and ensure interfaces are handled similarly.
Tech stack
javascripttypescriptreact
Domain
backend api design
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
TypeScriptESLintReact
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60