Support for CSS Modules

Open
#388 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
css, react
Domain
documentation, tooling

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.

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

Dominant language
TypeScript
Stars
3.8k
Forks
316
Avg merge
3h 28m
Merged PRs (30d)
6

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from reactjs/react-docgen

All issues in reactjs/react-docgen

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.