reactjs / reactjs/react-docgen
When postcss modules are present, in some scenarios react-docgen tries to parse css files
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
Background
In certain scenarios react-docgen tries to parse CSS modules.
This yields an error as follows:
Use case
See related Storybook issue https://github.com/storybookjs/storybook/issues/25662 and stackblitz reproduction https://stackblitz.com/edit/github-cwovgn-yvzreq
Have a component like so
import React from "react"
import styles, { stylesheet } from "./Container.module.css"
const Container = ({ children }) => (
<div>
{children}
</div>
)
export default Container;
export stylesheet;
And where the css file contains an @import
@import url("../../css/variables.css");
The babel config passed to react-docgen doesn't take into account the .babelrc file and attempts to parse the .css file as JavaScript.
This causes an error like so
[vite] Internal server error: /path/to/Container.module.css: Support for the experimental syntax 'decorators' isn't currently enabled (1:1):
Is there anyway to configure react-docgen to ignore .css files in this case?
If you're wondering why are we importing and exporting the processed stylesheet, we're building a critical css component that inlines CSS needed for the first paint. We're doing this by using rollup-post-css-modules to import postcss modules but also export the built stylesheet so it can be collated in a reliable fashion (ie the class names don't change from what is rendered in the component).
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 con la reproducción enlazada de StackBlitz y el issue relacionado de Storybook; después, rastrea cómo react-docgen utiliza la configuración de Babel proporcionada cuando el componente importa y exporta un módulo CSS. El trabajo estará terminado cuando el archivo CSS ya no se analice como JavaScript y la extracción de documentación para el componente React siga funcionando.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- react, typescript
- Área
- tooling
- Tipo de issue
- Error
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 45/100