jsx-eslint/eslint-plugin-react

prop-types Validating external propTypes (eg. decorators)

Open

#322 geöffnet am 19. Nov. 2015

Auf GitHub ansehen
 (13 Kommentare) (7 Reaktionen) (0 zugewiesene Personen)JavaScript (8.630 Stars) (2.797 Forks)batch import
enhancementhelp wantedrule

Beschreibung

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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
3-5 days
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
mostly clear
Voraussetzungen
Understanding of ESLint plugin architectureFamiliarity with React propTypesKnowledge of decorators syntaxExperience parsing AST with ESLint
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
30
Research-Richtung
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.