jsx-eslint/eslint-plugin-react

prop-types Validating external propTypes (eg. decorators)

Open

#322 opened on Nov 19, 2015

View on GitHub
 (13 comments) (7 reactions) (0 assignees)JavaScript (2,797 forks)batch import
enhancementhelp wantedrule

Repository metrics

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

Description

This is something that comes from loggur/react-redux-provide#1 as propTypes are used to actually define data that will be provided to the component like this:

@provide({
  list: PropTypes.arrayOf(PropTypes.object).isRequired,
  pushItem: PropTypes.func.isRequired
})
export default class GoodTimes extends Component {
}

That doesn't coop well with this rule unfortunately. I am wondering if there is a way how to analyze this and read propTypes from higher-order component / decorator also.

I have noticed some undocumented customValidators, but I am not sure how does that works. If I understand correctly it accepts list of props that will be ignored?

Contributor guide

Research direction
Investigate how ESLint rules traverse decorators in the AST. Look at the decorator node in the parser (Babel/TypeScript) and extract propTypes from the argument of the @provide decorator. Understand the structure of the rule `prop types` and modify it to check decorator provided props.
Tech stack
javascriptreact
Domain
frontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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
ESLintReactJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50