jsx-eslint/eslint-plugin-react

ElementConfig should be used to determine props required

Open

#1904 opened on Jul 26, 2018

View on GitHub
 (3 comments) (6 reactions) (0 assignees)JavaScript (8,630 stars) (2,797 forks)batch import
flowhelp wantedtypescript

Description

ESLint currently uses ElementProps to determine what types are required by a component with Flow-annotated props, but it should be using ElementConfig instead.

See Using Default Props for Functional Components in Flow's docs for an explanation of why. See also their comparison of ElementProps and ElementConfig.

@ljharb suggested I open an issue here to get it changed.

Contributor guide

Tech stack
javascriptreact
Domain
frontendtooling
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
React propsESLint plugin structureFlow type basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Identify which rule uses `ElementProps` (likely a rule like `require default props`). Review Flow docs on `ElementConfig` vs `ElementProps`. Modify the rule to use `ElementConfig`, ensuring backward compatibility. Check the test suite for the rule and add tests. Refer to the maintainer's comment for context.