chore: ensure consistent indentation of template strings (#14522)

jestjs · Sep 14, 2023 · eb6cdd2 · eb6cdd2
1 parent 211ddcb
commit eb6cdd2
Show file tree

Hide file tree

Showing 17 changed files with 185 additions and 112 deletions.
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -385,7 +385,7 @@ module.exports = {
   parserOptions: {
     sourceType: 'module',
   },
-  plugins: ['import', 'jsdoc'],
+  plugins: ['import', 'jsdoc', 'unicorn'],
   rules: {
     'accessor-pairs': ['warn', {setWithoutGet: true}],
     'block-scoped-var': 'off',
@@ -590,6 +590,8 @@ module.exports = {
     'wrap-iife': 'off',
     'wrap-regex': 'off',
     yoda: 'off',
+
+    'unicorn/template-indent': 'error',
   },
   settings: {
     'import/ignore': ['react-native'],

diff --git a/docs/Configuration.md b/docs/Configuration.md
@@ -1739,14 +1739,14 @@ test('does not show prototypes for object and array inline', () => {
     array: [{hello: 'Danger'}],
   };
   expect(object).toMatchInlineSnapshot(`
-{
-  "array": [
     {
-      "hello": "Danger",
-    },
-  ],
-}
-    `);
+      "array": [
+        {
+          "hello": "Danger",
+        },
+      ],
+    }
+  `);
 });
 ```
 

diff --git a/docs/SnapshotTesting.md b/docs/SnapshotTesting.md
@@ -127,15 +127,15 @@ it('renders correctly', () => {
     .create(<Link page="https://example.com">Example Site</Link>)
     .toJSON();
   expect(tree).toMatchInlineSnapshot(`
-<a
-  className="normal"
-  href="https://example.com"
-  onMouseEnter={[Function]}
-  onMouseLeave={[Function]}
->
-  Example Site
-</a>
-`);
+    <a
+      className="normal"
+      href="https://example.com"
+      onMouseEnter={[Function]}
+      onMouseLeave={[Function]}
+    >
+      Example Site
+    </a>
+  `);
 });
 ```
 

diff --git a/e2e/resolve/__tests__/resolve.test.js b/e2e/resolve/__tests__/resolve.test.js
@@ -112,7 +112,7 @@ test('should throw module not found error if the module has dependencies that ca
           requiresUnexistingModule.js
           Test7.js
           __tests__/resolve.test.js\n
-        `,
+      `,
     }),
   );
 });

diff --git a/e2e/snapshot-formatting-changes/__tests__/snapshot.test.js b/e2e/snapshot-formatting-changes/__tests__/snapshot.test.js
@@ -13,14 +13,14 @@ describe('snapshot serializer', () => {
       array: [{hello: 'Danger'}],
     };
     expect(object).toMatchInlineSnapshot(`
-{
-        "array": [
-                {
-                        "hello": "Danger",
-                },
-        ],
-}
-`);
+      {
+              "array": [
+                      {
+                              "hello": "Danger",
+                      },
+              ],
+      }
+    `);
   });
 
   it('uses 8 chars for indent, and shows no prototypes for object and array in a snapshot', () => {

diff --git a/package.json b/package.json
@@ -41,6 +41,7 @@
     "eslint-plugin-local": "link:./.eslintplugin",
     "eslint-plugin-markdown": "^3.0.0",
     "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-unicorn": "^46.0.0",
     "execa": "^5.0.0",
     "find-process": "^1.4.1",
     "glob": "^10.0.0",

diff --git a/packages/jest-circus/src/utils.ts b/packages/jest-circus/src/utils.ts
@@ -236,9 +236,9 @@ export const callAsyncCircusFn = (
         Promise.resolve().then(() => {
           if (returnedValue !== undefined) {
             asyncError.message = dedent`
-      Test functions cannot both take a 'done' callback and return something. Either use a 'done' callback, or return a promise.
-      Returned value: ${prettyFormat(returnedValue, {maxDepth: 3})}
-      `;
+              Test functions cannot both take a 'done' callback and return something. Either use a 'done' callback, or return a promise.
+              Returned value: ${prettyFormat(returnedValue, {maxDepth: 3})}
+            `;
             return reject(asyncError);
           }
 
@@ -289,9 +289,9 @@ export const callAsyncCircusFn = (
       reject(
         new Error(
           dedent`
-      test functions can only return Promise or undefined.
-      Returned value: ${prettyFormat(returnedValue, {maxDepth: 3})}
-      `,
+            test functions can only return Promise or undefined.
+            Returned value: ${prettyFormat(returnedValue, {maxDepth: 3})}
+          `,
         ),
       );
       return;

diff --git a/scripts/verifyPnP.mjs b/scripts/verifyPnP.mjs
@@ -52,21 +52,21 @@ try {
   fs.writeFileSync(
     path.join(cwd, 'jsdom.test.js'),
     dedent`
-     /*
-      * @jest-environment jsdom
-      */
+      /*
+       * @jest-environment jsdom
+       */
 
-     test('dummy', () => {
-       expect(window).toBeDefined();
-     });
+      test('dummy', () => {
+        expect(window).toBeDefined();
+      });
     `,
   );
   fs.writeFileSync(
     path.join(cwd, 'node.test.js'),
     dedent`
-     test('dummy', () => {
-       expect(typeof window).toBe('undefined');
-     });
+      test('dummy', () => {
+        expect(typeof window).toBe('undefined');
+      });
     `,
   );
   execa.sync('yarn', ['link', '--private', '--all', rootDirectory], {

diff --git a/website/versioned_docs/version-29.4/Configuration.md b/website/versioned_docs/version-29.4/Configuration.md
@@ -1668,14 +1668,14 @@ test('does not show prototypes for object and array inline', () => {
     array: [{hello: 'Danger'}],
   };
   expect(object).toMatchInlineSnapshot(`
-{
-  "array": [
     {
-      "hello": "Danger",
-    },
-  ],
-}
-    `);
+      "array": [
+        {
+          "hello": "Danger",
+        },
+      ],
+    }
+  `);
 });
 ```
 

diff --git a/website/versioned_docs/version-29.4/SnapshotTesting.md b/website/versioned_docs/version-29.4/SnapshotTesting.md
@@ -127,15 +127,15 @@ it('renders correctly', () => {
     .create(<Link page="https://example.com">Example Site</Link>)
     .toJSON();
   expect(tree).toMatchInlineSnapshot(`
-<a
-  className="normal"
-  href="https://example.com"
-  onMouseEnter={[Function]}
-  onMouseLeave={[Function]}
->
-  Example Site
-</a>
-`);
+    <a
+      className="normal"
+      href="https://example.com"
+      onMouseEnter={[Function]}
+      onMouseLeave={[Function]}
+    >
+      Example Site
+    </a>
+  `);
 });
 ```
 

diff --git a/website/versioned_docs/version-29.5/Configuration.md b/website/versioned_docs/version-29.5/Configuration.md
@@ -1703,14 +1703,14 @@ test('does not show prototypes for object and array inline', () => {
     array: [{hello: 'Danger'}],
   };
   expect(object).toMatchInlineSnapshot(`
