reactjs / reactjs/react-docgen
The description of extended Props is not output correctly
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- TypeScript
- Estrellas
- 3.8k
- Forks
- 316
- Merge medio
- 5 h 7 min
- PR fusionados (30 d)
- 4
Descripción
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
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza reproduciendo el ejemplo de TypeScript con @react-docgen/cli@3.0.0 e inspecciona cómo se eligen las descripciones para las Props heredadas. Sigue el manejo de las Props extendidas y añade una prueba de regresión para el caso FooProps/BarProps. Se considera terminado cuando param1 usa "FooProps param1" y las descripciones de las Props heredadas y de las demás Props siguen siendo correctas.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- typescript
- Área
- documentation
- Tipo de issue
- Error
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 48/100