TypeScript: migrate a11y package to TS #70680
Open
Conversation
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
39 tasks
|
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. |
There was a problem hiding this comment.
This looks good. I have some minor suggestions for further improvements
Here is the final result of my suggestion
diff --git a/packages/a11y/src/test/index.test.ts b/packages/a11y/src/test/index.test.ts
index 64b2718e54..99cff2204f 100644
--- a/packages/a11y/src/test/index.test.ts
+++ b/packages/a11y/src/test/index.test.ts
@@ -25,16 +25,12 @@ jest.mock( '../shared/filter-message', () => {
} );
describe( 'speak', () => {
- let containerPolite = document.getElementById(
- 'a11y-speak-polite'
- ) as HTMLElement;
- let containerAssertive = document.getElementById(
- 'a11y-speak-assertive'
- ) as HTMLElement;
+ let containerPolite = document.getElementById( 'a11y-speak-polite' );
+ let containerAssertive = document.getElementById( 'a11y-speak-assertive' );
beforeEach( () => {
- containerPolite.textContent = '';
- containerAssertive.textContent = '';
+ containerPolite!.textContent = '';
+ containerAssertive!.textContent = '';
} );
describe( 'on import', () => {
@@ -80,7 +76,7 @@ describe( 'speak', () => {
setup();
containerAssertive = document.getElementById(
'a11y-speak-assertive'
- ) as HTMLElement;
+ );
} );
it( 'should set the textcontent of the polite aria-live region', () => {
@@ -94,18 +90,16 @@ describe( 'speak', () => {
describe( 'when somehow the both containers are not present', () => {
beforeEach( () => {
- containerAssertive.remove();
- containerPolite.remove();
+ containerAssertive?.remove();
+ containerPolite?.remove();
} );
afterEach( () => {
setup();
- containerPolite = document.getElementById(
- 'a11y-speak-polite'
- ) as HTMLElement;
+ containerPolite = document.getElementById( 'a11y-speak-polite' );
containerAssertive = document.getElementById(
'a11y-speak-assertive'
- ) as HTMLElement;
+ );
} );
Comment on lines
+28
to
+33
| let containerPolite = document.getElementById( | ||
| 'a11y-speak-polite' | ||
| ) as HTMLElement; | ||
| let containerAssertive = document.getElementById( | ||
| 'a11y-speak-assertive' | ||
| ) as HTMLElement; |
There was a problem hiding this comment.
Let us avoid this assertion here and make the other relevant changes.
Suggested change
| let containerPolite = document.getElementById( | |
| 'a11y-speak-polite' | |
| ) as HTMLElement; | |
| let containerAssertive = document.getElementById( | |
| 'a11y-speak-assertive' | |
| ) as HTMLElement; | |
| let containerPolite = document.getElementById( 'a11y-speak-polite' ); | |
| let containerAssertive = document.getElementById( 'a11y-speak-assertive' ); |
| ) as HTMLElement; | ||
| let containerAssertive = document.getElementById( | ||
| 'a11y-speak-assertive' | ||
| ) as HTMLElement; | ||
|
|
||
| beforeEach( () => { | ||
| containerPolite.textContent = ''; |
There was a problem hiding this comment.
Both of these here will need to have non-null assertions
Suggested change
| containerPolite.textContent = ''; | |
| containerPolite!.textContent = ''; |
| } ); | ||
|
|
||
| afterEach( () => { | ||
| setup(); | ||
| containerAssertive = document.getElementById( | ||
| 'a11y-speak-assertive' | ||
| ); | ||
| ) as HTMLElement; |
There was a problem hiding this comment.
Suggested change
| ) as HTMLElement; | |
| ); |
| containerPolite = document.getElementById( 'a11y-speak-polite' ); | ||
| containerPolite = document.getElementById( | ||
| 'a11y-speak-polite' | ||
| ) as HTMLElement; |
There was a problem hiding this comment.
Apart from this, we will need to use optional chainning inside beforeEach above.
Suggested change
| ) as HTMLElement; | |
| ); |
| containerAssertive = document.getElementById( | ||
| 'a11y-speak-assertive' | ||
| ); | ||
| ) as HTMLElement; |
There was a problem hiding this comment.
Suggested change
| ) as HTMLElement; | |
| ); |
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?
Part of #67691
Migrating the a11y package to TypeScript.
Why?
To enhance DX and add type safety.
How?
By porting the code and tests to TypeScript.
Testing Instructions
Typecheck and unit tests.