feat(jest-config): set default snapshotFormat (#13036)

jestjs · Jul 17, 2022 · c91dbcf · c91dbcf
1 parent c059213
commit c91dbcf
Show file tree

Hide file tree

Showing 13 changed files with 59 additions and 43 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,8 @@
 
 ### Features
 
+- `[jest-config]` [**BREAKING**] Make `snapshotFormat` default to `escapeString: false` and `printBasicPrototype: false` ([#13036](https://github.com/facebook/jest/pull/13036))
+
 ### Fixes
 
 ### Chore & Maintenance

diff --git a/docs/Configuration.md b/docs/Configuration.md
@@ -1614,7 +1614,7 @@ The number of seconds after which a test is considered as slow and reported as s
 
 ### `snapshotFormat` \[object]
 
-Default: `undefined`
+Default: `{escapeString: false, printBasicPrototype: false}`
 
 Allows overriding specific snapshot formatting options documented in the [pretty-format readme](https://www.npmjs.com/package/pretty-format#usage-with-options), with the exceptions of `compareKeys` and `plugins`. For example, this config would have the snapshot formatter not print a prefix for "Object" and "Array":
 

diff --git a/e2e/__tests__/__snapshots__/showConfig.test.ts.snap b/e2e/__tests__/__snapshots__/showConfig.test.ts.snap
@@ -58,6 +58,10 @@ exports[`--showConfig outputs config info and exits 1`] = `
       "setupFilesAfterEnv": [],
       "skipFilter": false,
       "slowTestThreshold": 5,
+      "snapshotFormat": {
+        "escapeString": false,
+        "printBasicPrototype": false
+      },
       "snapshotSerializers": [],
       "testEnvironment": "<<REPLACED_JEST_PACKAGES_DIR>>/jest-environment-node/build/index.js",
       "testEnvironmentOptions": {},
@@ -122,6 +126,10 @@ exports[`--showConfig outputs config info and exits 1`] = `
     "rootDir": "<<REPLACED_ROOT_DIR>>",
     "runTestsByPath": false,
     "skipFilter": false,
+    "snapshotFormat": {
+      "escapeString": false,
+      "printBasicPrototype": false
+    },
     "testFailureExitCode": 1,
     "testPathPattern": "",
     "testSequencer": "<<REPLACED_JEST_PACKAGES_DIR>>/jest-test-sequencer/build/index.js",

diff --git a/e2e/__tests__/__snapshots__/snapshotSerializers.test.ts.snap b/e2e/__tests__/__snapshots__/snapshotSerializers.test.ts.snap
@@ -3,8 +3,8 @@
 exports[`Snapshot serializers renders snapshot 1`] = `
 Object {
   "snapshot serializers works with array of strings in property matcher 1": "
-Object {
-  "arrayOfStrings": Array [
+{
+  "arrayOfStrings": [
     "stream",
   ],
 }
@@ -15,8 +15,8 @@ Object {
 />
 ",
   "snapshot serializers works with expect.XXX within array in property matcher 1": "
-Object {
-  "arrayOfStrings": Array [
+{
+  "arrayOfStrings": [
     Any<String>,
   ],
 }
@@ -26,7 +26,7 @@ Object {
   "snapshot serializers works with prepended plugins and default serializers 1": "
 <div
   aProp={
-    Object {
+    {
       "a": 6,
     }
   }
@@ -36,7 +36,7 @@ Object {
   "snapshot serializers works with prepended plugins from expect method called once 1": "
 <div
   aProp={
-    Object {
+    {
       "a": 6,
     }
   }
@@ -46,7 +46,7 @@ Object {
   "snapshot serializers works with prepended plugins from expect method called twice 1": "
 <div
   aProp={
-    Object {
+    {
       "a": 6,
     }
   }

diff --git a/e2e/__tests__/__snapshots__/toMatchInlineSnapshot.test.ts.snap b/e2e/__tests__/__snapshots__/toMatchInlineSnapshot.test.ts.snap
@@ -3,7 +3,7 @@
 exports[`basic support: initial write 1`] = `
 "test('inline snapshots', () =>
   expect({apple: 'original value'}).toMatchInlineSnapshot(\`
-    Object {
+    {
       "apple": "original value",
     }
   \`));
@@ -13,7 +13,7 @@ exports[`basic support: initial write 1`] = `
 exports[`basic support: snapshot mismatch 1`] = `
 "test('inline snapshots', () =>
 expect({apple: 'updated value'}).toMatchInlineSnapshot(\`
-  Object {
+  {
     "apple": "original value",
   }
 \`));"
@@ -22,7 +22,7 @@ expect({apple: 'updated value'}).toMatchInlineSnapshot(\`
 exports[`basic support: snapshot passed 1`] = `
 "test('inline snapshots', () =>
   expect({apple: 'original value'}).toMatchInlineSnapshot(\`
-    Object {
+    {
       "apple": "original value",
     }
   \`));
@@ -32,7 +32,7 @@ exports[`basic support: snapshot passed 1`] = `
 exports[`basic support: snapshot updated 1`] = `
 "test('inline snapshots', () =>
   expect({apple: 'updated value'}).toMatchInlineSnapshot(\`
-    Object {
+    {
       "apple": "updated value",
     }
   \`));
@@ -68,7 +68,7 @@ exports[`handles property matchers: initial write 1`] = `
   expect({createdAt: new Date()}).toMatchInlineSnapshot(
     {createdAt: expect.any(Date)},
     \`
-    Object {
+    {
       "createdAt": Any<Date>,
     }
   \`,
@@ -82,7 +82,7 @@ exports[`handles property matchers: snapshot failed 1`] = `
 expect({createdAt: "string"}).toMatchInlineSnapshot(
   {createdAt: expect.any(Date)},
   \`
-  Object {
+  {
     "createdAt": Any<Date>,
   }
 \`,
@@ -95,7 +95,7 @@ exports[`handles property matchers: snapshot passed 1`] = `
   expect({createdAt: new Date()}).toMatchInlineSnapshot(
     {createdAt: expect.any(Date)},
     \`
-    Object {
+    {
       "createdAt": Any<Date>,
     }
   \`,
@@ -109,7 +109,7 @@ exports[`handles property matchers: snapshot updated 1`] = `
   expect({createdAt: 'string'}).toMatchInlineSnapshot(
     {createdAt: expect.any(String)},
     \`
-    Object {
+    {
       "createdAt": Any<String>,
     }
   \`,
@@ -122,7 +122,7 @@ exports[`indentation is correct in the presences of existing snapshots, when the
 "it('is true', () => {
   expect(true).toMatchInlineSnapshot(\`true\`);
   expect([1, 2, 3]).toMatchInlineSnapshot(\`
-    Array [
+    [
       1,
       2,
       3,
@@ -135,12 +135,12 @@ exports[`indentation is correct in the presences of existing snapshots, when the
 exports[`indentation is correct in the presences of existing snapshots: existing snapshot 1`] = `
 "test('existing snapshot', () => {
   expect({hello: 'world'}).toMatchInlineSnapshot(\`
-    Object {
+    {
       "hello": "world",
     }
   \`);
   expect({hello: 'world'}).toMatchInlineSnapshot(\`
-    Object {
+    {
       "hello": "world",
     }
   \`);
@@ -160,22 +160,22 @@ expect.extend({
 });
 test('inline snapshots', () => {
   expect({apple: 'value 1'}).toMatchCustomInlineSnapshot(\`
-    Object {
+    {
       "apple": "value 1",
     }
   \`);
   expect({apple: 'value 2'}).toMatchInlineSnapshot(\`
-    Object {
+    {
       "apple": "value 2",
     }
   \`);
   expect({apple: 'value 3'}).toMatchCustomInlineSnapshot2(\`
-    Object {
+    {
       "apple": "value 3",
     }
   \`);
   expect({apple: 'value 4'}).toMatchInlineSnapshot(\`
-    Object {
+    {
       "apple": "value 4",
     }
   \`);
@@ -251,15 +251,15 @@ test('inline snapshots', () => {
       id: expect.any(Number),
     },
     \`
-    Object {
+    {
       "createdAt": Any<Date>,
       "id": Any<Number>,
       "name": "LeBron James",
     }
   \`,
   );
   expect(user).toMatchUserInlineSnapshot(\`
-    Object {
+    {
       "createdAt": Any<Date>,
       "id": Any<Number>,
       "name": "LeBron James",
@@ -278,7 +278,7 @@ expect.extend({
 });
 test('inline snapshots', () => {
   expect({apple: 'original value'}).toMatchCustomInlineSnapshot(\`
-    Object {
+    {
       "apple": "original value",
     }
   \`);
@@ -289,7 +289,7 @@ test('inline snapshots', () => {
 exports[`writes snapshots with non-literals in expect(...) 1`] = `
 "it('works with inline snapshots', () => {
   expect({a: 1}).toMatchInlineSnapshot(\`
-    Object {
+    {
       "a": 1,
     }
   \`);

diff --git a/e2e/__tests__/failureDetailsProperty.test.ts b/e2e/__tests__/failureDetailsProperty.test.ts
@@ -90,7 +90,7 @@ test('that the failureDetails property is set', () => {
             "actual": "",
             "error": Object {
               "matcherResult": Object {
-                "actual": "Object {
+                "actual": "{
         "p1": "hello",
         "p2": "world",
       }",
@@ -105,7 +105,7 @@ test('that the failureDetails property is set', () => {
       - Snapshot  - 1
       + Received  + 1
 
-        Object {
+        {
           "p1": "hello",
       -   "p2": "sunshine",
       +   "p2": "world",
@@ -123,7 +123,7 @@ test('that the failureDetails property is set', () => {
       - Snapshot  - 1
       + Received  + 1
 
-        Object {
+        {
           "p1": "hello",
       -   "p2": "sunshine",
       +   "p2": "world",
@@ -136,7 +136,7 @@ test('that the failureDetails property is set', () => {
       - Snapshot  - 1
       + Received  + 1
 
-        Object {
+        {
           "p1": "hello",
       -   "p2": "sunshine",
       +   "p2": "world",
@@ -215,7 +215,7 @@ test('that the failureDetails property is set', () => {
         Array [
           Object {
             "matcherResult": Object {
-              "actual": "Object {
+              "actual": "{
         "p1": "hello",
         "p2": "world",
       }",
@@ -230,7 +230,7 @@ test('that the failureDetails property is set', () => {
       - Snapshot  - 1
       + Received  + 1
 
-        Object {
+        {
           "p1": "hello",
       -   "p2": "sunshine",
       +   "p2": "world",

diff --git a/e2e/__tests__/snapshotMockFs.test.ts b/e2e/__tests__/snapshotMockFs.test.ts
@@ -29,7 +29,7 @@ test('store snapshot even if fs is mocked', () => {
 
   const content = require(snapshotFile);
   expect(content['snapshot 1']).toBe(`
-Object {
+{
   "foo": "bar",
 }
 `);

diff --git a/e2e/__tests__/toMatchInlineSnapshot.test.ts b/e2e/__tests__/toMatchInlineSnapshot.test.ts
@@ -364,7 +364,7 @@ test('indentation is correct in the presences of existing snapshots', () => {
   const test = `
     test('existing snapshot', () => {
       expect({ hello: 'world' }).toMatchInlineSnapshot(\`
-        Object {
+        {
           "hello": "world",
         }
       \`);

diff --git a/examples/react-native/__tests__/__snapshots__/intro.test.js.snap b/examples/react-native/__tests__/__snapshots__/intro.test.js.snap
@@ -3,7 +3,7 @@
 exports[`renders correctly 1`] = `
 <View
   style={
-    Object {
+    {
       "alignItems": "center",
       "backgroundColor": "#F5FCFF",
       "flex": 1,
@@ -13,7 +13,7 @@ exports[`renders correctly 1`] = `
 >
   <Text
     style={
-      Object {
+      {
         "fontSize": 20,
         "margin": 10,
         "textAlign": "center",
@@ -24,7 +24,7 @@ exports[`renders correctly 1`] = `
   </Text>
   <Text
     style={
-      Object {
+      {
         "color": "#333333",
         "marginBottom": 5,
         "textAlign": "center",
@@ -46,7 +46,7 @@ exports[`renders the ActivityIndicator component 1`] = `
 exports[`renders the FlatList component 1`] = `
 <RCTScrollView
   data={
-    Array [
+    [
       "apple",
       "banana",
       "kiwi",
@@ -65,8 +65,8 @@ exports[`renders the FlatList component 1`] = `
   removeClippedSubviews={false}
   renderItem={[Function]}
   scrollEventThrottle={50}
-  stickyHeaderIndices={Array []}
-  viewabilityConfigCallbackPairs={Array []}
+  stickyHeaderIndices={[]}
+  viewabilityConfigCallbackPairs={[]}
 >
   <View>
     <View

diff --git a/jest.config.mjs b/jest.config.mjs
@@ -33,7 +33,7 @@ export default {
   ],
   projects: ['<rootDir>', '<rootDir>/examples/*/'],
   snapshotFormat: {
-    escapeString: false,
+    printBasicPrototype: true,
   },
   snapshotSerializers: [require.resolve('jest-serializer-ansi-escapes')],
   testPathIgnorePatterns: [

diff --git a/packages/jest-config/src/Defaults.ts b/packages/jest-config/src/Defaults.ts
@@ -72,6 +72,7 @@ const defaultOptions: Config.DefaultOptions = {
   setupFilesAfterEnv: [],
   skipFilter: false,
   slowTestThreshold: 5,
+  snapshotFormat: {escapeString: false, printBasicPrototype: false},
   snapshotSerializers: [],
   testEnvironment: 'jest-environment-node',
   testEnvironmentOptions: {},