eslint-plugin-jest 27.2.0 → 27.2.2

package/README.md

@@ -2,7 +2,7 @@
   <a href="https://eslint.org/">
     <img height="150" src="https://eslint.org/assets/images/logo/eslint-logo-color.svg">
   </a>
-  <a href="https://facebook.github.io/jest/">
+  <a href="https://jestjs.io/">
     <img width="150" height="150" vspace="" hspace="25" src="https://jestjs.io/img/jest.png">
   </a>
   <h1>eslint-plugin-jest</h1>

package/docs/rules/no-alias-methods.md

@@ -11,7 +11,7 @@ This rule _warns_ in the 🎨 `style`
 <!-- end auto-generated rule header -->
 
 > These aliases are going to be removed in the next major version of Jest - see
-> <https://github.com/facebook/jest/issues/13164> for more
+> <https://github.com/jestjs/jest/issues/13164> for more
 
 Several Jest methods have alias names, such as `toThrow` having the alias of
 `toThrowError`. This rule ensures that only the canonical name as used in the

package/docs/rules/no-hooks.md

@@ -173,4 +173,4 @@ safely disable this rule.
 
 ## Further Reading
 
-- [Jest docs - Setup and Teardown](https://facebook.github.io/jest/docs/en/setup-teardown.html)
+- [Jest docs - Setup and Teardown](https://jestjs.io/docs/setup-teardown)

package/docs/rules/no-if.md

@@ -1,7 +1,7 @@
 # Disallow conditional logic (`no-if`)
 
 ❌ This rule is deprecated. It was replaced by
-[`jest/no-conditional-in-test`](../../docs/rules/no-conditional-in-test.md).
+[`jest/no-conditional-in-test`](no-conditional-in-test.md).
 
 <!-- end auto-generated rule header -->
 

package/docs/rules/no-large-snapshots.md

@@ -24,6 +24,10 @@ module.exports = {
 };
 ```
 
+In order to check external snapshots, you must also have `eslint` check files
+with the `.snap` extension by either passing `--ext snap` on the command line or
+by explicitly specifying `.snap` in `overrides`.
+
 ## Rule details
 
 This rule looks at all Jest inline and external snapshots (files with `.snap`

package/docs/rules/require-hook.md

@@ -2,12 +2,8 @@
 
 <!-- end auto-generated rule header -->
 
-Often while writing tests you have some setup work that needs to happen before
-tests run, and you have some finishing work that needs to happen after tests
-run. Jest provides helper functions to handle this.
-
-It's common when writing tests to need to perform setup work that needs to
-happen before tests run, and finishing work after tests run.
+It's common when writing tests to need to perform setup work that has to happen
+before tests run, and finishing work after tests run.
 
 Because Jest executes all `describe` handlers in a test file _before_ it
 executes any of the actual tests, it's important to ensure setup and teardown

package/docs/rules/valid-expect.md

@@ -66,7 +66,7 @@ This rule is enabled by default.
 Enforces to use `await` inside block statements. Using `return` will trigger a
 warning. Returning one line statements with arrow functions is _always allowed_.
 
-Examples of **incorrect** code for the { "alwaysAwait": **true** } option:
+Examples of **incorrect** code for the `{ "alwaysAwait": true }` option:
 
 ```js
 // alwaysAwait: true
@@ -76,7 +76,7 @@ test('test1', async () => {
 });
 ```
 
-Examples of **correct** code for the { "alwaysAwait": **true** } option:
+Examples of **correct** code for the `{ "alwaysAwait": true }` option:
 
 ```js
 // alwaysAwait: true

package/lib/index.js

@@ -7,6 +7,8 @@ var snapshotProcessor = _interopRequireWildcard(require("./processors/snapshot-p
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+// v5 of `@typescript-eslint/experimental-utils` removed this
+
 // copied from https://github.com/babel/babel/blob/d8da63c929f2d28c401571e2a43166678c555bc4/packages/babel-helpers/src/helpers.js#L602-L606
 /* istanbul ignore next */
 const interopRequireDefault = obj => obj && obj.__esModule ? obj : {
@@ -17,18 +19,9 @@ const importDefault = moduleName =>
 interopRequireDefault(require(moduleName)).default;
 const rulesDir = (0, _path.join)(__dirname, 'rules');
 const excludedFiles = ['__tests__', 'detectJestVersion', 'utils'];
-const rules = (0, _fs.readdirSync)(rulesDir).map(rule => (0, _path.parse)(rule).name).filter(rule => !excludedFiles.includes(rule)).reduce((acc, curr) => ({
-  ...acc,
-  [curr]: importDefault((0, _path.join)(rulesDir, curr))
-}), {});
-const recommendedRules = Object.entries(rules).filter(([, rule]) => rule.meta.docs.recommended).reduce((acc, [name, rule]) => ({
-  ...acc,
-  [`jest/${name}`]: rule.meta.docs.recommended
-}), {});
-const allRules = Object.entries(rules).filter(([, rule]) => !rule.meta.deprecated).reduce((acc, [name]) => ({
-  ...acc,
-  [`jest/${name}`]: 'error'
-}), {});
+const rules = Object.fromEntries((0, _fs.readdirSync)(rulesDir).map(rule => (0, _path.parse)(rule).name).filter(rule => !excludedFiles.includes(rule)).map(rule => [rule, importDefault((0, _path.join)(rulesDir, rule))]));
+const recommendedRules = Object.fromEntries(Object.entries(rules).filter(([, rule]) => rule.meta.docs.recommended).map(([name, rule]) => [`jest/${name}`, rule.meta.docs.recommended]));
+const allRules = Object.fromEntries(Object.entries(rules).filter(([, rule]) => !rule.meta.deprecated).map(([name]) => [`jest/${name}`, 'error']));
 const createConfig = rules => ({
   plugins: ['jest'],
   env: {

package/lib/processors/__tests__/snapshot-processor.test.js

@@ -0,0 +1,36 @@
+"use strict";
+
+var snapshotProcessor = _interopRequireWildcard(require("../snapshot-processor"));
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+describe('snapshot-processor', () => {
+  it('exports an object with preprocess and postprocess functions', () => {
+    expect(snapshotProcessor).toMatchObject({
+      preprocess: expect.any(Function),
+      postprocess: expect.any(Function)
+    });
+  });
+  describe('preprocess function', () => {
+    it('should pass on untouched source code to source array', () => {
+      const {
+        preprocess
+      } = snapshotProcessor;
+      const sourceCode = "const name = 'johnny bravo';";
+      const result = preprocess(sourceCode);
+      expect(result).toEqual([sourceCode]);
+    });
+  });
+  describe('postprocess function', () => {
+    it('should only return messages about snapshot specific rules', () => {
+      const {
+        postprocess
+      } = snapshotProcessor;
+      const result = postprocess([['no-console', 'global-require', 'jest/no-large-snapshots'].map(ruleId => ({
+        ruleId
+      }))]);
+      expect(result).toEqual([{
+        ruleId: 'jest/no-large-snapshots'
+      }]);
+    });
+  });
+});