reactjs / reactjs/react-docgen

Handle Complex Unions and Intersections

Offen
#453 0 Kommentare 8 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

Currently react-docgen doesn't handle some more complex cases for typescript Props

Screen Shot 2020-04-25 at 4 38 12 PM

I help maintain react-docgen-typescript where I recently implemented this

Here is our bustling collection of valid typescript react component tests

Here is the code that made it possible

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 mit der verlinkten react-docgen-typescript-Implementierung von parser.ts und ihrer Sammlung src/tests/data gültiger TypeScript-React-Komponentenfälle. Vergleiche diese Fälle mit dem parser und den Tests von react-docgen, um die fehlende Verarbeitung komplexer Unions und Intersections zu identifizieren. Als erledigt gilt die Aufgabe, wenn diese Prop-Typen korrekt extrahiert werden, ohne bestehende Fälle zu beeinträchtigen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
react, typescript
Bereich
documentation
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

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