Merge pull request #31 from wix-incubator/migrate-to-jest-snapshots

test: migrate to inbuilt jest snapshots

Author: tkvlnk

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "jest.jestCommandLine": "npx jest"
+}

package.json

@@ -5,7 +5,7 @@
   "scripts": {
     "clean-generated": "rimraf tests/__generated__ tests/**/__generated__ tests/cli-configs-sandbox/*/dist",
     "generate-for-type-tests": "ts-node tests/pregenerate.ts",
-    "generate-snapshot": "ts-node tests/update-snaptshots.ts generate",
+    "generate-snapshot": "jest -i --updateSnapshot",
     "lint": "eslint '**/*.{ts,tsx}'",
     "lint:fix": "eslint '**/*.{ts,tsx}' --fix",
     "typecheck": "tsc --noEmit",

tests/__snapshots__/generator.spec.ts.snap

@@ -0,0 +1,125 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`complex interpolation case snapshot 1`] = `
+"/* eslint-disable */
+/* tslint:disable */
+export function LocaleKeys<R extends string>(t: (...args: unknown[]) => R) {
+  return {
+    order: {
+      shippingLabel: {
+        customerDetailsCard: {
+          address: (data: Record<'firstName' | 'lastName' | 'addressLine1' | 'addressLine2' | 'city' | 'state' | 'zipCode' | 'country', unknown>) => t('order.shippingLabel.customerDetailsCard.address', data), /* {{firstName}} {{lastName}}, {{addressLine1, suffix ', '}}{{addressLine2, suffix ', '}}{{city, concat ', '}}{{state, suffix ' '}}{{zipCode, suffix ', '}}{{country}} */
+        },
+        labelDetailsCard: {
+          shipFrom: {
+            addressFormat: (data: Record<'addressLine1' | 'addressLine2' | 'city' | 'state' | 'zipCode' | 'country', unknown>) => t('order.shippingLabel.labelDetailsCard.shipFrom.addressFormat', data), /* {{addressLine1, suffix ', '}}{{addressLine2, suffix ', '}}{{city, suffix ', '}}{{state}} {{zipCode, suffix ', '}}{{country}} */
+          },
+        },
+      },
+    },
+  };
+}
+
+export type ILocaleKeys = ReturnType<typeof LocaleKeys>;
+"
+`;
+
+exports[`data interpolation icu snapshot 1`] = `
+"/* eslint-disable */
+/* tslint:disable */
+export function LocaleKeys<R extends string>(t: (...args: unknown[]) => R) {
+  return {
+    common: {
+      people: {
+        message: (data: Record<'numPersons', unknown>) => t('common.people.message', data), /* Hey, {numPersons, plural, =0 {no one} =1 {one person} other {# persons}} */
+        messageComplex: (data: Record<'name' | 'numPersons' | 'productsAmount', unknown>) => t('common.people.messageComplex', data), /* Hey {name}, There are {numPersons, plural, =0 {no one} =1 {one person} other {# persons}} that want to change the {productsAmount, plural, =1 {price of 1 product} other {prices of # products}} */
+        pluralMessage: (data: Record<'numPeople', unknown>) => t('common.people.pluralMessage', data), /* {numPeople, plural, =0 {No one is} =1 {One person is} other {# people are}} interested */
+        ordinalMessage: (data: Record<'position', unknown>) => t('common.people.ordinalMessage', data), /* {position, selectordinal, one {You're 1st} two {You're 2nd} few {You're 3rd} other {You're #th}} */
+        dateMessage: (data: Record<'currentDate', unknown>) => t('common.people.dateMessage', data), /* Today is {currentDate, date, long} */
+        timeMessage: (data: Record<'currentTime', unknown>) => t('common.people.timeMessage', data), /* The current time is {currentTime, time, short} */
+        selectMessage: (data: Record<'gender', unknown>) => t('common.people.selectMessage', data), /* {gender, select, male {He is} female {She is} other {They are} } interested */
+        numberMessage: (data: Record<'numApples', unknown>) => t('common.people.numberMessage', data), /* You have {numApples, number} apples */
+      },
+    },
+  };
+}
+
+export type ILocaleKeys = ReturnType<typeof LocaleKeys>;
+"
+`;
+
+exports[`data interpolation icu with nested params snapshot 1`] = `
+"/* eslint-disable */
+/* tslint:disable */
+export function LocaleKeys<R extends string>(t: (...args: unknown[]) => R) {
+  return {
+    common: {
+      people: {
+        message: (data: Record<'numPersons', unknown>) => t('common.people.message', data), /* Hey, {numPersons, plural, =0 {no one} =1 {one person} other {# persons}} */
+        messageNestedParams: (data: Record<'name' | 'numPersons', unknown>) => t('common.people.messageNestedParams', data), /* Hey, {numPersons, plural, =0 {No one here.} one {{name}. You are the only person here.} other {{name} and # other persons are here.}} */
+      },
+    },
+  };
+}
+
+export type ILocaleKeys = ReturnType<typeof LocaleKeys>;
+"
+`;
+
+exports[`data interpolation single quote snapshot 1`] = `
+"/* eslint-disable */
+/* tslint:disable */
+export function LocaleKeys<R extends string>(t: (...args: unknown[]) => R) {
+  return {
+    common: {
+      loggedIn: {
+        message: (data: Record<'username', unknown>) => t('common.loggedIn.message', data), /* Hey, {username}, you have successfully logged in! */
+      },
+    },
+    readingWarning: (data: Record<'reader' | 'writer', unknown>) => t('readingWarning', data), /* {reader} reads message from {writer} */
+  };
+}
+
+export type ILocaleKeys = ReturnType<typeof LocaleKeys>;
+"
+`;
+
+exports[`flat data snapshot 1`] = `
+"/* eslint-disable */
+/* tslint:disable */
+export function LocaleKeys<R extends string>(t: (...args: unknown[]) => R) {
+  return {
+    common: {
+      cancel: () => t('common.cancel'), /* Cancel */
+    },
+    model: {
+      player: {
+        name: () => t('model.player.name'), /* Name */
+      },
+    },
+  };
+}
+
+export type ILocaleKeys = ReturnType<typeof LocaleKeys>;
+"
+`;
+
+exports[`nested data snapshot 1`] = `
+"/* eslint-disable */
+/* tslint:disable */
+export function LocaleKeys<R extends string>(t: (...args: unknown[]) => R) {
+  return {
+    common: {
+      create: () => t('common.create'), /* Create */
+    },
+    model: {
+      user: {
+        id: () => t('model.user.id'), /* ID */
+      },
+    },
+  };
+}
+
+export type ILocaleKeys = ReturnType<typeof LocaleKeys>;
+"
+`;

