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

Webpack5: Add react-docgen loader and remove babel-plugin-react-docgen #24762

Merged
merged 3 commits into from
Nov 9, 2023

Conversation

valentinpalkovic
Copy link
Contributor

@valentinpalkovic valentinpalkovic commented Nov 8, 2023

Closes #24750

What I did

In Webpack5-based projects, the babel-plugin-react-docgen plugin is used to generate types for Javascript and Typescript components. In the future, the Webpack5 builder will not only support Babel, but another compiler like SWC. Therefore, we have to change the implementation of this transformation for being compiler agnostic.

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!

  1. Run a Webpack5-based sandbox
  2. Go to .storybook/main.ts and change set { typescript: { react-docgen: "react-docgen" }}
  3. Controls are properly generated in Storybook

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 force-pushed the valentin/create-react-docgen-webpack5-loader branch from a43f865 to 184e159 Compare November 8, 2023 11:27
Base automatically changed from valentin/create-export-order-webpack5-loader to next November 8, 2023 13:16
@valentinpalkovic valentinpalkovic self-assigned this Nov 8, 2023
@valentinpalkovic valentinpalkovic added feature request builder-webpack5 ci:daily Run the CI jobs that normally run in the daily job. react labels Nov 8, 2023
@yannbf
Copy link
Member

yannbf commented Nov 9, 2023

Hey @valentinpalkovic seems like there are quite some substantial changes in the metadata output (as can be seen in Chromatic), is that intended?

image

@valentinpalkovic
Copy link
Contributor Author

@yannbf the changes are intended! We will use react-docgen in v7 now instead of v5, which was pinned via the babel plugin

@valentinpalkovic
Copy link
Contributor Author

@yannbf Otherwise ok?!

@valentinpalkovic valentinpalkovic merged commit 4f527a8 into next Nov 9, 2023
107 checks passed
@valentinpalkovic valentinpalkovic deleted the valentin/create-react-docgen-webpack5-loader branch November 9, 2023 14:52
@github-actions github-actions bot mentioned this pull request Nov 9, 2023
30 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
builder-webpack5 ci:daily Run the CI jobs that normally run in the daily job. feature request react
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rewrite babel-plugin-react-docgen as a webpack-loader
3 participants