eslint-plugin-jest 26.9.0 → 27.0.0

package/README.md

@@ -203,7 +203,7 @@ installations requiring long-term consistency.
 | [expect-expect](docs/rules/expect-expect.md)                                 | Enforce assertion to be made in a test body                         | ![recommended][] |              |
 | [max-expects](docs/rules/max-expects.md)                                     | Enforces a maximum number assertion calls in a test body            |                  |              |
 | [max-nested-describe](docs/rules/max-nested-describe.md)                     | Enforces a maximum depth to nested describe calls                   |                  |              |
-| [no-alias-methods](docs/rules/no-alias-methods.md)                           | Disallow alias methods                                              | ![style][]       | ![fixable][] |
+| [no-alias-methods](docs/rules/no-alias-methods.md)                           | Disallow alias methods                                              | ![recommended][] | ![fixable][] |
 | [no-commented-out-tests](docs/rules/no-commented-out-tests.md)               | Disallow commented out tests                                        | ![recommended][] |              |
 | [no-conditional-expect](docs/rules/no-conditional-expect.md)                 | Prevent calling `expect` conditionally                              | ![recommended][] |              |
 | [no-conditional-in-test](docs/rules/no-conditional-in-test.md)               | Disallow conditional logic in tests                                 |                  |              |
@@ -217,7 +217,6 @@ installations requiring long-term consistency.
 | [no-identical-title](docs/rules/no-identical-title.md)                       | Disallow identical titles                                           | ![recommended][] |              |
 | [no-interpolation-in-snapshots](docs/rules/no-interpolation-in-snapshots.md) | Disallow string interpolation inside snapshots                      | ![recommended][] |              |
 | [no-jasmine-globals](docs/rules/no-jasmine-globals.md)                       | Disallow Jasmine globals                                            | ![recommended][] | ![fixable][] |
-| [no-jest-import](docs/rules/no-jest-import.md)                               | Disallow importing Jest                                             | ![recommended][] |              |
 | [no-large-snapshots](docs/rules/no-large-snapshots.md)                       | disallow large snapshots                                            |                  |              |
 | [no-mocks-import](docs/rules/no-mocks-import.md)                             | Disallow manually importing from `__mocks__`                        | ![recommended][] |              |
 | [no-restricted-matchers](docs/rules/no-restricted-matchers.md)               | Disallow specific matchers & modifiers                              |                  |              |

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

@@ -1,5 +1,8 @@
 # Disallow alias methods (`no-alias-methods`)
 
+> These aliases are going to be removed in the next major version of Jest - see
+> https://github.com/facebook/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
 Jest documentation is used in the code. This makes it easier to search for all

package/docs/rules/no-restricted-matchers.md

@@ -8,8 +8,9 @@ alternatives.
 Bans are expressed in the form of a map, with the value being either a string
 message to be shown, or `null` if the default rule message should be used.
 
-Both matchers, modifiers, and chains of the two are checked, allowing for
-specific variations of a matcher to be banned if desired.
+Bans are checked against the start of the `expect` chain - this means that to
+ban a specific matcher entirely you must specify all six permutations, but
+allows you to ban modifiers as well.
 
 By default, this map is empty, meaning no matchers or modifiers are banned.
 
@@ -22,7 +23,12 @@ For example:
     {
       "toBeFalsy": null,
       "resolves": "Use `expect(await promise)` instead.",
-      "not.toHaveBeenCalledWith": null
+      "toHaveBeenCalledWith": null,
+      "not.toHaveBeenCalledWith": null,
+      "resolves.toHaveBeenCalledWith": null,
+      "rejects.toHaveBeenCalledWith": null,
+      "resolves.not.toHaveBeenCalledWith": null,
+      "rejects.not.toHaveBeenCalledWith": null
     }
   ]
 }
