reactjs / reactjs/react-docgen
When postcss modules are present, in some scenarios react-docgen tries to parse css files
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
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).
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
Beginnen Sie mit der verlinkten StackBlitz-Reproduktion und dem zugehörigen Storybook-Issue. Verfolgen Sie dann, wie react-docgen die bereitgestellte Babel-Konfiguration verwendet, wenn die Komponente ein CSS-Modul importiert und exportiert. Die Aufgabe ist abgeschlossen, wenn die CSS-Datei nicht mehr als JavaScript geparst wird, während die Dokumentationsextraktion für die React-Komponente weiterhin funktioniert.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- react, typescript
- Bereich
- tooling
- Issue-Typ
- Bug
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100