reactjs / reactjs/react-docgen
react-docgen generates platform specific structure
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
react-docgen --pretty -o lib/metadata.json src/components
On Windows produces:
{
"src\\components\\ExampleComponent.react.js": {
"description": "ExampleComponent is an example component.\r\nIt takes a single property, `label`, and\r\ndisplays it.",
"methods": [],
"props": {
"label": {
"type": {
"name": "string"
},
"required": true,
"description": "A label that will be printed when this component is rendered."
}
}
}
}
On Linux produces:
{
"src/components/ExampleComponent.react.js": {
"description": "ExampleComponent is an example component.\r\nIt takes a single property, `label`, and\r\ndisplays it.",
"methods": [],
"props": {
"label": {
"type": {
"name": "string"
},
"required": true,
"description": "A label that will be printed when this component is rendered."
}
}
}
}
This makes some scripts which use results of react-docgen for code generation fail. One example is plotly/dash component generator. Would you consider this is as a bug?
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 l’invocation de la CLI de react-docgen en utilisant src/components et lib/metadata.json, puis suivez l’endroit où les chemins des composants sont sérialisés. Comparez les exemples Windows et Linux et rendez les clés générées indépendantes de la plateforme ; vérifiez que les deux environnements produisent la même structure.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- react
- Domaine
- cli
- Type d'issue
- Bug
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 45/100