@@ -32,15 +38,18 @@ Examples of **incorrect** code for this rule with the above configuration
 
 ```js
 it('is false', () => {
+  // if this has a modifer (i.e. `not.toBeFalsy`), it would be considered fine
   expect(a).toBeFalsy();
 });
 
 it('resolves', async () => {
+  // all uses of this modifier are disallowed, regardless of matcher
   await expect(myPromise()).resolves.toBe(true);
 });
 
 describe('when an error happens', () => {
   it('does not upload the file', async () => {
+    // all uses of this matcher are disallowed
     expect(uploadFileMock).not.toHaveBeenCalledWith('file.name');
   });
 });

package/lib/rules/expect-expect.js

@@ -89,9 +89,7 @@ var _default = (0, _utils2.createRule)({
 
     return {
       CallExpression(node) {
-        var _getNodeName;
-
-        const name = (_getNodeName = (0, _utils2.getNodeName)(node.callee)) !== null && _getNodeName !== void 0 ? _getNodeName : '';
+        const name = (0, _utils2.getNodeName)(node.callee) ?? '';
 
         if ((0, _utils2.isTypeOfJestFnCall)(node, context, ['test']) || additionalTestBlockFunctions.includes(name)) {
           if (node.callee.type === _utils.AST_NODE_TYPES.MemberExpression && (0, _utils2.isSupportedAccessor)(node.callee.property, 'todo')) {

package/lib/rules/no-alias-methods.js

@@ -13,7 +13,7 @@ var _default = (0, _utils.createRule)({
     docs: {
       category: 'Best Practices',
       description: 'Disallow alias methods',
-      recommended: false
+      recommended: 'error'
     },
     messages: {
       replaceAlias: `Replace {{ alias }}() with its canonical name of {{ canonical }}()`

package/lib/rules/no-conditional-expect.js

@@ -47,11 +47,9 @@ var _default = (0, _utils2.createRule)({
       },
 
       CallExpression(node) {
-        var _parseJestFnCall;
-
         const {
           type: jestFnCallType
-        } = (_parseJestFnCall = (0, _utils2.parseJestFnCall)(node, context)) !== null && _parseJestFnCall !== void 0 ? _parseJestFnCall : {};
+        } = (0, _utils2.parseJestFnCall)(node, context) ?? {};
 
         if (jestFnCallType === 'test') {
           inTestCase = true;

package/lib/rules/no-done-callback.js

@@ -50,10 +50,10 @@ var _default = (0, _utils2.createRule)({
   create(context) {
     return {
       CallExpression(node) {
-        var _getNodeName$endsWith, _getNodeName;
+        var _getNodeName;
 
         // done is the second argument for it.each, not the first
-        const isJestEach = (_getNodeName$endsWith = (_getNodeName = (0, _utils2.getNodeName)(node.callee)) === null || _getNodeName === void 0 ? void 0 : _getNodeName.endsWith('.each')) !== null && _getNodeName$endsWith !== void 0 ? _getNodeName$endsWith : false;
+        const isJestEach = ((_getNodeName = (0, _utils2.getNodeName)(node.callee)) === null || _getNodeName === void 0 ? void 0 : _getNodeName.endsWith('.each')) ?? false;
 
         if (isJestEach && node.callee.type !== _utils.AST_NODE_TYPES.TaggedTemplateExpression) {
           // isJestEach but not a TaggedTemplateExpression, so this must be

package/lib/rules/no-large-snapshots.js

@@ -107,10 +107,8 @@ var _default = (0, _utils2.createRule)({
         }
 
         if (['toMatchInlineSnapshot', 'toThrowErrorMatchingInlineSnapshot'].includes((0, _utils2.getAccessorValue)(jestFnCall.matcher)) && jestFnCall.args.length) {
-          var _options$inlineMaxSiz;
-
           reportOnViolation(context, jestFnCall.args[0], { ...options,
-            maxSize: (_options$inlineMaxSiz = options.inlineMaxSize) !== null && _options$inlineMaxSiz !== void 0 ? _options$inlineMaxSiz : options.maxSize
+            maxSize: options.inlineMaxSize ?? options.maxSize
           });
         }
       }

package/lib/rules/no-restricted-matchers.js

@@ -23,7 +23,7 @@ var _default = (0, _utils.createRule)({
       }
     }],
     messages: {
-      restrictedChain: 'Use of `{{ chain }}` is disallowed',
+      restrictedChain: 'Use of `{{ restriction }}` is disallowed',
       restrictedChainWithMessage: '{{ message }}'
     }
   },
@@ -38,31 +38,19 @@ var _default = (0, _utils.createRule)({
           return;
         }
 
-        const permutations = [jestFnCall.members];
+        const chain = jestFnCall.members.map(nod => (0, _utils.getAccessorValue)(nod)).join('.');
 
-        if (jestFnCall.members.length > 2) {
-          permutations.push([jestFnCall.members[0], jestFnCall.members[1]]);
-          permutations.push([jestFnCall.members[1], jestFnCall.members[2]]);
-        }
-
-        if (jestFnCall.members.length > 1) {
-          permutations.push(...jestFnCall.members.map(nod => [nod]));
-        }
-
-        for (const permutation of permutations) {
-          const chain = permutation.map(nod => (0, _utils.getAccessorValue)(nod)).join('.');
-
-          if (chain in restrictedChains) {
-            const message = restrictedChains[chain];
+        for (const [restriction, message] of Object.entries(restrictedChains)) {
+          if (chain.startsWith(restriction)) {
             context.report({
               messageId: message ? 'restrictedChainWithMessage' : 'restrictedChain',
               data: {
                 message,
-                chain
+                restriction
               },
               loc: {
-                start: permutation[0].loc.start,
-                end: permutation[permutation.length - 1].loc.end
+                start: jestFnCall.members[0].loc.start,
+                end: jestFnCall.members[jestFnCall.members.length - 1].loc.end
               }
             });
             break;

package/lib/rules/prefer-each.js

@@ -67,11 +67,9 @@ var _default = (0, _utils.createRule)({
       'ForOfStatement:exit': exitForLoop,
 
       CallExpression(node) {
-        var _parseJestFnCall;
-
         const {
           type: jestFnCallType
-        } = (_parseJestFnCall = (0, _utils.parseJestFnCall)(node, context)) !== null && _parseJestFnCall !== void 0 ? _parseJestFnCall : {};
+        } = (0, _utils.parseJestFnCall)(node, context) ?? {};
 
         if (jestFnCallType === 'hook' || jestFnCallType === 'describe' || jestFnCallType === 'test') {
           jestFnCalls.push(jestFnCallType);
@@ -83,11 +81,9 @@ var _default = (0, _utils.createRule)({
       },
 
       'CallExpression:exit'(node) {
-        var _parseJestFnCall2;
-
         const {
           type: jestFnCallType
-        } = (_parseJestFnCall2 = (0, _utils.parseJestFnCall)(node, context)) !== null && _parseJestFnCall2 !== void 0 ? _parseJestFnCall2 : {};
+        } = (0, _utils.parseJestFnCall)(node, context) ?? {};
 
         if (jestFnCallType === 'test') {
           inTestCaseCall = false;

package/lib/rules/prefer-snapshot-hint.js

@@ -104,10 +104,8 @@ var _default = (0, _utils.createRule)({
 
       'CallExpression:exit'(node) {
         if ((0, _utils.isTypeOfJestFnCall)(node, context, ['describe', 'test'])) {
-          var _depths$pop;
-
           /* istanbul ignore next */
-          expressionDepth = (_depths$pop = depths.pop()) !== null && _depths$pop !== void 0 ? _depths$pop : 0;
+          expressionDepth = depths.pop() ?? 0;
         }
       },
 

package/lib/rules/require-hook.js

@@ -77,11 +77,9 @@ var _default = (0, _utils2.createRule)({
   }],
 
   create(context) {
-    var _context$options$;
-
     const {
       allowedFunctionCalls
-    } = (_context$options$ = context.options[0]) !== null && _context$options$ !== void 0 ? _context$options$ : {};
+    } = context.options[0] ?? {};
 
     const checkBlockBody = body => {
       for (const statement of body) {

package/lib/rules/require-top-level-describe.js

@@ -37,11 +37,9 @@ var _default = (0, _utils.createRule)({
   defaultOptions: [{}],
 
   create(context) {
-    var _context$options$;
-
     const {
       maxNumberOfTopLevelDescribes = Infinity
-    } = (_context$options$ = context.options[0]) !== null && _context$options$ !== void 0 ? _context$options$ : {};
+    } = context.options[0] ?? {};
     let numberOfTopLevelDescribeBlocks = 0;
     let numberOfDescribeBlocks = 0;
     return {

package/lib/rules/unbound-method.js

@@ -28,14 +28,6 @@ const baseRule = (() => {
   }
 })();
 
-const tryCreateBaseRule = context => {
-  try {
-    return baseRule === null || baseRule === void 0 ? void 0 : baseRule.create(context);
-  } catch {
-    return null;
-  }
-};
-
 const DEFAULT_MESSAGE = 'This rule requires `@typescript-eslint/eslint-plugin`';
 
 var _default = (0, _utils2.createRule)({
@@ -62,7 +54,7 @@ var _default = (0, _utils2.createRule)({
   },
 
   create(context) {
-    const baseSelectors = tryCreateBaseRule(context);
+    const baseSelectors = baseRule === null || baseRule === void 0 ? void 0 : baseRule.create(context);
 
     if (!baseSelectors) {
       return {};

package/lib/rules/utils/parseJestFnCall.js

@@ -69,9 +69,9 @@ const determineJestFnType = name => {
 const ValidJestFnCallChains = ['afterAll', 'afterEach', 'beforeAll', 'beforeEach', 'describe', 'describe.each', 'describe.only', 'describe.only.each', 'describe.skip', 'describe.skip.each', 'fdescribe', 'fdescribe.each', 'xdescribe', 'xdescribe.each', 'it', 'it.concurrent', 'it.concurrent.each', 'it.concurrent.only.each', 'it.concurrent.skip.each', 'it.each', 'it.failing', 'it.only', 'it.only.each', 'it.only.failing', 'it.skip', 'it.skip.each', 'it.skip.failing', 'it.todo', 'fit', 'fit.each', 'fit.failing', 'xit', 'xit.each', 'xit.failing', 'test', 'test.concurrent', 'test.concurrent.each', 'test.concurrent.only.each', 'test.concurrent.skip.each', 'test.each', 'test.failing', 'test.only', 'test.only.each', 'test.only.failing', 'test.skip', 'test.skip.each', 'test.skip.failing', 'test.todo', 'xtest', 'xtest.each', 'xtest.failing'];
 
 const resolvePossibleAliasedGlobal = (global, context) => {
-  var _context$settings$jes, _context$settings$jes2;
+  var _context$settings$jes;
 
-  const globalAliases = (_context$settings$jes = (_context$settings$jes2 = context.settings.jest) === null || _context$settings$jes2 === void 0 ? void 0 : _context$settings$jes2.globalAliases) !== null && _context$settings$jes !== void 0 ? _context$settings$jes : {};
+  const globalAliases = ((_context$settings$jes = context.settings.jest) === null || _context$settings$jes === void 0 ? void 0 : _context$settings$jes.globalAliases) ?? {};
   const alias = Object.entries(globalAliases).find(([, aliases]) => aliases.includes(global));
 
   if (alias) {
@@ -110,7 +110,7 @@ const parseJestFnCallWithReason = (node, context) => {
 exports.parseJestFnCallWithReason = parseJestFnCallWithReason;
 
 const parseJestFnCallWithReasonInner = (node, context) => {
-  var _resolved$original, _node$parent2, _node$parent3;
+  var _node$parent2, _node$parent3;
 
   const chain = getNodeChain(node);
 
@@ -137,7 +137,7 @@ const parseJestFnCallWithReasonInner = (node, context) => {
     return null;
   }
 
-  const name = (_resolved$original = resolved.original) !== null && _resolved$original !== void 0 ? _resolved$original : resolved.local;
+  const name = resolved.original ?? resolved.local;
   const links = [name, ...rest.map(link => (0, _utils2.getAccessorValue)(link))];
 
   if (name !== 'jest' && name !== 'expect' && !ValidJestFnCallChains.includes(links.join('.'))) {
@@ -293,9 +293,7 @@ const findImportSourceNode = node => {
   }
 
   if (node.type === _utils.AST_NODE_TYPES.CallExpression && (0, _utils2.isIdentifier)(node.callee, 'require')) {
-    var _node$arguments$;
-
-    return (_node$arguments$ = node.arguments[0]) !== null && _node$arguments$ !== void 0 ? _node$arguments$ : null;
+    return node.arguments[0] ?? null;
   }
 
   return null;

package/lib/rules/valid-title.js

@@ -124,12 +124,10 @@ var _default = (0, _utils2.createRule)({
     mustMatch
   }]) {
     const disallowedWordsRegexp = new RegExp(`\\b(${disallowedWords.join('|')})\\b`, 'iu');
-    const mustNotMatchPatterns = compileMatcherPatterns(mustNotMatch !== null && mustNotMatch !== void 0 ? mustNotMatch : {});
-    const mustMatchPatterns = compileMatcherPatterns(mustMatch !== null && mustMatch !== void 0 ? mustMatch : {});
+    const mustNotMatchPatterns = compileMatcherPatterns(mustNotMatch ?? {});
+    const mustMatchPatterns = compileMatcherPatterns(mustMatch ?? {});
     return {
       CallExpression(node) {
-        var _mustNotMatchPatterns, _mustMatchPatterns$je;
-
         const jestFnCall = (0, _utils2.parseJestFnCall)(node, context);
 
         if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) !== 'describe' && (jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) !== 'test') {
@@ -205,7 +203,7 @@ var _default = (0, _utils2.createRule)({
         }
 
         const jestFunctionName = unprefixedName;
-        const [mustNotMatchPattern, mustNotMatchMessage] = (_mustNotMatchPatterns = mustNotMatchPatterns[jestFunctionName]) !== null && _mustNotMatchPatterns !== void 0 ? _mustNotMatchPatterns : [];
+        const [mustNotMatchPattern, mustNotMatchMessage] = mustNotMatchPatterns[jestFunctionName] ?? [];
 
         if (mustNotMatchPattern) {
           if (mustNotMatchPattern.test(title)) {
@@ -222,7 +220,7 @@ var _default = (0, _utils2.createRule)({
           }
         }
 
-        const [mustMatchPattern, mustMatchMessage] = (_mustMatchPatterns$je = mustMatchPatterns[jestFunctionName]) !== null && _mustMatchPatterns$je !== void 0 ? _mustMatchPatterns$je : [];
+        const [mustMatchPattern, mustMatchMessage] = mustMatchPatterns[jestFunctionName] ?? [];
 
         if (mustMatchPattern) {
           if (!mustMatchPattern.test(title)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-jest",
-  "version": "26.9.0",
+  "version": "27.0.0",
   "description": "ESLint rules for Jest",
   "keywords": [
     "eslint",
@@ -103,34 +103,34 @@
     "@babel/core": "^7.4.4",
     "@babel/preset-env": "^7.4.4",
     "@babel/preset-typescript": "^7.3.3",
-    "@commitlint/cli": "^16.0.0",
-    "@commitlint/config-conventional": "^16.0.0",
+    "@commitlint/cli": "^17.0.3",
+    "@commitlint/config-conventional": "^17.0.3",
     "@schemastore/package": "^0.0.6",
     "@semantic-release/changelog": "^6.0.0",
     "@semantic-release/git": "^10.0.0",
     "@types/dedent": "^0.7.0",
     "@types/jest": "^28.0.0",
-    "@types/node": "^16.0.0",
+    "@types/node": "^14.18.26",
     "@types/prettier": "^2.0.0",
     "@typescript-eslint/eslint-plugin": "^5.0.0",
     "@typescript-eslint/parser": "^5.0.0",
-    "babel-jest": "^28.0.0",
+    "babel-jest": "^29.0.0",
     "babel-plugin-replace-ts-export-assignment": "^0.0.2",
     "dedent": "^0.7.0",
     "eslint": "^6.0.0 || ^7.0.0 || ^8.0.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-eslint-comments": "^3.1.2",
-    "eslint-plugin-eslint-plugin": "^4.0.0",
+    "eslint-plugin-eslint-plugin": "^5.0.6",
     "eslint-plugin-import": "^2.25.1",
     "eslint-plugin-node": "^11.0.0",
-    "eslint-plugin-prettier": "^3.4.1",
+    "eslint-plugin-prettier": "^4.2.1",
     "eslint-remote-tester": "^3.0.0",
     "eslint-remote-tester-repositories": "~0.0.5",
-    "husky": "^7.0.2",
+    "husky": "^8.0.1",
     "is-ci": "^3.0.0",
-    "jest": "^28.0.0",
-    "jest-runner-eslint": "^1.0.0",
-    "lint-staged": "^12.0.0",
+    "jest": "^29.0.0",
+    "jest-runner-eslint": "^1.1.0",
+    "lint-staged": "^13.0.3",
     "pinst": "^3.0.0",
     "prettier": "^2.0.5",
     "rimraf": "^3.0.0",
@@ -141,7 +141,7 @@
   },
   "peerDependencies": {
     "@typescript-eslint/eslint-plugin": "^5.0.0",
-    "eslint": "^6.0.0 || ^7.0.0 || ^8.0.0"
+    "eslint": "^7.0.0 || ^8.0.0"
   },
   "peerDependenciesMeta": {
     "@typescript-eslint/eslint-plugin": {
@@ -153,6 +153,6 @@
   },
   "packageManager": "yarn@3.2.3",
   "engines": {
-    "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
+    "node": "^14.15.0 || ^16.10.0 || >=18.0.0"
   }
 }

package/docs/rules/no-jest-import.md

@@ -1,20 +0,0 @@
-# Disallow importing Jest (`no-jest-import`)
-
-The `jest` object is automatically in scope within every test file. The methods
-in the `jest` object help create mocks and let you control Jest's overall
-behavior. It is therefore completely unnecessary to import in `jest`, as Jest
-doesn't export anything in the first place.
-
-### Rule details
-
-This rule reports on any importing of Jest.
-
-To name a few: `var jest = require('jest');` `const jest = require('jest');`
-`import jest from 'jest';` `import {jest as test} from 'jest';`
-
-There is no correct usage of this code, other than to not import `jest` in the
-first place.
-
-## Further Reading
-
-- [The Jest Object](https://facebook.github.io/jest/docs/en/jest-object.html)

package/lib/rules/no-jest-import.js

@@ -1,48 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _utils = require("./utils");
-
-var _default = (0, _utils.createRule)({
-  name: __filename,
-  meta: {
-    type: 'problem',
-    docs: {
-      description: 'Disallow importing Jest',
-      category: 'Best Practices',
-      recommended: 'error'
-    },
-    messages: {
-      unexpectedImport: `Jest is automatically in scope. Do not import "jest", as Jest doesn't export anything.`
-    },
-    schema: []
-  },
-  defaultOptions: [],
-
-  create(context) {
-    return {
-      'ImportDeclaration[source.value="jest"]'(node) {
-        context.report({
-          node,
-          messageId: 'unexpectedImport'
-        });
-      },
-
-      'CallExpression[callee.name="require"][arguments.0.value="jest"]'(node) {
-        context.report({
-          loc: node.arguments[0].loc,
-          messageId: 'unexpectedImport',
-          node
-        });
-      }
-
-    };
-  }
-
-});
-
-exports.default = _default;