reactjs / reactjs/react-docgen
HOC as a function won't get generated docs
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
Similar to #177 but a slightly different scenario...
Given a HOC method like so:
import { bool } from 'prop-types';
const withSomeExtraProps = Wrapped => {
class HigherOrderComponent extends Component {
static propTypes = Object.assign({}, Wrapped.propTypes, {
/**
* This should be picked up in the docgenInfo
*/
anExtraProp: bool,
});
static defaultProps = Object.assign({}, Wrapped.defaultProps, {
anExtraProp: false,
});
// ....the rest of the HOC logic
}
return HigherOrderComponent;
}
export default withSomeExtraProps;
I understand that this wouldn't automatically mean that the export default withSomeExtraProps(Wrapped) wouldn't automatically get the docgenInfo from the HOC added, but I thought individually this HOC would have it's own docgenInfo that I could reference on it's own.
However, it seems the inner component class here doesn't get recognised and parsed. Does the component class need to be exported for the parser to find it?
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 HOC del issue y sigue cómo el parser procesa la clase del componente interno. Confirma el comportamiento esperado de docgenInfo y añade cobertura que muestre que la prop adicional del HOC se reconoce; el informe no menciona ningún archivo ni prueba existente.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- javascript, react
- Área
- documentation, tooling
- Tipo de issue
- Error
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100