tests/snapshot/react/LocaleKeys.tsx renamed to tests/__snapshots__/reactBindings.spec.tsx.snap

@@ -1,4 +1,7 @@
-/* eslint-disable */
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`react file (snapshot) 1`] = `
+"/* eslint-disable */
 /* tslint:disable */
 import React from 'react';
 
@@ -22,3 +25,5 @@ export const LocaleKeysProvider: React.FC<{ translateFn?: (...args: unknown[]) =
     return <LocaleKeysContext.Provider value={value}>{children}</LocaleKeysContext.Provider>;
   };
 export const useLocaleKeys = () => React.useContext(LocaleKeysContext);
+"
+`;

tests/config.spec.ts

@@ -54,10 +54,10 @@ test('should apply params from package.json', async () => {
   const driver = new Driver();
 
   driver.given.cwd('tests/cli-configs-sandbox/packageJsonBooleans');
-
-  await driver.when.runsCodegenCommand({
+  driver.given.cliParams({
     source: 'source.json',
   });
+  await driver.when.runsCodegenCommand();
 
   const { useLocaleKeys, LocaleKeys } = await driver.get.generatedResults<
     GeneratedModule<ResultOne>
@@ -79,13 +79,14 @@ test('should override params in package.json with cli args', async () => {
 
   driver.given.cwd('tests/cli-configs-sandbox/overridePackageJson');
 
-  await driver.when.runsCodegenCommand({
+  driver.given.cliParams({
     source: 'source.json',
     output: 'dist',
     reactHook: false,
     showTranslations: false,
     singleCurlyBraces: false,
   });
+  await driver.when.runsCodegenCommand();
 
   const { useLocaleKeys, LocaleKeys } = await driver.get.generatedResults<
     GeneratedModule<ResultOne>

tests/driver.ts

@@ -6,13 +6,15 @@ import jsonStringify from 'fast-json-stable-stringify';
 import { Generator } from '../src/Generator';
 import { CliParams } from '../src/bin';
 import { DEFAULT_FN_NAME, DEFAULT_OUTPUT } from '../src/constants';
-import { EXPORT_SNAPSHOT_DIRECTORY } from './generateFiles';
 import { getFileExtension } from '../src/utils';
 
 const readFile = util.promisify(fs.readFile);
 
 export class Driver {
   private cwd: string = process.cwd();
+  private cliParams: Partial<CliParams> = {
+    functionName: DEFAULT_FN_NAME,
+  };
   private namespace: string | undefined;
   private functionName: string | undefined;
   private isReactFile: boolean | undefined;
@@ -46,19 +48,20 @@ export class Driver {
     namespace: (namespace: string): void => {
       this.namespace = namespace;
     },
+    cliParams: (values: Partial<CliParams>) => {
+      Object.assign(this.cliParams, values);
+    },
   };
 
   public when = {
-    runsCodegenCommand: async (
-      params: Partial<CliParams> = {}
-    ): Promise<void> => {
+    runsCodegenCommand: async (): Promise<void> => {
       const {
         source = this.namespacedSource,
         output = this.namespacedOutput,
         functionName = DEFAULT_FN_NAME,
         reactHook,
         ...rest
-      } = params;
+      } = this.cliParams;
 
       this.functionName = functionName;
       this.isReactFile = reactHook;
@@ -128,11 +131,5 @@ export class Driver {
           .namespace!}/LocaleKeys.${getFileExtension(this.isReactFile)}`,
         'utf8'
       ),
-    generatedSnapShotAsStr: (): Promise<string> =>
-      readFile(
-        `${EXPORT_SNAPSHOT_DIRECTORY}/${this
-          .namespace!}/LocaleKeys.${getFileExtension(this.isReactFile)}`,
-        'utf8'
-      ),
   };
 }