reactjs / reactjs/react-docgen

wrong `composes` for propType objects that are wrapped

Offen
#283 0 Kommentare 5 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
TypeScript
Sterne
3.8k
Forks
316
Ø Merge
5 Std. 7 Min.
Gemergte PRs (30 T.)
4

Beschreibung

Hello!

when defining prop types people do all sorts of things, for example:

import omit from 'lodash/omit';
import OtherComponent from 'important/path';

export default class Component extends React.PureComponent {
  propTypes = {
    ...omit(OtherComponent.propTypes, ['exclude', 'us']),
    something: bool
  };

  // ...
}
Expected

composes array is ['important/path']

Actual

composes array is ['lodash/omit']


i'm not even sure how this should be handled.
In example above it seems that extracting first argument from function
should be enough. But what if the composed prop types are not first
argument?

Should react-docgen support such cases at all? It seems valid to do so
from JS perspective but generated documentation is incomplete.

Recently https://github.com/reactjs/react-docgen/issues/248 was closed, so perhaps this issue should be considered too.

Thanks for the library!

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit nachzuverfolgen, wie react-docgen das composes-Array aus umschlossenen Prop-Type-Ausdrücken ableitet, und verwende das Beispiel omit(OtherComponent.propTypes, ...) als Reproduktion. Vergleiche das erwartete Ergebnis important/path mit dem tatsächlichen Ergebnis lodash/omit und ermittle, wie nicht an erster Stelle stehende zusammengesetzte Argumente behandelt werden sollen. Als erledigt gilt die Aufgabe, wenn das Verhalten definiert und für die unterstützten Fälle umschlossener Ausdrücke abgedeckt ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript, react
Bereich
documentation
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.