-{
-  "array": [
     {
-      "hello": "Danger",
-    },
-  ],
-}
-    `);
+      "array": [
+        {
+          "hello": "Danger",
+        },
+      ],
+    }
+  `);
 });
 ```
 

diff --git a/website/versioned_docs/version-29.5/SnapshotTesting.md b/website/versioned_docs/version-29.5/SnapshotTesting.md
@@ -127,15 +127,15 @@ it('renders correctly', () => {
     .create(<Link page="https://example.com">Example Site</Link>)
     .toJSON();
   expect(tree).toMatchInlineSnapshot(`
-<a
-  className="normal"
-  href="https://example.com"
-  onMouseEnter={[Function]}
-  onMouseLeave={[Function]}
->
-  Example Site
-</a>
-`);
+    <a
+      className="normal"
+      href="https://example.com"
+      onMouseEnter={[Function]}
+      onMouseLeave={[Function]}
+    >
+      Example Site
+    </a>
+  `);
 });
 ```
 

diff --git a/website/versioned_docs/version-29.6/Configuration.md b/website/versioned_docs/version-29.6/Configuration.md
@@ -1739,14 +1739,14 @@ test('does not show prototypes for object and array inline', () => {
     array: [{hello: 'Danger'}],
   };
   expect(object).toMatchInlineSnapshot(`
-{
-  "array": [
     {
-      "hello": "Danger",
-    },
-  ],
-}
-    `);
+      "array": [
+        {
+          "hello": "Danger",
+        },
+      ],
+    }
+  `);
 });
 ```
 

diff --git a/website/versioned_docs/version-29.6/SnapshotTesting.md b/website/versioned_docs/version-29.6/SnapshotTesting.md
@@ -127,15 +127,15 @@ it('renders correctly', () => {
     .create(<Link page="https://example.com">Example Site</Link>)
     .toJSON();
   expect(tree).toMatchInlineSnapshot(`
-<a
-  className="normal"
-  href="https://example.com"
-  onMouseEnter={[Function]}
-  onMouseLeave={[Function]}
->
-  Example Site
-</a>
-`);
+    <a
+      className="normal"
+      href="https://example.com"
+      onMouseEnter={[Function]}
+      onMouseLeave={[Function]}
+    >
+      Example Site
+    </a>
+  `);
 });
 ```
 

diff --git a/website/versioned_docs/version-29.7/Configuration.md b/website/versioned_docs/version-29.7/Configuration.md
@@ -1739,14 +1739,14 @@ test('does not show prototypes for object and array inline', () => {
     array: [{hello: 'Danger'}],
   };
   expect(object).toMatchInlineSnapshot(`
-{
-  "array": [
     {
-      "hello": "Danger",
-    },
-  ],
-}
-    `);
+      "array": [
+        {
+          "hello": "Danger",
+        },
+      ],
+    }
+  `);
 });
 ```
 

diff --git a/website/versioned_docs/version-29.7/SnapshotTesting.md b/website/versioned_docs/version-29.7/SnapshotTesting.md
@@ -127,15 +127,15 @@ it('renders correctly', () => {
     .create(<Link page="https://example.com">Example Site</Link>)
     .toJSON();
   expect(tree).toMatchInlineSnapshot(`
-<a
-  className="normal"
-  href="https://example.com"
-  onMouseEnter={[Function]}
-  onMouseLeave={[Function]}
->
-  Example Site
-</a>
-`);
+    <a
+      className="normal"
+      href="https://example.com"
+      onMouseEnter={[Function]}
+      onMouseLeave={[Function]}
+    >
+      Example Site
+    </a>
+  `);
 });
 ```