The description of extended Props is not output correctly

Ouverte
#997 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
3/5
Temps estimé
1-2 jours
Accessibilité débutants
48/100
Type d'issue
Bug
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
typescript
Domaine
documentation

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.

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

Langage dominant
TypeScript
Étoiles
3.8k
Forks
316
Merge moyen
3 h 28 min
PR mergées (30 j)
6

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de reactjs/react-docgen

Toutes les issues de reactjs/react-docgen

Issues similaires

Plus d'issues TypeScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.