Move printFunctionName to prettyFormat snapshot config

jestjs · Jul 11, 2019 · d5341fb · d5341fb
1 parent 044e843
commit d5341fb
Show file tree

Hide file tree

Showing 7 changed files with 42 additions and 15 deletions.
diff --git a/packages/jest-circus/src/legacy-code-todo-rewrite/jestAdapterInit.ts b/packages/jest-circus/src/legacy-code-todo-rewrite/jestAdapterInit.ts
@@ -122,14 +122,14 @@ export const initialize = ({
     });
 
   const {expand, updateSnapshot} = globalConfig;
-  const {printFunctionName} = config;
+  const {prettyFormatSnapshotConfig} = config;
   const snapshotResolver = buildSnapshotResolver(config);
   const snapshotPath = snapshotResolver.resolveSnapshotPath(testPath);
   const snapshotState = new SnapshotState(snapshotPath, {
     expand,
     getBabelTraverse,
     getPrettier,
-    printFunctionName,
+    prettyFormatSnapshotConfig,
     updateSnapshot,
   });
   setState({snapshotState, testPath});

diff --git a/packages/jest-config/src/index.ts b/packages/jest-config/src/index.ts
@@ -186,7 +186,7 @@ const groupOptions = (
     modulePaths: options.modulePaths,
     name: options.name,
     prettierPath: options.prettierPath,
-    printFunctionName: options.printFunctionName,
+    prettyFormatSnapshotConfig: options.prettyFormatSnapshotConfig,
     resetMocks: options.resetMocks,
     resetModules: options.resetModules,
     resolver: options.resolver,

diff --git a/packages/jest-jasmine2/src/setup_jest_globals.ts b/packages/jest-jasmine2/src/setup_jest_globals.ts
@@ -101,15 +101,15 @@ export default ({
 
   patchJasmine();
   const {expand, updateSnapshot} = globalConfig;
-  const {printFunctionName} = config;
+  const {prettyFormatSnapshotConfig} = config;
   const snapshotResolver = buildSnapshotResolver(config);
   const snapshotPath = snapshotResolver.resolveSnapshotPath(testPath);
   const snapshotState = new SnapshotState(snapshotPath, {
     expand,
     getBabelTraverse: () => require('@babel/traverse').default,
     getPrettier: () =>
       config.prettierPath ? require(config.prettierPath) : null,
-    printFunctionName,
+    prettyFormatSnapshotConfig,
     updateSnapshot,
   });
   setState({snapshotState, testPath});

diff --git a/packages/jest-snapshot/src/State.ts b/packages/jest-snapshot/src/State.ts
@@ -25,7 +25,7 @@ export type SnapshotStateOptions = {
   getPrettier: () => null | any;
   getBabelTraverse: () => Function;
   expand?: boolean;
-  printFunctionName?: boolean;
+  prettyFormatSnapshotConfig?: Config.PrettyFormatSnapshotConfig;
 };
 
 export type SnapshotMatchOptions = {
@@ -49,7 +49,7 @@ export default class SnapshotState {
   private _uncheckedKeys: Set<string>;
   private _getBabelTraverse: () => Function;
   private _getPrettier: () => null | any;
-  private _printFunctionName: boolean;
+  private _prettyFormatSnapshotConfig?: Config.PrettyFormatSnapshotConfig;
 
   added: number;
   expand: boolean;
@@ -75,7 +75,7 @@ export default class SnapshotState {
     this.expand = options.expand || false;
     this.added = 0;
     this.matched = 0;
-    this._printFunctionName = options.printFunctionName || false;
+    this._prettyFormatSnapshotConfig = options.prettyFormatSnapshotConfig;
     this.unmatched = 0;
     this._updateSnapshot = options.updateSnapshot;
     this.updated = 0;
@@ -192,7 +192,7 @@ export default class SnapshotState {
       this._uncheckedKeys.delete(key);
     }
 
-    const receivedSerialized = serialize(received, this._printFunctionName);
+    const receivedSerialized = serialize(received, this._prettyFormatSnapshotConfig);
     const expected = isInline ? inlineSnapshot : this._snapshotData[key];
     const pass = expected === receivedSerialized;
     const hasSnapshot = isInline

diff --git a/packages/jest-snapshot/src/utils.ts b/packages/jest-snapshot/src/utils.ts
@@ -128,16 +128,31 @@ export const getSnapshotData = (
 const addExtraLineBreaks = (string: string): string =>
   string.includes('\n') ? `\n${string}\n` : string;
 
-export const serialize = (data: string, printFunctionName: boolean): string =>
-  addExtraLineBreaks(
+export const serialize = (
+  data: string,
+  config?: Config.PrettyFormatSnapshotConfig,
+): string => {
+  let escapeRegex = true;
+  let printFunctionName = false;
+
+  if (config && config.escapeRegex) {
+    escapeRegex = config.escapeRegex;
+  }
+
+  if (config && config.printFunctionName) {
+    printFunctionName = config.printFunctionName;
+  }
+
+  return addExtraLineBreaks(
     normalizeNewlines(
       prettyFormat(data, {
-        escapeRegex: true,
+        escapeRegex,
         plugins: getSerializers(),
         printFunctionName,
       }),
     ),
   );
+}
 
 // unescape double quotes
 export const unescape = (data: string): string => data.replace(/\\(")/g, '$1');

diff --git a/packages/jest-types/src/Config.ts b/packages/jest-types/src/Config.ts
@@ -24,6 +24,11 @@ export type HasteConfig = {
 export type ReporterConfig = [string, Record<string, unknown>];
 export type TransformerConfig = [string, Record<string, unknown>];
 
+export type PrettyFormatSnapshotConfig = {
+  escapeRegex?: boolean;
+  printFunctionName?: boolean;
+};
+
 export type ConfigGlobals = Record<string, any>;
 
 export type DefaultOptions = {
@@ -392,7 +397,7 @@ export type ProjectConfig = {
   modulePaths: Array<string>;
   name: string;
   prettierPath: string;
-  printFunctionName: boolean;
+  prettyFormatSnapshotConfig: PrettyFormatSnapshotConfig;
   resetMocks: boolean;
   resetModules: boolean;
   resolver: Path | null | undefined;

diff --git a/packages/jest-validate/src/__tests__/fixtures/jestConfig.js b/packages/jest-validate/src/__tests__/fixtures/jestConfig.js
@@ -42,7 +42,10 @@ const defaultConfig = {
   notifyMode: 'failure-change',
   preset: null,
   prettierPath: 'prettier',
-  printFunctionName: false,
+  prettyFormatSnapshotConfig: {
+    escapeRegex: true,
+    printFunctionName: false,
+  },
   resetMocks: false,
   resetModules: false,
   restoreMocks: false,
@@ -102,6 +105,10 @@ const validConfig = {
   notifyMode: 'failure-change',
   preset: 'react-native',
   prettierPath: '<rootDir>/node_modules/prettier',
+  prettyFormatSnapshotConfig: {
+    escapeRegex: true,
+    printFunctionName: false,
+  },
   resetMocks: false,
   resetModules: false,
   restoreMocks: false,
@@ -132,7 +139,7 @@ const validConfig = {
   watchman: true,
 };
 
-const format = (value: string) => require('pretty-format')(value, {min: true});
+const format = (value: string) => require('pretty-format')(value, { min: true });
 
 const deprecatedConfig = {
   preprocessorIgnorePatterns: (config: Object) =>