required snapshot name

Author: bakamitai456

packages/jest-snapshot/__typetests__/matchers.test.ts

@@ -82,11 +82,7 @@ expectError(toMatchInlineSnapshot({received: 'value'}));
 
 // toMatchNamedSnapshot
 
-expectType<ExpectationResult>(
-  toMatchNamedSnapshot.call({} as Context, {received: 'value'}),
-);
-
-expectType<ExpectationResult>(
+expectError<ExpectationResult>(
   toMatchNamedSnapshot.call({} as Context, {received: 'value'}),
 );
 
@@ -98,7 +94,7 @@ expectType<ExpectationResult>(
   ),
 );
 
-expectType<ExpectationResult>(
+expectError<ExpectationResult>(
   toMatchNamedSnapshot.call(
     {} as Context,
     {received: 'value'},
@@ -110,8 +106,8 @@ expectType<ExpectationResult>(
   toMatchNamedSnapshot.call(
     {} as Context,
     {received: 'value'},
-    {property: 'match'},
     'snapshot name',
+    {property: 'match'},
   ),
 );
 
@@ -187,7 +183,7 @@ expectError(toThrowErrorMatchingInlineSnapshot({received: 'value'}));
 
 // toThrowErrorMatchingNamedSnapshot
 
-expectType<ExpectationResult>(
+expectError<ExpectationResult>(
   toThrowErrorMatchingNamedSnapshot.call({} as Context, new Error('received')),
 );
 
@@ -208,13 +204,4 @@ expectType<ExpectationResult>(
   ),
 );
 
-expectType<ExpectationResult>(
-  toThrowErrorMatchingNamedSnapshot.call(
-    {} as Context,
-    new Error('received'),
-    undefined,
-    false, // fromPromise
-  ),
-);
-
 expectError(toThrowErrorMatchingSnapshot({received: 'value'}));

packages/jest-snapshot/src/__tests__/__snapshots__/printSnapshot.test.ts.snap

@@ -1,9 +1,9 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
 exports[`change text value 1`] = `
-<d>expect(</><t>received</><d>).</>toMatchSnapshot<d>(</>properties<d>, </><b>hint</><d>)</>
+<d>expect(</><t>received</><d>).</>toMatchNamedSnapshot<d>(</>properties<d>)</>
 
-Snapshot name: \`with properties: <b>change text value</> 1\`
+Snapshot name: \`with properties 1\`
 
 <m>- Snapshot  - 1</>
 <t>+ Received  + 1</>
@@ -58,21 +58,19 @@ Expected properties has value: <g>[Function]</>
 `;
 
 exports[`matcher error toMatchNamedSnapshot Expected properties must be an object (null) with snapshot name 1`] = `
-<d>expect(</><r>received</><d>).</>toMatchNamedSnapshot<d>(</><g>properties</><d>, </><b>snapshotName</><d>)</>
-
-<b>Matcher error</>: Expected <g>properties</> must be an object
+<d>expect(</><r>received</><d>).</>toMatchNamedSnapshot<d>(</><g>properties</><d>)</>
 
-Expected properties has value: <g>null</>
+Snapshot state must be initialized
 
-To provide a snapshot name without properties: toMatchNamedSnapshot('snapshotName')
+Snapshot state has value: undefined
 `;
 
 exports[`matcher error toMatchNamedSnapshot Expected properties must be an object (null) without snapshot name 1`] = `
 <d>expect(</><r>received</><d>).</>toMatchNamedSnapshot<d>(</><g>properties</><d>)</>
 
-<b>Matcher error</>: Expected <g>properties</> must be an object
+Snapshot state must be initialized
 
-Expected properties has value: <g>null</>
+Snapshot state has value: undefined
 `;
 
 exports[`matcher error toMatchNamedSnapshot Snapshot state must be initialized 1`] = `

packages/jest-snapshot/src/__tests__/matcher.test.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {type Context, toMatchSnapshot} from '../';
+import {Context, toMatchSnapshot} from '../';
 
 test('returns matcher name, expected and actual values', () => {
   const mockedContext = {

packages/jest-snapshot/src/__tests__/printSnapshot.test.ts

@@ -289,9 +289,11 @@ describe('matcher error', () => {
         promise: '',
       } as Context;
       const properties = () => {};
+      const snapshotName =
+        'toMatchNamedSnapshot Expected properties must be an object (non-null)';
 
       expect(() => {
-        toMatchNamedSnapshot.call(context, received, properties);
+        toMatchNamedSnapshot.call(context, received, snapshotName, properties);
       }).toThrowErrorMatchingSnapshot();
     });
 
@@ -305,7 +307,7 @@ describe('matcher error', () => {
 
       expect(() => {
         // @ts-expect-error: Testing runtime error
-        toMatchNamedSnapshot.call(context, received, properties, snapshotName);
+        toMatchNamedSnapshot.call(context, received, snapshotName, properties);
       }).toThrowErrorMatchingSnapshot();
     });
 
@@ -315,10 +317,12 @@ describe('matcher error', () => {
         promise: '',
       } as Context;
       const properties = null;
+      const snapshotName =
+        'toMatchNamedSnapshot Expected properties must be an object (null) without snapshot name';
 
       expect(() => {
         // @ts-expect-error: Testing runtime error
-        toMatchNamedSnapshot.call(context, received, properties);
+        toMatchNamedSnapshot.call(context, received, snapshotName, properties);
       }).toThrowErrorMatchingSnapshot();
     });
 
@@ -328,9 +332,11 @@ describe('matcher error', () => {
         promise: '',
       } as Context;
       const properties: Array<unknown> = [];
+      const snapshotName =
+        'toMatchNamedSnapshot Expected properties must be an object (null) without snapshot name';
 
       expect(() => {
-        toMatchNamedSnapshot.call(context, received, properties);
+        toMatchNamedSnapshot.call(context, received, snapshotName, properties);
       }).toThrowErrorMatchingSnapshot();
     });
 
@@ -342,16 +348,25 @@ describe('matcher error', () => {
         snapshotState: {},
       } as Context;
       const properties = {};
+      const snapshotName =
+        'toMatchNamedSnapshot received value must be an object';
 
       test('(non-null)', () => {
         expect(() => {
-          toMatchNamedSnapshot.call(context, 'string', properties);
+          toMatchNamedSnapshot.call(
+            context,
+            'string',
+            snapshotName,
+            properties,
+          );
         }).toThrowErrorMatchingSnapshot();
       });
 
       test('(null)', () => {
+        const snapshotName = 'toMatchNamedSnapshot (null)';
+
         expect(() => {
-          toMatchNamedSnapshot.call(context, null, properties);
+          toMatchNamedSnapshot.call(context, null, snapshotName, properties);
         }).toThrowErrorMatchingSnapshot();
       });
     });
@@ -831,8 +846,8 @@ describe('pass false', () => {
           const {message, pass} = toMatchNamedSnapshot.call(
             context,
             new RangeError('Invalid array length'),
-            {name: 'Error'},
             snapshotName,
+            {name: 'Error'},
           ) as SyncExpectationResult;
           expect(pass).toBe(false);
           expect(message()).toMatchNamedSnapshot(snapshotName);
@@ -849,8 +864,8 @@ describe('pass false', () => {
           const {message, pass} = toMatchNamedSnapshot.call(
             context,
             received,
-            properties,
             snapshotName,
+            properties,
           ) as SyncExpectationResult;
           expect(pass).toBe(false);
           expect(message()).toMatchNamedSnapshot(snapshotName);
@@ -890,11 +905,11 @@ describe('pass false', () => {
         };
         const snapshotName = 'change text value';
 
-        const {message, pass} = toMatchSnapshot.call(
+        const {message, pass} = toMatchNamedSnapshot.call(
           context,
           received,
-          properties,
           snapshotName,
+          properties,
         ) as SyncExpectationResult;
         expect(pass).toBe(false);
         expect(message()).toMatchNamedSnapshot(snapshotName);

packages/jest-snapshot/src/__tests__/throwMatcher.test.ts

@@ -47,7 +47,7 @@ describe('throw matcher can take func', () => {
       () => {
         throw new Error('coconut');
       },
-      undefined,
+      '',
       false,
     );
 

packages/jest-snapshot/src/index.ts

@@ -229,40 +229,26 @@ export const toMatchSnapshot: MatcherFunctionWithContext<
 
 export const toMatchNamedSnapshot: MatcherFunctionWithContext<
   Context,
-  [propertiesOrSnapshotName?: object | string, snapshotName?: string]
-> = function (received, propertiesOrSnapshotName, snapshotName) {
+  [snapshotName: string, properties?: object]
+> = function (received, snapshotName, properties?) {
   const matcherName = 'toMatchNamedSnapshot';
-  let properties;
 
-  const length = arguments.length;
-  if (length === 2 && typeof propertiesOrSnapshotName === 'string') {
-    snapshotName = propertiesOrSnapshotName;
-  } else if (length >= 2) {
+  if (properties) {
     if (
-      Array.isArray(propertiesOrSnapshotName) ||
-      typeof propertiesOrSnapshotName !== 'object' ||
-      propertiesOrSnapshotName === null
+      Array.isArray(properties) ||
+      typeof properties !== 'object' ||
+      properties === null
     ) {
       const options: MatcherHintOptions = {
         isNot: this.isNot,
         promise: this.promise,
       };
-      let printedWithType = printWithType(
+      const printedWithType = printWithType(
         'Expected properties',
-        propertiesOrSnapshotName,
+        properties,
         printExpected,
       );
 
-      if (length === 3) {
-        options.secondArgument = 'snapshotName';
-        options.secondArgumentColor = BOLD_WEIGHT;
-
-        if (propertiesOrSnapshotName == null) {
-          printedWithType +=
-            "\n\nTo provide a snapshot name without properties: toMatchNamedSnapshot('snapshotName')";
-        }
-      }
-
       throw new Error(
         matcherErrorMessage(
           matcherHint(matcherName, undefined, PROPERTIES_ARG, options),
@@ -271,11 +257,6 @@ export const toMatchNamedSnapshot: MatcherFunctionWithContext<
         ),
       );
     }
-
-    // Future breaking change: Snapshot hint must be a string
-    // if (arguments.length === 3 && typeof hint !== 'string') {}
-
-    properties = propertiesOrSnapshotName;
   }
 
   return _toMatchSnapshot({
@@ -548,7 +529,7 @@ export const toThrowErrorMatchingInlineSnapshot: MatcherFunctionWithContext<
 
 export const toThrowErrorMatchingNamedSnapshot: MatcherFunctionWithContext<
   Context,
-  [snapshotName?: string, fromPromise?: boolean]
+  [snapshotName: string, fromPromise?: boolean]
 > = function (received, snapshotName, fromPromise) {
   const matcherName = 'toThrowErrorMatchingNamedSnapshot';
 

packages/jest-snapshot/src/types.ts

@@ -58,14 +58,14 @@ export interface SnapshotMatchers<R extends void | Promise<void>, T> {
    * This ensures that a value matches the specific snapshot.
    * Instead of use current test name in global state, it will use the specific name to find the snapshot.
    */
-  toMatchNamedSnapshot(snapshotName?: string): R;
+  toMatchNamedSnapshot(snapshotName: string): R;
   /**
    * This ensures that a value matches the specific snapshot with property matchers.
    * Instead of use current test name in global state, it will use the specific name to find the snapshot.
    */
   toMatchNamedSnapshot<U extends Record<keyof T, unknown>>(
+    snapshot: string,
     propertyMatchers: Partial<U>,
-    snapshot?: string,
   ): R;
   /**
    * This ensures that a value matches the most recent snapshot with property matchers.
@@ -95,7 +95,7 @@ export interface SnapshotMatchers<R extends void | Promise<void>, T> {
    * Used to test that a function throws a error matching the specific snapshot.
    * Instead of use current test name in global state, it will use the specific name to find the snapshot.
    */
-  toThrowErrorMatchingNamedSnapshot(snapshotName?: string): R;
+  toThrowErrorMatchingNamedSnapshot(snapshotName: string): R;
 }
 
 export type SnapshotFormat = Omit<PrettyFormatOptions, 'compareKeys'>;