TypeScript: migrate jest-console package to TS by kushagra-goyal-14 · Pull Request #70538 · WordPress/gutenberg

kushagra-goyal-14 · 2025-06-26T22:49:19Z

What?

Part of #67691

Migrating the jest-console 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.

- remove js test file - add spaces and fix docs

github-actions · 2025-06-27T14:15:12Z

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 props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: kushagra-goyal-14 <kush123@git.wordpress.org>
Co-authored-by: manzoorwanijk <manzoorwanijk@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

manzoorwanijk · 2025-07-04T09:20:44Z

+			expect( ( spy as any ).assertionsNumber ).toBe( 0 );

 			console[ methodName ]( message );

 			expect( console )[ matcherName ]();
-			expect( spy.assertionsNumber ).toBe( 1 );
+			expect( ( spy as any ).assertionsNumber ).toBe( 1 );

 			expect( console )[ matcherNameWith ]( message );
-			expect( spy.assertionsNumber ).toBe( 2 );
+			expect( ( spy as any ).assertionsNumber ).toBe( 2 );


Why do we need these any assertions here? I think those can be removed.

Yes, I have removed those unnecessary types from the tests.

…onsole tests

kushagra-goyal-14 · 2025-07-09T07:04:32Z

Hey @manzoorwanijk ,

Thank you for the review.

I have updated the PR with the changes. Can you please re-review or ship the PR whenever possible.

manzoorwanijk

I still see some as any assertions but I am not sure if we can entirely get rid of all of those.

kushagra-goyal-14 · 2025-07-10T08:15:43Z

I still see some as any assertions but I am not sure if we can entirely get rid of all of those.

Here, there are some cases with usage of as any, because the property assertionsNumber doesn't exist for the jest spy definition, thus I have used as any there.

manzoorwanijk

unknown is a safer type than any because it narrows the scope instead of expanding it.

So, let us use unknown where we don't really know the type.

We can also improve some any types with some properly defined types.

manzoorwanijk · 2025-07-11T05:22:36Z

+	calls: any[][];
+	matcherName: string;
+	methodName: string;
+	expected?: any[];


Suggested change

calls: any[][];

matcherName: string;

methodName: string;

expected?: any[];

calls: unknown[][];

matcherName: string;

methodName: string;

expected?: unknown[];

manzoorwanijk · 2025-07-11T05:22:54Z

+	spy: Mock,
+	matcherName: string,
+	methodName: string,
+	expected?: any[]


Suggested change

expected?: any[]

expected?: unknown[]

manzoorwanijk · 2025-07-11T05:25:22Z

