reactjs / reactjs/react-docgen
Nested type descriptions
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
Sorry if this has been reported before in some form before, but is there currently support for nested type descriptions? For example, given the following structure (using Flow and react-docgen@5.3.1):
type Panel = {
/** Panel title */
title: string,
/** Panel content */
content: string,
/** Sublevels of more Panels */
panels: Array<Panel>
};
type Props = {
/** One or more toggleable Panels */
panels: Array<Panel>
}
/** Hello World! */
const Component = (props: Props) => { ... }
^ Does not generate any description for the Panel -props. Is this intentional? The output for a Panel is:
{
"name": "signature",
"type": "object",
"raw": "{ ... }",
"signature": {
"properties": [
{
"key": "title",
"value": {
"name": "string",
"required": true
}
},
{
"key": "content",
"value": {
"name": "string",
"required": true
}
},
{
"key": "panels",
"value": {
"name": "Array",
"elements": [{ "name": "Panel" }],
"raw": "Array<Panel>",
"required": true
}
}
]
}
}
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 Flow de l’issue avec react-docgen@5.3.1 et examinez la signature générée pour Panel. Aucun fichier source ni test n’est indiqué dans le rapport ; le travail est considéré comme terminé lorsque les propriétés imbriquées de Panel conservent leurs descriptions dans la sortie générée, avec une couverture pour la structure présentée.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- react, typescript
- Domaine
- documentation, frontend
- Type d'issue
- Fonctionnalité
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100