The description of extended Props is not output correctly

Aperta
#997 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
48/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
typescript
Ambito
documentation

Direzione di ricerca

Inizia riproducendo l'esempio TypeScript con @react-docgen/cli@3.0.0 e verifica come vengono scelte le descrizioni per le Props ereditate. Segui la gestione delle Props estese e aggiungi un test di regressione per il caso FooProps/BarProps. Il lavoro è completato quando param1 usa "FooProps param1", mentre le descrizioni delle Props ereditate e delle altre Props rimangono corrette.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

I created FooProps by extending BarProps, but the description of FooProps is not used; instead, the description of BarProps is adopted.

Input

export interface BarProps {
  /** BarProps param1 */
  param1: any;
}

export interface FooProps extends BarProps {
  /** FooProps param1 */
  param1: string;
  /** FooProps param2 */
  param2: string;
}

export const Foo = (props: FooProps) => {
  return <div>foo</div>;
};

output

{
  "./src/foo.tsx": [
    {
      "description": "",
      "methods": [],
      "displayName": "Foo",
      "props": {
        "param1": {
          "required": true,
          "tsType": {
            "name": "string"
          },
          "description": "BarProps param1"
        },
        "param2": {
          "required": true,
          "tsType": {
            "name": "string"
          },
          "description": "FooProps param2"
        }
      }
    }
  ]
}

The props.param1.description should be "FooProps param1" instead of "BarProps param1".

Tested on @react-docgen/cli@3.0.0

Lingua principale
TypeScript
Stelle
3.8k
Fork
316
Merge medio
3h 28m
PR unite (30g)
6

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di reactjs/react-docgen

Tutte le issue di reactjs/react-docgen

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.