reactjs / reactjs/react-docgen
The description of extended Props is not output correctly
Nessuno ha ancora preso questa issue.
- Lingua principale
- TypeScript
- Stelle
- 3.8k
- Fork
- 316
- Merge medio
- 5h 7m
- PR unite (30g)
- 4
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
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
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.
Valutazione
- Stack tecnologico
- typescript
- Ambito
- documentation
- Tipo di issue
- Bug
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 48/100