Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Webpack: Fix exclude regex in react-docgen-loader #25030

Merged
merged 1 commit into from
Nov 29, 2023

Conversation

valentinpalkovic
Copy link
Contributor

Closes #25023

What I did

The exclude regex for the react-docgen-loader was not working properly for Windows users.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

@valentinpalkovic valentinpalkovic added bug react patch:yes Bugfix & documentation PR that need to be picked to main branch addon: docs windows ci:normal labels Nov 29, 2023
@valentinpalkovic valentinpalkovic force-pushed the valentin/fix-react-docgen-loader-for-windows branch from 5580032 to 21b933d Compare November 29, 2023 08:57
@valentinpalkovic valentinpalkovic merged commit 0fa30d8 into next Nov 29, 2023
59 of 60 checks passed
@valentinpalkovic valentinpalkovic deleted the valentin/fix-react-docgen-loader-for-windows branch November 29, 2023 09:56
storybook-bot pushed a commit that referenced this pull request Nov 29, 2023
…loader-for-windows

Webpack: Fix exclude regex in react-docgen-loader
(cherry picked from commit 0fa30d8)
storybook-bot pushed a commit that referenced this pull request Nov 29, 2023
…loader-for-windows

Webpack: Fix exclude regex in react-docgen-loader
(cherry picked from commit 0fa30d8)
storybook-bot pushed a commit that referenced this pull request Nov 29, 2023
…loader-for-windows

Webpack: Fix exclude regex in react-docgen-loader
(cherry picked from commit 0fa30d8)
storybook-bot pushed a commit that referenced this pull request Nov 29, 2023
…loader-for-windows

Webpack: Fix exclude regex in react-docgen-loader
(cherry picked from commit 0fa30d8)
storybook-bot pushed a commit that referenced this pull request Nov 29, 2023
…loader-for-windows

Webpack: Fix exclude regex in react-docgen-loader
(cherry picked from commit 0fa30d8)
storybook-bot pushed a commit that referenced this pull request Nov 29, 2023
…loader-for-windows

Webpack: Fix exclude regex in react-docgen-loader
(cherry picked from commit 0fa30d8)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Nov 29, 2023
@ovflowd
Copy link

ovflowd commented Nov 29, 2023

I have the feeling that this change might have broken our setup.

Module build failed (from ./node_modules/@storybook/preset-react-webpack/dist/loaders/react-docgen-loader.js):
SyntaxError: ./navigation.json: Missing semicolon. (2:9)

  1 | {
> 2 |   "about": {
    |          ^
  3 |     "link": "/about",
  4 |     "translationId": "components.header.links.about",
  5 |     "items": {
    at constructor (./node_modules/@babel/parser/lib/index.js:356:19)

Not sure if this is related at all, but started happening when updating from Storybook 7.5.3 to 7.6.1; Will check if happens on 7.6.0

@ovflowd
Copy link

ovflowd commented Nov 29, 2023

Hmm, disabling reactDocGen did the trick here. Unsure, but I know that this place is probably not the best to report this sort of issues.

@valentinpalkovic
Copy link
Contributor Author

@ovflowd Thanks for the bug report. Indeed, in 7.6.0 as soon as react-docgen encounters an error (in this case it tries to process a json file), it throws instead of swallowing it. I will change this behaviour tomorrow though to not throw an uncoverable error, but instead to just continue. I will release a hotfix tomorrow with the fix!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
addon: docs bug ci:normal patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch react windows
Projects
None yet
3 participants