jsx-eslint/eslint-plugin-react

Object composition in propTypes causes 'default-props-match-prop-types' error

Open

#1,674 opened on Feb 2, 2018

View on GitHub
 (13 comments) (15 reactions) (0 assignees)JavaScript (8,630 stars) (2,797 forks)batch import
bugenhancementhelp wanted

Description

Consider the following functioning example:

elementEventCardBaseShape = {
  calendarLink: mediaFileShape,
  mapLink: PropTypes.string,
  startDate: PropTypes.string,
  locationName: PropTypes.string,
  street: PropTypes.string,
  city: PropTypes.string,
  region: PropTypes.string
};

ElementEventCard.propTypes = {
  ...elementEventCardBaseShape,
  lang: PropTypes.string
};

ElementEventCard.defaultProps = {
  lang: 'en',
  calendarLink: {},
  mapLink: '',
  startDate: '',
  locationName: '',
  street: '',
  city: '',
  region: ''
};

Where all but 'lang' throw an error for said prop supposedly having no matching propType. Am I missing something?

Contributor guide

Tech stack
reactjavascript
Domain
toolingdeveloper experience
Issue type
bug
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
Reacteslint plugin reactPropTypes
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Investigate the rule `default props match prop types` in eslint plugin react, specifically how it resolves propTypes when object spread (e.g., `...elementEventCardBaseShape`) is used. Look at the rule source code in `lib/rules/default props match prop types.js` and trace the logic for detecting propTypes definitions. Consider similar issues or PRs that may have explored this. The issue reports a false positive when defaultProps are provided for props defined via spread.