@wordpress/jest-console 8.37.1-next.ba3aee3a2.0 → 8.38.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wordpress/jest-console",
-	"version": "8.37.1-next.ba3aee3a2.0",
+	"version": "8.38.0",
 	"description": "Custom Jest matchers for the Console object.",
 	"author": "The WordPress Contributors",
 	"license": "GPL-2.0-or-later",
@@ -25,22 +25,21 @@
 		"npm": ">=8.19.2"
 	},
 	"files": [
-		"src",
 		"build",
 		"build-module",
-		"build-types"
+		"declarations.d.ts"
 	],
 	"main": "build/index.cjs",
 	"module": "build-module/index.mjs",
 	"exports": {
 		".": {
-			"types": "./build-types/index.d.ts",
+			"types": "./declarations.d.ts",
 			"import": "./build-module/index.mjs",
 			"require": "./build/index.cjs"
 		},
 		"./package.json": "./package.json"
 	},
-	"types": "index.d.ts",
+	"types": "declarations.d.ts",
 	"dependencies": {
 		"jest-matcher-utils": "^29.6.2",
 		"jest-mock": "^29.6.2"
@@ -55,5 +54,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "67d2e486fcd40c753591cf911ca0659132f519ca"
+	"gitHead": "50c4c0f51e4797c217946ce42adfaa5eb026f33f"
 }

package/build/declarations.d.cjs

@@ -1,2 +0,0 @@
-"use strict";
-//# sourceMappingURL=declarations.d.cjs.map

package/build/declarations.d.cjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": [],
-  "sourcesContent": [],
-  "mappings": "",
-  "names": []
-}

package/build-module/declarations.d.mjs

@@ -1 +0,0 @@
-//# sourceMappingURL=declarations.d.mjs.map

package/build-module/declarations.d.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": [],
-  "sourcesContent": [],
-  "mappings": "",
-  "names": []
-}

package/build-types/index.d.ts

@@ -1,5 +0,0 @@
-/**
- * Internal dependencies
- */
-import './matchers';
-//# sourceMappingURL=index.d.ts.map

package/build-types/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,YAAY,CAAC"}

package/build-types/matchers.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=matchers.d.ts.map

package/build-types/matchers.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"matchers.d.ts","sourceRoot":"","sources":["../src/matchers.ts"],"names":[],"mappings":""}

package/build-types/supported-matchers.d.ts

@@ -1,3 +0,0 @@
-declare const supportedMatchers: Record<string, string>;
-export default supportedMatchers;
-//# sourceMappingURL=supported-matchers.d.ts.map

package/build-types/supported-matchers.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"supported-matchers.d.ts","sourceRoot":"","sources":["../src/supported-matchers.ts"],"names":[],"mappings":"AAAA,QAAA,MAAM,iBAAiB,EAAE,MAAM,CAAE,MAAM,EAAE,MAAM,CAK9C,CAAC;AAEF,eAAe,iBAAiB,CAAC"}

package/build-types/types.d.ts

@@ -1,26 +0,0 @@
-/**
- * External dependencies
- */
-import type { Mock } from 'jest-mock';
-/**
- * Interface for the extended Jest Mock that includes the assertionsNumber property
- */
-export interface ExtendedMock extends Mock {
-    assertionsNumber: number;
-}
-/**
- * Interface for the matcher result object
- */
-export interface MatcherResult {
-    pass: boolean;
-    message: () => string;
-}
-/**
- * Interface for the matcher function
- */
-export type MatcherFunction = (received: Record<string, Mock>) => MatcherResult;
-/**
- * Interface for the matcher function with arguments
- */
-export type MatcherWithArgsFunction = (received: Record<string, Mock>, ...expected: unknown[]) => MatcherResult;
-//# sourceMappingURL=types.d.ts.map

package/build-types/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEtC;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,IAAI;IACzC,gBAAgB,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,MAAM,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,CAC7B,QAAQ,EAAE,MAAM,CAAE,MAAM,EAAE,IAAI,CAAE,KAC5B,aAAa,CAAC;AAEnB;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,CACrC,QAAQ,EAAE,MAAM,CAAE,MAAM,EAAE,IAAI,CAAE,EAChC,GAAG,QAAQ,EAAE,OAAO,EAAE,KAClB,aAAa,CAAC"}

package/src/index.ts

