jsx-eslint/eslint-plugin-react

Allow prop-types rule to skip non-exported SFCs

Open

#494 opened on Mar 9, 2016

View on GitHub
 (20 comments) (5 reactions) (0 assignees)JavaScript (8,630 stars) (2,797 forks)batch import
help wantednew rule

Description

From the docs:

For now we should detect components created with:

  • React.createClass()
  • an ES6 class that inherit from React.Component or Component
  • a stateless function that return JSX or the result of a React.createElement call.

It would be great if we could enforce propTypes being defined on React.createClass() and React.Component-extended components, but not stateless functions which return JSX.

In fact, defining .propTypes in function use such as { arr.map((name, i) => <Row key={ i }>{ name }</Row>) } would increase verbosity considerably

Contributor guide

Tech stack
javascriptreact
Domain
toolingfrontend
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
React propTypesESLint rule developmentJavaScript AST
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Examine the prop types rule implementation in lib/rules/prop types.js. Understand how it currently detects components (React.createClass, ES6 classes, stateless functions). Research the discussion in the issue comments for proposed approaches to skip non exported SFCs. Consider modifying the rule to check whether a component is exported before requiring propTypes.