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 (8,630 stars) (2,797 forks)batch import
enhancementhelp wantedrule

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

Tech stack
javascriptreact
Domain
toolingdeveloper experience
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.
3-5 days
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.
mostly clear
Prerequisites
Understanding of ESLint plugin architectureFamiliarity with React propTypesKnowledge of decorators syntaxExperience parsing AST with ESLint
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Investigate the current prop types rule implementation in eslint plugin react, specifically how it validates PropTypes on class components and how decorators are handled by ESLint's parser. Look at the linked issue loggur/react redux provide#1 for context. Check if there are any existing discussions or attempted PRs. Consider using AST selectors to detect PropTypes defined in decorators and integrate them into the validation logic.