TypeScript: migrate jest-console package to TS

packages/jest-console/src/index.js → packages/jest-console/src/index.ts

@@ -7,28 +7,30 @@ import supportedMatchers from './supported-matchers';
 /**
  * Sets spy on the console object's method to make it possible to fail test when method called without assertion.
  *
- * @param {Array}  args
- * @param {string} args."0" Name of console method.
- * @param {string} args."1" Name of Jest matcher.
+ * @param args
  */
-const setConsoleMethodSpy = ( [ methodName, matcherName ] ) => {
+const setConsoleMethodSpy = ( args: [ string, string ] ) => {
+	const [ methodName, matcherName ] = args;
 	const spy = jest
-		.spyOn( console, methodName )
+		.spyOn( console, methodName as 'error' | 'info' | 'log' | 'warn' )
 		.mockName( `console.${ methodName }` );
 
 	/**
 	 * Resets the spy to its initial state.
 	 */
 	function resetSpy() {
 		spy.mockReset();
-		spy.assertionsNumber = 0;
+		( spy as any ).assertionsNumber = 0;
 	}
 
 	/**
 	 * Verifies that the spy has only been called if expected.
 	 */
 	function assertExpectedCalls() {
-		if ( spy.assertionsNumber === 0 && spy.mock.calls.length > 0 ) {
+		if (
+			( spy as any ).assertionsNumber === 0 &&
+			spy.mock.calls.length > 0
+		) {
 			expect( console ).not[ matcherName ]();
 		}
 	}

packages/jest-console/src/matchers.js → packages/jest-console/src/matchers.ts

@@ -7,8 +7,18 @@ import { matcherHint, printExpected, printReceived } from 'jest-matcher-utils';
  * Internal dependencies
  */
 import supportedMatchers from './supported-matchers';
+import type { Mock } from 'jest-mock';
 
-const createErrorMessage = ( spyInfo ) => {
+interface SpyInfo {
+	spy: Mock;
+	pass: boolean;
+	calls: any[][];
+	matcherName: string;
+	methodName: string;
+	expected?: any[];
+}
+
+const createErrorMessage = ( spyInfo: SpyInfo ) => {
 	const { spy, pass, calls, matcherName, methodName, expected } = spyInfo;
 	const hint = pass ? `.not${ matcherName }` : matcherName;
 	const message = pass
@@ -28,7 +38,12 @@ const createErrorMessage = ( spyInfo ) => {
 		'See https://www.npmjs.com/package/@wordpress/jest-console for details.';
 };
 
-const createSpyInfo = ( spy, matcherName, methodName, expected ) => {
+const createSpyInfo = (
+	spy: Mock,
+	matcherName: string,
+	methodName: string,
+	expected?: any[]
+) => {
 	const calls = spy.mock.calls;
 
 	const pass = expected
@@ -51,22 +66,21 @@ const createSpyInfo = ( spy, matcherName, methodName, expected ) => {
 };
 
 const createToHaveBeenCalledMatcher =
-	( matcherName, methodName ) => ( received ) => {
-		const spy = received[ methodName ];
+	( matcherName: string, methodName: string ) => ( received: any ) => {
+		const spy = received[ methodName ] as Mock;
 		const spyInfo = createSpyInfo( spy, matcherName, methodName );
-
-		spy.assertionsNumber += 1;
-
+		( spy as any ).assertionsNumber += 1;
 		return spyInfo;
 	};
 
-const createToHaveBeenCalledWith = ( matcherName, methodName ) =>
-	function ( received, ...expected ) {
-		const spy = received[ methodName ];
+const createToHaveBeenCalledWith = (
+	matcherName: string,
+	methodName: string
+) =>
+	function ( received: any, ...expected: any[] ) {
+		const spy = received[ methodName ] as Mock;
 		const spyInfo = createSpyInfo( spy, matcherName, methodName, expected );
-
-		spy.assertionsNumber += 1;
-
+		( spy as any ).assertionsNumber += 1;
 		return spyInfo;
 	};
 
@@ -87,6 +101,6 @@ expect.extend(
 				),
 			};
 		},
-		{}
+		{} as Record< string, any >
 	)
 );

packages/jest-console/src/supported-matchers.js → packages/jest-console/src/supported-matchers.ts

@@ -1,4 +1,4 @@
-const supportedMatchers = {
+const supportedMatchers: Record< string, string > = {
 	error: 'toHaveErrored',
 	info: 'toHaveInformed',
 	log: 'toHaveLogged',

packages/jest-console/tsconfig.json

@@ -0,0 +1,7 @@
+{
+	"$schema": "https://json.schemastore.org/tsconfig.json",
+	"extends": "../../tsconfig.base.json",
+	"compilerOptions": {
+		"types": [ "jest", "@testing-library/jest-dom" ]
+	}
+}

tsconfig.json

@@ -62,6 +62,7 @@
 		{ "path": "packages/warning" },
 		{ "path": "packages/wordcount" },
 		{ "path": "test/e2e" },
+		{ "path": "packages/jest-console" },
 		{ "path": "test/performance" }
 	],
 	"files": []