React: Upgrade react-docgen
to v7
#24530
Merged
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 N/A
What I did
A couple notes about the test/story:
react-docgen-typescript
by default, so you won't actually see the bug innext
and the fix in this branch. However, in 8.0 when we makereact-docgen
the default it will be tested.babel-plugin-react-docgen
, which has not been updated to 7.0, so it is showing the old value. This should also be updated in the future. Or the test should be fixed.Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
In the
react-vite-default-ts
sandbox, updatemain.ts
to usereact-docgen
for generating argTypes:Also, change the CLI template
Button
component definition to:Browse the auto-generated controls on the Button stories. Remove the manually specified args and argTypes in the stories and verify that the controls still show up. (These will disappear using
react-docgen@6
which is included in SB 7.5).You may need to clear
yarn.lock
and reinstall the sandbox or regenerate from scratch to make sure you're using the right version.Documentation
MIGRATION.MD
🦋 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>