chore: errors should be named as such (jestjs#14817)

AmerAlkaki · Dec 30, 2023 · 2ddc430 · 2ddc430
1 parent 2f6984d
commit 2ddc430
Show file tree

Hide file tree

Showing 72 changed files with 253 additions and 254 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -12,6 +12,7 @@ website/static
 
 # Third-party script
 packages/jest-diff/src/cleanupSemantic.ts
+e2e/native-esm/wasm-bindgen/index_bg.js
 
 **/.yarn
 **/.pnp.*

diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -425,14 +425,6 @@ module.exports = {
         'no-unused-vars': 'off',
       },
     },
-    {
-      files: 'e2e/native-esm/wasm-bindgen/index_bg.js',
-      rules: {
-        'unicorn/prefer-code-point': 'off',
-        'unicorn/prefer-optional-catch-binding': 'off',
-        'unicorn/text-encoding-identifier-case': 'off',
-      },
-    },
     {
       files: 'packages/jest-mock/src/__tests__/**/*',
       rules: {
@@ -711,7 +703,6 @@ module.exports = {
     'unicorn/prefer-reflect-apply': 'off',
 
     // TODO: turn on at some point
-    'unicorn/catch-error-name': 'off',
     'unicorn/error-message': 'off',
     'unicorn/no-object-as-default-parameter': 'off',
     'unicorn/no-typeof-undefined': 'off',

diff --git a/docs/TestingAsyncCode.md b/docs/TestingAsyncCode.md
@@ -33,8 +33,8 @@ test('the fetch fails with an error', async () => {
   expect.assertions(1);
   try {
     await fetchData();
-  } catch (e) {
-    expect(e).toMatch('error');
+  } catch (error) {
+    expect(error).toMatch('error');
   }
 });
 ```
@@ -64,7 +64,7 @@ If you expect a promise to be rejected, use the `.catch` method. Make sure to ad
 ```js
 test('the fetch fails with an error', () => {
   expect.assertions(1);
-  return fetchData().catch(e => expect(e).toMatch('error'));
+  return fetchData().catch(error => expect(error).toMatch('error'));
 });
 ```
 

diff --git a/docs/TutorialAsync.md b/docs/TutorialAsync.md
@@ -114,8 +114,8 @@ Errors can be handled using the `.catch` method. Make sure to add `expect.assert
 // Testing for async errors using Promise.catch.
 it('tests error with promises', () => {
   expect.assertions(1);
-  return user.getUserName(2).catch(e =>
-    expect(e).toEqual({
+  return user.getUserName(2).catch(error =>
+    expect(error).toEqual({
       error: 'User with 2 not found.',
     }),
   );
@@ -126,8 +126,8 @@ it('tests error with async/await', async () => {
   expect.assertions(1);
   try {
     await user.getUserName(1);
-  } catch (e) {
-    expect(e).toEqual({
+  } catch (error) {
+    expect(error).toEqual({
       error: 'User with 1 not found.',
     });
   }

diff --git a/e2e/__tests__/__snapshots__/callDoneTwice.test.ts.snap b/e2e/__tests__/__snapshots__/callDoneTwice.test.ts.snap
@@ -25,7 +25,7 @@ exports[`\`done()\` should not be called more than once 1`] = `
     > 17 |         done();
          |         ^
       18 |       })
-      19 |       .catch(err => err);
+      19 |       .catch(error => error);
       20 |   });
 
       at done (__tests__/index.test.js:17:9)

diff --git a/e2e/__tests__/jsonReporter.test.ts b/e2e/__tests__/jsonReporter.test.ts
@@ -32,9 +32,9 @@ describe('JSON Reporter', () => {
 
     try {
       jsonResult = JSON.parse(testOutput);
-    } catch (err: any) {
+    } catch (error: any) {
       throw new Error(
-        `Can't parse the JSON result from ${outputFileName}, ${err.toString()}`,
+        `Can't parse the JSON result from ${outputFileName}, ${error.toString()}`,
       );
     }
 
@@ -85,9 +85,9 @@ describe('JSON Reporter', () => {
 
     try {
       jsonResult = JSON.parse(result.stdout);
-    } catch (err: any) {
+    } catch (error: any) {
       throw new Error(
-        `Can't parse the JSON result from stdout${err.toString()}`,
+        `Can't parse the JSON result from stdout${error.toString()}`,
       );
     }
 

diff --git a/e2e/__tests__/testRetries.test.ts b/e2e/__tests__/testRetries.test.ts
@@ -79,9 +79,9 @@ describe('Test Retries', () => {
 
     try {
       jsonResult = JSON.parse(testOutput);
-    } catch (err: any) {
+    } catch (error: any) {
       throw new Error(
-        `Can't parse the JSON result from ${outputFileName}, ${err.toString()}`,
+        `Can't parse the JSON result from ${outputFileName}, ${error.toString()}`,
       );
     }
 
@@ -110,9 +110,9 @@ describe('Test Retries', () => {
 
     try {
       jsonResult = JSON.parse(testOutput);
-    } catch (err: any) {
+    } catch (error: any) {
       throw new Error(
-        `Can't parse the JSON result from ${outputFileName}, ${err.toString()}`,
+        `Can't parse the JSON result from ${outputFileName}, ${error.toString()}`,
       );
     }
 
@@ -141,9 +141,9 @@ describe('Test Retries', () => {
 
     try {
       jsonResult = JSON.parse(testOutput);
-    } catch (err: any) {
+    } catch (error: any) {
       throw new Error(
-        `Can't parse the JSON result from ${outputFileName}, ${err.toString()}`,
+        `Can't parse the JSON result from ${outputFileName}, ${error.toString()}`,
       );
     }
 

diff --git a/e2e/call-done-twice/__tests__/index.test.js b/e2e/call-done-twice/__tests__/index.test.js
@@ -16,7 +16,7 @@ describe('`done()` called more than once', () => {
         done();
         done();
       })
-      .catch(err => err);
+      .catch(error => error);
   });
 });
 

diff --git a/e2e/failures/__tests__/errorWithCause.test.js b/e2e/failures/__tests__/errorWithCause.test.js
@@ -23,8 +23,8 @@ function g() {
 function f() {
   try {
     g();
-  } catch (err) {
-    throw buildErrorWithCause('error during f', {cause: err});
+  } catch (error) {
+    throw buildErrorWithCause('error during f', {cause: error});
   }
 }
 

diff --git a/e2e/failures/__tests__/errorWithCauseInDescribe.test.js b/e2e/failures/__tests__/errorWithCauseInDescribe.test.js
@@ -23,8 +23,8 @@ function g() {
 function f() {
   try {
     g();
-  } catch (err) {
-    throw buildErrorWithCause('error during f', {cause: err});
+  } catch (error) {
+    throw buildErrorWithCause('error during f', {cause: error});
   }
 }
 

diff --git a/e2e/override-globals/__tests__/index.js b/e2e/override-globals/__tests__/index.js
@@ -21,8 +21,8 @@ describe('parent', () => {
         try {
           expect(() => new Promise()).toThrow('Booo');
           done();
-        } catch (e) {
-          done.fail(e);
+        } catch (error) {
+          done.fail(error);
         }
       }, 10);
     });

diff --git a/e2e/read-initial-options/readOptions.js b/e2e/read-initial-options/readOptions.js
@@ -16,7 +16,7 @@ async function readConfig() {
   }
   console.log(JSON.stringify(await readInitialOptions(config, options)));
 }
-readConfig().catch(err => {
-  console.error(err);
+readConfig().catch(error => {
+  console.error(error);
   process.exitCode = 1;
 });
diff --git a/e2e/run-programmatically-multiple-projects/run-jest.js b/e2e/run-programmatically-multiple-projects/run-jest.js
@@ -16,7 +16,7 @@ const config = {
 
 runCLI({config: JSON.stringify(config)}, [process.cwd()])
   .then(() => console.log('run-programmatically-mutiple-projects completed'))
-  .catch(err => {
-    console.error(err);
+  .catch(error => {
+    console.error(error);
     process.exitCode = 1;
   });
diff --git a/e2e/runJest.ts b/e2e/runJest.ts
@@ -151,10 +151,10 @@ export const json = function (
       ...result,
       json: JSON.parse(result.stdout),
     };
-  } catch (e: any) {
+  } catch (error: any) {
     throw new Error(dedent`
       Can't parse JSON.
-      ERROR: ${e.name} ${e.message}
+      ERROR: ${error.name} ${error.message}
       STDOUT: ${result.stdout}
       STDERR: ${result.stderr}
     `);

diff --git a/e2e/transform/transform-esm-runner/runner.mjs b/e2e/transform/transform-esm-runner/runner.mjs
@@ -39,7 +39,7 @@ export default class BaseTestRunner {
             };
           })
           .then(result => onResult(test, result))
-          .catch(err => onFailure(test, err)),
+          .catch(error => onFailure(test, error)),
       Promise.resolve(),
     );
   }

diff --git a/e2e/transform/transform-runner/runner.ts b/e2e/transform/transform-runner/runner.ts
@@ -63,7 +63,7 @@ export default class BaseTestRunner {
               };
             })
             .then(result => onResult(test, result))
-            .catch(err => onFailure(test, err)),
+            .catch(error => onFailure(test, error)),
         ),
       Promise.resolve(),
     );

diff --git a/examples/async/__tests__/user.test.js b/examples/async/__tests__/user.test.js
@@ -42,8 +42,8 @@ it('tests error with rejects', () => {
 // Testing for async errors using Promise.catch.
 test('tests error with promises', async () => {
   expect.assertions(1);
-  return user.getUserName(2).catch(e =>
-    expect(e).toEqual({
+  return user.getUserName(2).catch(error =>
+    expect(error).toEqual({
       error: 'User with 2 not found.',
     }),
   );
@@ -54,8 +54,8 @@ it('tests error with async/await', async () => {
   expect.assertions(1);
   try {
     await user.getUserName(1);
-  } catch (e) {
-    expect(e).toEqual({
+  } catch (error) {
+    expect(error).toEqual({
       error: 'User with 1 not found.',
     });
   }

diff --git a/packages/expect-utils/src/__tests__/isError.test.ts b/packages/expect-utils/src/__tests__/isError.test.ts
@@ -55,8 +55,8 @@ describe('isError', () => {
     testErrorFromDifferentContext(win => {
       try {
         win.document.querySelectorAll('');
-      } catch (e) {
-        return e as Error;
+      } catch (error) {
+        return error as Error;
       }
 
       return null;

diff --git a/packages/expect/src/__tests__/matchers.test.js b/packages/expect/src/__tests__/matchers.test.js
@@ -71,8 +71,8 @@ describe('.rejects', () => {
       let error;
       try {
         jestExpect(value).rejects.toBe(111);
-      } catch (e) {
-        error = e;
+      } catch (rejectedError) {
+        error = rejectedError;
       }
       expect(error).toBeDefined();
     });
@@ -81,8 +81,8 @@ describe('.rejects', () => {
       let error;
       try {
         await jestExpect(value).rejects.toBeDefined();
-      } catch (e) {
-        error = e;
+      } catch (rejectedError) {
+        error = rejectedError;
       }
       expect(error).toBeDefined();
       expect(error.message).toMatchSnapshot();
@@ -94,8 +94,8 @@ describe('.rejects', () => {
       let error;
       try {
         jestExpect(value).rejects.not.toBe(111);
-      } catch (e) {
-        error = e;
+      } catch (rejectedError) {
+        error = rejectedError;
       }
       expect(error).toBeDefined();
     });
@@ -104,8 +104,8 @@ describe('.rejects', () => {
       let error;
       try {
         await jestExpect(value).rejects.not.toBeDefined();
-      } catch (e) {
-        error = e;
+      } catch (rejectedError) {
+        error = rejectedError;
       }
       expect(error).toBeDefined();
       expect(error.message).toMatchSnapshot();
@@ -116,8 +116,8 @@ describe('.rejects', () => {
     let error;
     try {
       await jestExpect(Promise.resolve(4)).rejects.toBe(4);
-    } catch (e) {
-      error = e;
+    } catch (error_) {
+      error = error_;
     }
     expect(error).toBeDefined();
     expect(error.message).toMatchSnapshot();
@@ -148,8 +148,8 @@ describe('.resolves', () => {
       let error;
       try {
         jestExpect(value).resolves.toBeDefined();
-      } catch (e) {
-        error = e;
+      } catch (rejectedError) {
+        error = rejectedError;
       }
       expect(error).toBeDefined();
       expect(error.message).toMatchSnapshot();
@@ -159,8 +159,8 @@ describe('.resolves', () => {
       let error;
       try {
         await jestExpect(value).resolves.toBeDefined();
-      } catch (e) {
-        error = e;
+      } catch (rejectedError) {
+        error = rejectedError;
       }
       expect(error).toBeDefined();
       expect(error.message).toMatchSnapshot();
@@ -172,8 +172,8 @@ describe('.resolves', () => {
       let error;
       try {
         jestExpect(value).resolves.not.toBeDefined();
-      } catch (e) {
-        error = e;
+      } catch (rejectedError) {
+        error = rejectedError;
       }
       expect(error).toBeDefined();
       expect(error.message).toMatchSnapshot();
@@ -183,8 +183,8 @@ describe('.resolves', () => {
       let error;
       try {
         await jestExpect(value).resolves.not.toBeDefined();
-      } catch (e) {
-        error = e;
+      } catch (rejectedError) {
+        error = rejectedError;
       }
       expect(error).toBeDefined();
       expect(error.message).toMatchSnapshot();
@@ -195,8 +195,8 @@ describe('.resolves', () => {
     let error;
     try {
       await jestExpect(Promise.reject(4)).resolves.toBe(4);
-    } catch (e) {
-      error = e;
+    } catch (error_) {
+      error = error_;
     }
     expect(error).toBeDefined();
     expect(error.message).toMatchSnapshot();
-Original file line number
+Diff line change
@@ Expand Up / @@ -16,7 +16,7 @@ describe('`done()` called more than once', () => { @@
             done();
             done();
           })
-          .catch(err => err);
+          .catch(error => error);
       });
     });
@@ Expand Down @@