React-Docgen: Make error-handling more gentle #25055
Merged
+28
−9
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
valentinpalkovic
added
bug
addon: docs
builder-webpack5
ci:daily
yannbf
reviewed
Nov 30, 2023
valentinpalkovic
added
the
patch:yes
36 tasks
valentinpalkovic
added a commit
that referenced
this pull request
Nov 30, 2023
…r-handling React-Docgen: Make error-handling more gentle
Merged
4 tasks
This was referenced Nov 30, 2023
Merged
Merged
shilman
added
the
patch:done
8 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #25053
What I did
Storybook 7.6, we have replaced the babel-plugin-react-docgen plugin with a custom Webpack5 loader, which works independently of the used compiler (SWC, Babel, ...). The loader throws an Error, though, as soon as a file cannot be processed.
An Error is not thrown anymore but instead log a warning to the user. In --loglevel=debug mode a stack trace should be available to report bug reports for react-docgen.
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
yarn install(Node 20)packages/lib-classifierand runyarn installyarn storybook-> it should failpreset-react-webpackfrom the monorepo and swap out the filesyarn storybook loglevel=debug-> Now a stacktrace is shown as wellDocumentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.tsMake 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/coreteam 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>