reactjs / reactjs/react-docgen
react-docgen is not compatible with react-like libraries
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
There are some react-like libraries such as react-lite, preact-compat and other which use API of React for components including PropTypes. All react-docgen methods work well with these libraries. But [this module](react-docgen disables work with react-like libraries) disallows using it.
I have a preact-compat component:
import { h, Component, PropTypes } from 'preact-compat';
export default class MyComponent extends Component {
render() {
return <div>{this.props.children}</div>;
}
}
MyComponent.propTypes = {
myProp: PropTypes.func
};
Actual react-docgen returns this value for type of myProp:
{
name: 'custom',
raw: 'PropTypes.func'
}
If I add preact-compat to whitelist react-docgen returns expected result:
{
type: 'func'
}
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 localizando el módulo que restringe las bibliotecas similares a React mediante una whitelist y, a continuación, reproduce el problema con el componente preact-compat proporcionado. Verifica el comportamiento existente de PropTypes.func y compáralo con la salida esperada; el trabajo estará terminado cuando las bibliotecas similares a React produzcan la misma información de tipos sin estar incluidas explícitamente en la whitelist.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- react, typescript
- Área
- documentation, tooling
- Tipo de issue
- Error
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100