+	( matcherName: string, methodName: string ) => ( received: any ) => {
+		const spy = received[ methodName ] as Mock;


We can get rid of any type and the assertion

Suggested change

( matcherName: string, methodName: string ) => ( received: any ) => {

const spy = received[ methodName ] as Mock;

( matcherName: string, methodName: string ) =>

( received: Record< string, Mock > ) => {

const spy = received[ methodName ];

manzoorwanijk · 2025-07-11T05:26:07Z

+	function ( received: any, ...expected: any[] ) {
+		const spy = received[ methodName ] as Mock;


Suggested change

function ( received: any, ...expected: any[] ) {

const spy = received[ methodName ] as Mock;

function ( received: Record< string, Mock >, ...expected: unknown[] ) {

const spy = received[ methodName ];

manzoorwanijk · 2025-07-11T05:29:34Z

 			};
 		},
-		{}
+		{} as Record< string, any >


Instead of this assertion here, I would pass this as the first argument to th .reduce generic

Record< string, ( received: Record< string, Mock > ) => { pass: boolean; message: () => string; } >

So, the .reduce call would look like this

Object.entries( supportedMatchers ).reduce< Record< string, ( received: Record< string, Mock > ) => { pass: boolean; message: () => string; } > >(/* Arguments here */);

kushagra-goyal-14 · 2025-07-11T14:10:15Z

I've implemented the suggested changes to improve type safety in the jest-console package. Created a dedicated types.ts file with proper interfaces, replaced any with unknown where appropriate, and used more specific types throughout the codebase.

cc: @manzoorwanijk

manzoorwanijk

We also need to update the types field in package.json for the package to build-types but also handle the existing types/index.d.ts, which IMHO can be changed to declarations.d.ts and included via files field in tsconfig.json.

… package configuration

manzoorwanijk

Perfect. Thanks

Co-authored-by: kushagra-goyal-14 <kush123@git.wordpress.org> Co-authored-by: manzoorwanijk <manzoorwanijk@git.wordpress.org>

aduth · 2025-08-14T14:34:11Z

I wonder if this might have regressed the availability of typings for Jest matchers in downstream projects that use this package?

In @wordpress/jest-console@8.26.0 (before this change), I could configure TypeScript compilerOptions.types to include "@wordpress/jest-console", and get types for the matcher:

With the latest version (8.28.0) including these changes, the types are no longer found:

I suspect it may be related to the change here to move the Jest Matchers types originally in types/index.d.ts to src/declarations.d.ts. As far as I can tell, these declarations are no longer available in the published package.

Compare types root between 8.26.0 and 8.28.0:

Edit: Trying to explore a fix at #71215

refactor: migrate jest-console package from js to ts for type safety

5801b93

t-hamano mentioned this pull request Jun 25, 2025

Convert packages to TypeScript #67691

Open

41 tasks

t-hamano added [Type] Code Quality Issues or PRs that relate to code quality [Tool] Jest console /packages/jest-console labels Jun 27, 2025

kushagra-goyal-14 and others added 2 commits June 27, 2025 19:24

fix: fix unit tests

df93b19

- remove js test file - add spaces and fix docs

Merge branch 'trunk' into try/migrate-jest-console-ts

0a0f51f

kushagra-goyal-14 marked this pull request as ready for review June 27, 2025 14:15

kushagra-goyal-14 requested review from ajitbohra, gziolo, nerrad and ntwb as code owners June 27, 2025 14:15

kushagra-goyal-14 added 2 commits June 30, 2025 12:11

Merge branch 'trunk' into try/migrate-jest-console-ts

1141923

Merge branch 'trunk' into try/migrate-jest-console-ts

bf1b8f4

manzoorwanijk reviewed Jul 4, 2025

View reviewed changes

fix: remove unnecessary type assertion for assertionsNumber in jest-c…

44aa270

…onsole tests

kushagra-goyal-14 requested a review from manzoorwanijk July 4, 2025 10:15

manzoorwanijk reviewed Jul 10, 2025

View reviewed changes

manzoorwanijk requested changes Jul 11, 2025

View reviewed changes

kushagra-goyal-14 added 2 commits July 11, 2025 18:59

feat: add ExtendedMock type and refactor matcher functions to use it

5c627f2

fix: remove unnecessary comment about return type in matchers.ts

7b00a26

kushagra-goyal-14 requested a review from manzoorwanijk July 11, 2025 14:11

manzoorwanijk requested changes Jul 18, 2025

View reviewed changes

kushagra-goyal-14 and others added 2 commits July 24, 2025 14:03

feat: add TypeScript declarations for custom Jest matchers and update…

28300d7

… package configuration

Merge branch 'trunk' into try/migrate-jest-console-ts

daebc36

kushagra-goyal-14 requested a review from manzoorwanijk July 24, 2025 09:14

manzoorwanijk approved these changes Jul 24, 2025

View reviewed changes

manzoorwanijk merged commit 8227e4b into WordPress:trunk Jul 24, 2025
61 checks passed

github-actions Bot added this to the Gutenberg 21.4 milestone Jul 24, 2025

aduth mentioned this pull request Aug 14, 2025

jest-console: Fix TypeScript types being available in published package #71215

Closed

		( matcherName: string, methodName: string ) => ( received: any ) => {
		const spy = received[ methodName ] as Mock;

		function ( received: any, ...expected: any[] ) {
		const spy = received[ methodName ] as Mock;

Uh oh!

Conversation

kushagra-goyal-14 commented Jun 26, 2025

What?

Why?

How?

Testing Instructions

Uh oh!

github-actions Bot commented Jun 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

manzoorwanijk Jul 4, 2025

Choose a reason for hiding this comment

Uh oh!

kushagra-goyal-14 Jul 4, 2025

Choose a reason for hiding this comment

Uh oh!

kushagra-goyal-14 commented Jul 9, 2025

Uh oh!

manzoorwanijk left a comment

Choose a reason for hiding this comment

Uh oh!

kushagra-goyal-14 commented Jul 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

manzoorwanijk left a comment

Choose a reason for hiding this comment

Uh oh!

manzoorwanijk Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

manzoorwanijk Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

manzoorwanijk Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

manzoorwanijk Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

manzoorwanijk Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

kushagra-goyal-14 commented Jul 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

manzoorwanijk left a comment

Choose a reason for hiding this comment

Uh oh!

manzoorwanijk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

aduth commented Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

github-actions Bot commented Jun 27, 2025 •

edited

Loading

kushagra-goyal-14 commented Jul 10, 2025 •

edited

Loading

kushagra-goyal-14 commented Jul 11, 2025 •

edited

Loading

aduth commented Aug 14, 2025 •

edited

Loading