-
Notifications
You must be signed in to change notification settings - Fork 4.9k
Fix deprecations for Storybook component usage #74619
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
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| /** | ||
| * External dependencies | ||
| */ | ||
| // eslint-disable-next-line @typescript-eslint/no-restricted-imports | ||
| import { createElement } from 'react'; | ||
| import { addons, types, useStorybookApi } from 'storybook/manager-api'; | ||
| import { JumpToIcon } from '@storybook/icons'; | ||
| import { Button } from 'storybook/internal/components'; | ||
|
|
||
| const ADDON_ID = '@wordpress/storybook-addon-source-link'; | ||
|
|
||
| const SourceLinkTool = () => { | ||
| const api = useStorybookApi(); | ||
| const storyData = api.getCurrentStoryData(); | ||
|
|
||
| let sourcePath; | ||
| if ( storyData?.parameters?.sourceLink ) { | ||
| sourcePath = storyData.parameters.sourceLink; | ||
| } else if ( storyData?.importPath ) { | ||
| // importPath is like "../packages/components/src/button/stories/index.story.tsx" | ||
| // Convert to component directory path: "packages/components/src/button" | ||
| sourcePath = storyData.importPath | ||
| .replace( /^\.\.\//, '' ) // Remove leading "../" | ||
| .replace( /^\.\//, '' ) // Remove leading "./" (for stories in storybook folder) | ||
| .replace( /\/stories\/.*$/, '' ); // Remove "/stories/..." suffix | ||
| } | ||
|
|
||
| if ( ! sourcePath ) { | ||
| return null; | ||
| } | ||
|
|
||
| const href = `https://github.com/WordPress/gutenberg/blob/trunk/${ sourcePath }`; | ||
|
|
||
| return createElement( | ||
| Button, | ||
| { | ||
| ariaLabel: 'Open source file', | ||
| title: 'Open source file', | ||
| asChild: true, | ||
| }, | ||
| createElement( 'a', { href }, createElement( JumpToIcon ) ) | ||
| ); | ||
| }; | ||
|
|
||
| addons.register( ADDON_ID, () => { | ||
| addons.add( `${ ADDON_ID }/tool`, { | ||
| type: types.TOOL, | ||
| title: 'Source Link', | ||
| render: SourceLinkTool, | ||
| } ); | ||
| } ); | ||
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| import { fileURLToPath } from 'node:url'; | ||
|
|
||
| export const managerEntries = [ | ||
| fileURLToPath( import.meta.resolve( './manager.ts' ) ), | ||
| ]; |
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
May be some day we may build the addons before running storybook to allow JSX here, making them more readable.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I had spent a bit of time trying to see if we could revert these back to
.tsxto no avail. To your point, and consistent withADDON_IDused here and the other addon, these could make sense as their own standalone packages, and we could have a prebuild step before referencing them.To the lint disabling itself, we could probably add an exception for this top-level folder, since it's expected we'd be using
reactand not@wordpress/elementhere.