@@ -1,54 +0,0 @@
-/**
- * Internal dependencies
- */
-import './matchers';
-import supportedMatchers from './supported-matchers';
-import type { ExtendedMock } from './types';
-
-/**
- * Sets spy on the console object's method to make it possible to fail test when method called without assertion.
- *
- * @param args
- */
-const setConsoleMethodSpy = ( args: [ string, string ] ) => {
-	const [ methodName, matcherName ] = args;
-	const spy = jest
-		.spyOn( console, methodName as 'error' | 'info' | 'log' | 'warn' )
-		.mockName( `console.${ methodName }` ) as ExtendedMock;
-
-	/**
-	 * Resets the spy to its initial state.
-	 */
-	function resetSpy() {
-		spy.mockReset();
-		spy.assertionsNumber = 0;
-	}
-
-	/**
-	 * Verifies that the spy has only been called if expected.
-	 */
-	function assertExpectedCalls() {
-		if ( spy.assertionsNumber === 0 && spy.mock.calls.length > 0 ) {
-			// Using 'as' to satisfy TypeScript compiler about the matcher name.
-			type MatcherName = `toHave${
-				| 'Errored'
-				| 'Informed'
-				| 'Logged'
-				| 'Warned' }`;
-			const name = matcherName as MatcherName;
-
-			expect( console ).not[ name ]();
-		}
-	}
-
-	beforeAll( resetSpy );
-
-	beforeEach( () => {
-		assertExpectedCalls();
-		resetSpy();
-	} );
-
-	afterEach( assertExpectedCalls );
-};
-
-Object.entries( supportedMatchers ).forEach( setConsoleMethodSpy );

package/src/matchers.ts

@@ -1,121 +0,0 @@
-/**
- * External dependencies
- */
-import { matcherHint, printExpected, printReceived } from 'jest-matcher-utils';
-
-/**
- * Internal dependencies
- */
-import supportedMatchers from './supported-matchers';
-import type { Mock } from 'jest-mock';
-import type {
-	ExtendedMock,
-	MatcherFunction,
-	MatcherResult,
-	MatcherWithArgsFunction,
-} from './types';
-
-interface SpyInfo {
-	spy: Mock;
-	pass: boolean;
-	calls: unknown[][];
-	matcherName: string;
-	methodName: string;
-	expected?: unknown[];
-}
-
-const createErrorMessage = ( spyInfo: SpyInfo ) => {
-	const { spy, pass, calls, matcherName, methodName, expected } = spyInfo;
-	const hint = pass ? `.not${ matcherName }` : matcherName;
-	const message = pass
-		? `Expected mock function not to be called but it was called with:\n${ calls.map(
-				printReceived
-		  ) }`
-		: `Expected mock function to be called${
-				expected ? ` with:\n${ printExpected( expected ) }\n` : '.'
-		  }\nbut it was called with:\n${ calls.map( printReceived ) }`;
-
-	return () =>
-		`${ matcherHint( hint, spy.getMockName() ) }` +
-		'\n\n' +
-		message +
-		'\n\n' +
-		`console.${ methodName }() should not be used unless explicitly expected\n` +
-		'See https://www.npmjs.com/package/@wordpress/jest-console for details.';
-};
-
-const createSpyInfo = (
-	spy: Mock,
-	matcherName: string,
-	methodName: string,
-	expected?: unknown[]
-) => {
-	const calls = spy.mock.calls;
-
-	const pass = expected
-		? JSON.stringify( calls ).includes( JSON.stringify( expected ) )
-		: calls.length > 0;
-
-	const message = createErrorMessage( {
-		spy,
-		pass,
-		calls,
-		matcherName,
-		methodName,
-		expected,
-	} );
-
-	return {
-		pass,
-		message,
-	};
-};
-
-const createToHaveBeenCalledMatcher =
-	( matcherName: string, methodName: string ) =>
-	( received: Record< string, Mock > ): MatcherResult => {
-		const spy = received[ methodName ] as ExtendedMock;
-		const spyInfo = createSpyInfo( spy, matcherName, methodName );
-		spy.assertionsNumber += 1;
-		return spyInfo;
-	};
-
-const createToHaveBeenCalledWith = (
-	matcherName: string,
-	methodName: string
-) =>
-	function (
-		received: Record< string, Mock >,
-		...expected: unknown[]
-	): MatcherResult {
-		const spy = received[ methodName ] as ExtendedMock;
-		const spyInfo = createSpyInfo( spy, matcherName, methodName, expected );
-		spy.assertionsNumber += 1;
-		return spyInfo;
-	};
-
-type MatchersObject = Record<
-	string,
-	MatcherFunction | MatcherWithArgsFunction
->;
-
-expect.extend(
-	Object.entries( supportedMatchers ).reduce< MatchersObject >(
-		( result, [ methodName, matcherName ] ) => {
-			const matcherNameWith = `${ matcherName }With`;
-
-			return {
-				...result,
-				[ matcherName ]: createToHaveBeenCalledMatcher(
-					`.${ matcherName }`,
-					methodName
-				),
-				[ matcherNameWith ]: createToHaveBeenCalledWith(
-					`.${ matcherNameWith }`,
-					methodName
-				),
-			};
-		},
-		{}
-	)
-);

