@wordpress/jest-console 8.36.1-next.6deb34194.0 → 8.36.1-next.738bb1424.0

package/build/declarations.d.cjs

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

package/build/{index.js → index.cjs}

@@ -23,8 +23,8 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 ));
 
 // packages/jest-console/src/index.ts
-var import_matchers = require("./matchers");
-var import_supported_matchers = __toESM(require("./supported-matchers"));
+var import_matchers = require("./matchers.cjs");
+var import_supported_matchers = __toESM(require("./supported-matchers.cjs"), 1);
 var setConsoleMethodSpy = (args) => {
   const [methodName, matcherName] = args;
   const spy = jest.spyOn(console, methodName).mockName(`console.${methodName}`);
@@ -45,4 +45,4 @@ var setConsoleMethodSpy = (args) => {
   afterEach(assertExpectedCalls);
 };
 Object.entries(import_supported_matchers.default).forEach(setConsoleMethodSpy);
-//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.cjs.map

package/build/{matchers.js → matchers.cjs}

@@ -24,7 +24,7 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 
 // packages/jest-console/src/matchers.ts
 var import_jest_matcher_utils = require("jest-matcher-utils");
-var import_supported_matchers = __toESM(require("./supported-matchers"));
+var import_supported_matchers = __toESM(require("./supported-matchers.cjs"), 1);
 var createErrorMessage = (spyInfo) => {
   const { spy, pass, calls, matcherName, methodName, expected } = spyInfo;
   const hint = pass ? `.not${matcherName}` : matcherName;
@@ -90,4 +90,4 @@ expect.extend(
     {}
   )
 );
-//# sourceMappingURL=matchers.js.map
+//# sourceMappingURL=matchers.cjs.map

package/build/{supported-matchers.js → supported-matchers.cjs}

@@ -30,4 +30,4 @@ var supportedMatchers = {
   warn: "toHaveWarned"
 };
 var supported_matchers_default = supportedMatchers;
-//# sourceMappingURL=supported-matchers.js.map
+//# sourceMappingURL=supported-matchers.cjs.map

package/build/{types.js → types.cjs}

@@ -16,4 +16,4 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // packages/jest-console/src/types.ts
 var types_exports = {};
 module.exports = __toCommonJS(types_exports);
-//# sourceMappingURL=types.js.map
+//# sourceMappingURL=types.cjs.map

package/build-module/index.js

@@ -1,6 +1,6 @@
 // packages/jest-console/src/index.ts
-import "./matchers";
-import supportedMatchers from "./supported-matchers";
+import "./matchers.js";
+import supportedMatchers from "./supported-matchers.js";
 var setConsoleMethodSpy = (args) => {
   const [methodName, matcherName] = args;
   const spy = jest.spyOn(console, methodName).mockName(`console.${methodName}`);

package/build-module/matchers.js

@@ -1,6 +1,6 @@
 // packages/jest-console/src/matchers.ts
 import { matcherHint, printExpected, printReceived } from "jest-matcher-utils";
-import supportedMatchers from "./supported-matchers";
+import supportedMatchers from "./supported-matchers.js";
 var createErrorMessage = (spyInfo) => {
   const { spy, pass, calls, matcherName, methodName, expected } = spyInfo;
   const hint = pass ? `.not${matcherName}` : matcherName;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wordpress/jest-console",
-	"version": "8.36.1-next.6deb34194.0",
+	"version": "8.36.1-next.738bb1424.0",
 	"description": "Custom Jest matchers for the Console object.",
 	"author": "The WordPress Contributors",
 	"license": "GPL-2.0-or-later",
@@ -25,17 +25,19 @@
 		"npm": ">=8.19.2"
 	},
 	"files": [
+		"src",
 		"build",
 		"build-module",
 		"build-types"
 	],
-	"main": "build/index.js",
+	"type": "module",
+	"main": "build/index.cjs",
 	"module": "build-module/index.js",
 	"exports": {
 		".": {
 			"types": "./build-types/index.d.ts",
 			"import": "./build-module/index.js",
-			"require": "./build/index.js"
+			"require": "./build/index.cjs"
 		},
 		"./package.json": "./package.json"
 	},
@@ -49,5 +51,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "457096e9e9b3896d2d4fe54fc19d7fb571ee9a44"
+	"gitHead": "ab1b004c0d61c295aa34bc86ea07f979343983ce"
 }

package/src/declarations.d.ts

@@ -0,0 +1,46 @@
+// Definitions originally written by Damien Sorel <https://github.com/mistic100> under MIT license.
+// https://github.com/DefinitelyTyped/DefinitelyTyped/blob/f0b72c12f6b561e4342dc8a1cf87432d2ad40ae7/types/wordpress__jest-console/index.d.ts
+
+declare namespace jest {
+	interface Matchers< R, T > {
+		/**
+		 * Ensure that `console.error` function was called.
+		 */
+		toHaveErrored(): R;
+
+		/**
+		 * Ensure that `console.error` function was called with specific arguments.
+		 */
+		toHaveErroredWith( ...args: unknown[] ): R;
+
+		/**
+		 * Ensure that `console.info` function was called.
+		 */
+		toHaveInformed(): R;
+
+		/**
+		 * Ensure that `console.info` function was called with specific arguments.
+		 */
+		toHaveInformedWith( ...args: unknown[] ): R;
+
+		/**
+		 * Ensure that `console.log` function was called.
+		 */
+		toHaveLogged(): R;
+
+		/**
+		 * Ensure that `console.log` function was called with specific arguments.
+		 */
+		toHaveLoggedWith( ...args: unknown[] ): R;
+
+		/**
+		 * Ensure that `console.warn` function was called.
+		 */
+		toHaveWarned(): R;
+
+		/**
+		 * Ensure that `console.warn` function was called with specific arguments.
+		 */
+		toHaveWarnedWith( ...args: unknown[] ): R;
+	}
+}

package/src/index.ts

@@ -0,0 +1,46 @@
+/**
+ * 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 ) {
+			expect( console ).not[ matcherName ]();
+		}
+	}
+
+	beforeAll( resetSpy );
+
+	beforeEach( () => {
+		assertExpectedCalls();
+		resetSpy();
+	} );
+
+	afterEach( assertExpectedCalls );
+};
+
+Object.entries( supportedMatchers ).forEach( setConsoleMethodSpy );

package/src/matchers.ts

@@ -0,0 +1,121 @@
+/**
+ * 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

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

package/src/test/index.test.ts

@@ -0,0 +1,93 @@
+/* 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

@@ -0,0 +1,34 @@
+/**
+ * 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;

package/build/declarations.d.js

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