jsx-eslint/eslint-plugin-react

prop-types: children and React.VFC

Open

#2913 opened on Feb 1, 2021

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

Description

There is now a way to properly communicate the absence of the children prop at the TypeScript level: React.VFC (vs React.FC). React.VFC aka React.VoidFunctionComponent does not allow children prop, the prop-types rule should derive the presence/absence of children from the underlying TypeScript types (when used with TypeScript).

Related: #7.

Contributor guide

Tech stack
javascripttypescriptreact
Domain
frontend
Issue type
feature
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
Understanding of React TypeScript typesFamiliarity with eslint plugin react internals
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
The issue requests extending the prop types rule to support React.VFC, which does not allow children prop. Start by reviewing the existing prop types rule implementation (likely in lib/rules/prop types.js) and the related issue #7 for context. Look for how the plugin currently infers type definitions from TypeScript. Consider adding detection of React.VFC (or React.VoidFunctionComponent) and updating the logic to recognize that these types imply no children prop. The solution involves parsing TypeScript types within the AST and checking the component's type reference.