reactjs / reactjs/react-docgen
@defaultValue is not parsed from interface
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- TypeScript
- Sterne
- 3.8k
- Forks
- 316
- Ø Merge
- 5 Std. 7 Min.
- Gemergte PRs (30 T.)
- 4
Beschreibung
The following code tested in the playgroud https://react-docgen.dev/playground
interface Props {
/**
* The name to greet
*
* @defaultValue 'something'
*/
name: string;
}
/**
* Hello world component
*/
const MyComponent = (props: Props) => {
return <div />;
}
returns:
[
{
"description": "Hello world component",
"displayName": "MyComponent",
"methods": [],
"props": {
"name": {
"required": true,
"tsType": {
"name": "string"
},
"description": "The name to greet\n\n@defaultValue 'something'"
}
}
}
]
I think the defaultValue property is missing and should appear in the result, and part of the description "@defaultValue 'something'" should be removed.
[
{
"description": "Hello world component",
"displayName": "MyComponent",
"methods": [],
"props": {
"name": {
"required": true,
"tsType": {
"name": "string"
},
"description": "The name to greet",
"defaultValue": {
"value": "'something'",
"computed": false
}
}
}
}
]
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Reproduziere das TypeScript-Schnittstellenbeispiel im react-docgen Playground und prüfe, wie seine JSDoc-Tags geparst werden. Bestätige, dass @defaultValue aus der Beschreibung entfernt und als nicht berechnetes defaultValue mit dem erwarteten Wert ausgegeben wird; verwende die gezeigte Ausgabe als Abschlussprüfung.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- tooling
- Issue-Typ
- Bug
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Klar beschrieben
- Anfängerfreundlichkeit
- 48/100