jsx-eslint/eslint-plugin-react

prop-types: children and React.VFC

Open

#2,913 opened on Feb 1, 2021

View on GitHubContributor guide
 (14 comments) (3 reactions) (0 assignees)JavaScript (2,731 forks)batch import
help wantedtypescript

Repository metrics

Stars
 (9,293 stars)
PR merge metrics
 (PR metrics pending)

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

Research direction
Study the existing prop types rule to understand how it infers the children prop from React.FC and then extend it to handle React.VFC. Look at TypeScript type definitions for React.VFC and React.FC. Also review related issue #7 for context.
Tech stack
javascripttypescriptreact
Domain
developer experiencetooling
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
JavaScriptTypeScriptESLint
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65