Convert token-list package to TypeScript #61575
Conversation
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
|
👋 Thanks for your first Pull Request and for helping build the future of Gutenberg and WordPress, @jpstevens! In case you missed it, we'd love to have you join us in our Slack community. If you want to learn more about WordPress development in general, check out the Core Handbook full of helpful information. |
github-actions
bot
added
the
First-time Contributor
Mamaduka
added
[Type] Enhancement
gziolo
added
the
Good First Review
There was a problem hiding this comment.
👋 @jpstevens Thanks for this! If you'll update this PR on the latest trunk and remove types from JSDoc, we can likely give this a final review and land it.
| @@ -64,7 +64,7 @@ describe( 'token-list', () => { | |||
|
|
|||
| it( 'sets to stringified value', () => { | |||
| const list = new TokenList(); | |||
| list.value = undefined; | |||
| list.value = undefined as unknown as string; | |||
There was a problem hiding this comment.
For a case like this, I'd go with expect error. We know the type is wrong and we expect to have an error reported:
| list.value = undefined as unknown as string; | |
| // @ts-expect-error The value should be a string, for testing we pass a "bad" value. | |
| list.value = undefined; |
| @@ -4,49 +4,45 @@ | |||
| * @see https://dom.spec.whatwg.org/#domtokenlist | |||
| */ | |||
| export default class TokenList { | |||
| private _currentValue: string; | |||
| private _valueAsArray: string[]; | |||
|
|
|||
| /** | |||
| * Constructs a new instance of TokenList. | |||
| * | |||
| * @param {string} initialValue Initial value to assign. | |||
There was a problem hiding this comment.
All the types that have moved into TypeScript syntax should be removed from JSDoc annotations like this:
| * @param {string} initialValue Initial value to assign. | |
| * @param initialValue Initial value to assign. |
What?
This PR converts the
token-listpackage to TypeScript.Why?
Ensures package is fully type checked.
How?
.ts@type,@paramand@returncommentsTesting Instructions
npm run test:unit -- packages/token-listtests passnpm run build:package-typesreturns a zero exit code