Guide: refactor to TypeScript
#47493
Merged
+180
−35
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
flootr
added
[Type] Code Quality
|
Size Change: +16 B (0%) Total Size: 1.34 MB
ℹ️ View Unchanged
|
mirka
reviewed
Jan 31, 2023
Comment on lines
+53
to
+86
| pages = | ||
| Children.map( children, ( child ) => ( { |
There was a problem hiding this comment.
I wish we had a readonly for prop reassignment 😅
| @@ -17,6 +17,7 @@ import { focus } from '@wordpress/dom'; | |||
| import Modal from '../modal'; | |||
| import Button from '../button'; | |||
| import PageControl from './page-control'; | |||
| import type { GuideProps } from './types'; | |||
|
|
|||
| export default function Guide( { | |||
There was a problem hiding this comment.
This function needs to be named before the default export statement for the Storybook docgen to kick in.
function Guide( {
/* ... */
}
export default Guide;This will make the type data show up in the props table in Storybook Docs view. And could we also add a main JSDoc to the component like the others?
|
Flaky tests detected in 35c3d5a. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/4314356626
|
flootr
force-pushed
the
refactor/guide-typescript
branch
from
843cc06
to
62f7bf1
Compare
ciampo
reviewed
Feb 6, 2023
There was a problem hiding this comment.
Hey @flootr , would you also mind updating the component's README so that it's in sync with the JSDocs from types.ts ? In particular:
- all props should be listed
- we should update prop types to be more precise, using TypeScript types where possible (e.g from
functionto( event?: KeyboardEvent< HTMLDivElement > | SyntheticEvent ) => void, fromarrayto{ content: ReactNode; image?: ReactNode; }[]etc..) - we should double check which props are marked as required and which optional
- we should double check that the default value is listed too
Thank you! 🙏
flootr
force-pushed
the
refactor/guide-typescript
branch
from
62f7bf1
to
82d2080
Compare
|
@ciampo I think all feedback should be addressed. Let me know if there's anything else :) |
ciampo
approved these changes
Mar 1, 2023
packages/components/CHANGELOG.md
Outdated
| @@ -45,6 +45,7 @@ | |||
| - `Navigator`: add more pattern matching tests, refine existing tests ([47910](https://github.com/WordPress/gutenberg/pull/47910)). | |||
| - `ToolsPanel`: Refactor Storybook examples to TypeScript ([47944](https://github.com/WordPress/gutenberg/pull/47944)). | |||
| - `ToolsPanel`: Refactor unit tests to TypeScript ([48275](https://github.com/WordPress/gutenberg/pull/48275)). | |||
| - `Guide`: Convert to TypeScript ([#47493](https://github.com/WordPress/gutenberg/pull/47493)). | |||
There was a problem hiding this comment.
Looks like this needs to be moved again under the newer Unreleased section of the CHANGELOG
There was a problem hiding this comment.
Yes. Fixed via 737ab84
flootr
force-pushed
the
refactor/guide-typescript
branch
from
82d2080
to
bbf3264
Compare
Co-authored-by: Lena Morita <lena@jaguchi.com>
Co-authored-by: Lena Morita <lena@jaguchi.com>
ciampo
force-pushed
the
refactor/guide-typescript
branch
from
bbf3264
to
35c3d5a
Compare
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.
What?
Refactor the
Guidecomponent to TypeScriptPart of #35744
Why?
The refactor to TypeScript has many benefits (auto-generated docs, static linting and error prevention, better IDE experience). See #35744 for more details
How?
Followed the steps highlighted in the TypeScript migration guide.
Testing Instructions