package/src/supported-matchers.ts

@@ -1,8 +0,0 @@
-const supportedMatchers: Record< string, string > = {
-	error: 'toHaveErrored',
-	info: 'toHaveInformed',
-	log: 'toHaveLogged',
-	warn: 'toHaveWarned',
-};
-
-export default supportedMatchers;

package/src/test/index.test.ts

@@ -1,93 +0,0 @@
-/* eslint-disable no-console */
-
-/**
- * Internal dependencies
- */
-import '../matchers';
-
-describe( 'jest-console', () => {
-	describe.each( [
-		[ 'error', 'toHaveErrored' ],
-		[ 'info', 'toHaveInformed' ],
-		[ 'log', 'toHaveLogged' ],
-		[ 'warn', 'toHaveWarned' ],
-	] )( 'console.%s', ( methodName, matcherName ) => {
-		const matcherNameWith = `${ matcherName }With`;
-		const message = `This is ${ methodName }!`;
-
-		test( `${ matcherName } works`, () => {
-			console[ methodName ]( message );
-
-			expect( console )[ matcherName ]();
-		} );
-
-		test( `${ matcherName } works when not called`, () => {
-			expect( console ).not[ matcherName ]();
-			expect( () => expect( console )[ matcherName ]() ).toThrow(
-				'Expected mock function to be called.'
-			);
-		} );
-
-		test( `${ matcherNameWith } works with arguments that match`, () => {
-			console[ methodName ]( message );
-
-			expect( console )[ matcherNameWith ]( message );
-		} );
-
-		test( `${ matcherNameWith } works when not called`, () => {
-			expect( console ).not[ matcherNameWith ]( message );
-			expect( () =>
-				expect( console )[ matcherNameWith ]( message )
-			).toThrow(
-				/Expected mock function to be called with:.*but it was called with:/s
-			);
-		} );
-
-		test( `${ matcherNameWith } works with many arguments that do not match`, () => {
-			console[ methodName ]( 'Unknown message.' );
-			console[ methodName ]( message, 'Unknown param.' );
-
-			expect( console ).not[ matcherNameWith ]( message );
-			expect( () =>
-				expect( console )[ matcherNameWith ]( message )
-			).toThrow(
-				/Expected mock function to be called with:.*but it was called with:.*Unknown param./s
-			);
-		} );
-
-		test( 'assertions number gets incremented after every matcher call', () => {
-			const spy = console[ methodName ];
-
-			expect( spy.assertionsNumber ).toBe( 0 );
-
-			console[ methodName ]( message );
-
-			expect( console )[ matcherName ]();
-			expect( spy.assertionsNumber ).toBe( 1 );
-
-			expect( console )[ matcherNameWith ]( message );
-			expect( spy.assertionsNumber ).toBe( 2 );
-		} );
-
-		describe( 'lifecycle', () => {
-			beforeAll( () => {
-				// Disable reason:
-				// This is a difficult one to test, since the matcher's
-				// own lifecycle is defined to run before ours. Infer
-				// that we're being watched by testing the console
-				// method as being a spy.
-				// eslint-disable-next-line jest/no-standalone-expect
-				expect(
-					console[ methodName ].assertionsNumber
-				).toBeGreaterThanOrEqual( 0 );
-			} );
-
-			// Disable reason:
-			// See beforeAll implementation and explanation added there.
-			// eslint-disable-next-line jest/expect-expect
-			it( 'captures logging in lifecycle', () => {} );
-		} );
-	} );
-} );
-
-/* eslint-enable no-console */

package/src/types.ts

@@ -1,34 +0,0 @@
-/**
- * External dependencies
- */
-import type { Mock } from 'jest-mock';
-
-/**
- * Interface for the extended Jest Mock that includes the assertionsNumber property
- */
-export interface ExtendedMock extends Mock {
-	assertionsNumber: number;
-}
-
-/**
- * Interface for the matcher result object
- */
-export interface MatcherResult {
-	pass: boolean;
-	message: () => string;
-}
-
-/**
- * Interface for the matcher function
- */
-export type MatcherFunction = (
-	received: Record< string, Mock >
-) => MatcherResult;
-
-/**
- * Interface for the matcher function with arguments
- */
-export type MatcherWithArgsFunction = (
-	received: Record< string, Mock >,
-	...expected: unknown[]
-) => MatcherResult;