reactjs / reactjs/react-docgen
The description of extended Props is not output correctly
Personne n'a encore pris cette issue.
- Langage dominant
- TypeScript
- Étoiles
- 3.8k
- Forks
- 316
- Merge moyen
- 5 h 7 min
- PR mergées (30 j)
- 4
Description
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
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par reproduire l’exemple TypeScript avec @react-docgen/cli@3.0.0 et examinez la manière dont les descriptions sont choisies pour les Props héritées. Suivez le traitement des Props étendues et ajoutez un test de régression pour le cas FooProps/BarProps. C’est terminé lorsque param1 utilise "FooProps param1" tandis que les descriptions des Props héritées et des autres Props restent correctes.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- typescript
- Domaine
- documentation
- Type d'issue
- Bug
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 48/100