reactjs / reactjs/react-docgen
Support for CSS Modules
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 3.8k
- Forks
- 316
- Avg merge
- 5h 7m
- Merged PRs (30d)
- 4
Description
Hi guys!
React Scripts already support CSS Modules
https://create-react-app.dev/docs/adding-a-css-modules-stylesheet
When I tried creating documentations via react-docgen. This error is displayed:
READING FILE: D:\workspaces-mobilize\steamfabuilib\src\components\CampaignMarketingForm\CampaignMarketingForm.js
D:\workspaces-mobilize\steamfabuilib\src\components\Styles\emoji-mart.module.css:1
(function (exports, require, module, __filename, __dirname) { .emoji-mart,
^
SyntaxError: Unexpected token .
It seems that css treated via CSS Modules is not supported by react-docgen. Can you have feedbacks from it? Thanks
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Reproduce the failure with the reported CampaignMarketingForm.js and Styles/emoji-mart.module.css inputs, starting from react-docgen's file-reading path. Determine how CSS Modules should be handled during documentation generation, then verify that the CSS syntax no longer causes a parsing error.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- css, react
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100