eslint-plugin-jest 24.3.6 → 24.4.2

package/CHANGELOG.md

@@ -1,3 +1,31 @@
+## [24.4.2](https://github.com/jest-community/eslint-plugin-jest/compare/v24.4.1...v24.4.2) (2021-09-17)
+
+
+### Bug Fixes
+
+* use correct property `hasSuggestions` rather than `hasSuggestion` ([#899](https://github.com/jest-community/eslint-plugin-jest/issues/899)) ([dfd2368](https://github.com/jest-community/eslint-plugin-jest/commit/dfd2368d1cb1789b6a95a11be24c36868bb8a819))
+
+## [24.4.1](https://github.com/jest-community/eslint-plugin-jest/compare/v24.4.0...v24.4.1) (2021-09-17)
+
+
+### Bug Fixes
+
+* mark rules that suggest fixes with `hasSuggestion` for ESLint v8 ([#898](https://github.com/jest-community/eslint-plugin-jest/issues/898)) ([ec0a21b](https://github.com/jest-community/eslint-plugin-jest/commit/ec0a21b0d98d043a9949138e495814e0935d5e31))
+
+# [24.4.0](https://github.com/jest-community/eslint-plugin-jest/compare/v24.3.7...v24.4.0) (2021-07-21)
+
+
+### Features
+
+* create `max-nested-describe` rule ([#845](https://github.com/jest-community/eslint-plugin-jest/issues/845)) ([8067405](https://github.com/jest-community/eslint-plugin-jest/commit/8067405deb609cc1800bce596e929c1840d290ab))
+
+## [24.3.7](https://github.com/jest-community/eslint-plugin-jest/compare/v24.3.6...v24.3.7) (2021-07-21)
+
+
+### Bug Fixes
+
+* **valid-describe:** report on concise-body arrow functions ([#863](https://github.com/jest-community/eslint-plugin-jest/issues/863)) ([71c5299](https://github.com/jest-community/eslint-plugin-jest/commit/71c5299b14cac6d85ba8f8bd939461503a60468f))
+
 ## [24.3.6](https://github.com/jest-community/eslint-plugin-jest/compare/v24.3.5...v24.3.6) (2021-04-26)
 
 

package/README.md

@@ -13,8 +13,8 @@
 
 ## Installation
 
-```
-$ yarn add --dev eslint eslint-plugin-jest
+```bash
+yarn add --dev eslint eslint-plugin-jest
 ```
 
 **Note:** If you installed ESLint globally then you must also install
@@ -135,6 +135,7 @@ installations requiring long-term consistency.
 | [consistent-test-it](docs/rules/consistent-test-it.md)                       | Have control over `test` and `it` usages                        |                  | ![fixable][] |
 | [expect-expect](docs/rules/expect-expect.md)                                 | Enforce assertion to be made in a test body                     | ![recommended][] |              |
 | [lowercase-name](docs/rules/lowercase-name.md)                               | Enforce lowercase test names                                    |                  | ![fixable][] |
+| [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-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][] |              |

package/docs/rules/max-nested-describe.md

@@ -0,0 +1,131 @@
+# Enforces a maximum depth to nested describe calls (`max-nested-describe`)
+
+While it's useful to be able to group your tests together within the same file
+using `describe()`, having too many levels of nesting throughout your tests make
+them difficult to read.
+
+## Rule Details
+
+This rule enforces a maximum depth to nested `describe()` calls to improve code
+clarity in your tests.
+
+The following patterns are considered warnings (with the default option of
+`{ "max": 5 } `):
+
+```js
+describe('foo', () => {
+  describe('bar', () => {
+    describe('baz', () => {
+      describe('qux', () => {
+        describe('quxx', () => {
+          describe('too many', () => {
+            it('should get something', () => {
+              expect(getSomething()).toBe('Something');
+            });
+          });
+        });
+      });
+    });
+  });
+});
+
+describe('foo', function () {
+  describe('bar', function () {
+    describe('baz', function () {
+      describe('qux', function () {
+        describe('quxx', function () {
+          describe('too many', function () {
+            it('should get something', () => {
+              expect(getSomething()).toBe('Something');
+            });
+          });
+        });
+      });
+    });
+  });
+});
+```
+
+The following patterns are **not** considered warnings (with the default option
+of `{ "max": 5 } `):
+
+```js
+describe('foo', () => {
+  describe('bar', () => {
+    it('should get something', () => {
+      expect(getSomething()).toBe('Something');
+    });
+  });
+
+  describe('qux', () => {
+    it('should get something', () => {
+      expect(getSomething()).toBe('Something');
+    });
+  });
+});
+
+describe('foo2', function () {
+  it('should get something', () => {
+    expect(getSomething()).toBe('Something');
+  });
+});
+
+describe('foo', function () {
+  describe('bar', function () {
+    describe('baz', function () {
+      describe('qux', function () {
+        describe('this is the limit', function () {
+          it('should get something', () => {
+            expect(getSomething()).toBe('Something');
+          });
+        });
+      });
+    });
+  });
+});
+```
+
+## Options
+
+```json
+{
+  "jest/max-nested-describe": [
+    "error",
+    {
+      "max": 5
+    }
+  ]
+}
+```
+
+### `max`
+
+Enforces a maximum depth for nested `describe()`.
+
+This has a default value of `5`.
+
+Examples of patterns **not** considered warnings with options set to
+`{ "max": 2 }`:
+
+```js
+describe('foo', () => {
+  describe('bar', () => {
+    it('should get something', () => {
+      expect(getSomething()).toBe('Something');
+    });
+  });
+});
+
+describe('foo2', function()) {
+  describe('bar2', function() {
+    it('should get something', function() {
+      expect(getSomething()).toBe('Something');
+    });
+
+    it('should get  else', function() {
+      expect(getSomething()).toBe('Something');
+    });
+  });
+});
+
+```

package/docs/rules/unbound-method.md

@@ -27,7 +27,7 @@ are not using TypeScript.
   overrides: [
     {
       files: ['test/**'],
-      extends: ['jest'],
+      plugins: ['jest'],
       rules: {
         // you should turn the original rule off *only* for test files
         '@typescript-eslint/unbound-method': 'off',

package/docs/rules/valid-describe.md

@@ -43,6 +43,12 @@ describe('myFunction', () => {
     });
   });
 });
+
+// Returning a value from a describe block is not allowed
+describe('myFunction', () =>
+  it('returns a truthy value', () => {
+    expect(myFunction()).toBeTruthy();
+  }));
 ```
 
 The following patterns are not considered warnings:

package/docs/rules/valid-title.md

@@ -204,11 +204,11 @@ specific Jest test function groups (`describe`, `test`, and `it`).
 Examples of **incorrect** code when using `mustMatch`:
 
 ```js
-// with mustMatch: '$that'
+// with mustMatch: '^that'
 describe('the correct way to do things', () => {});
 fit('this there!', () => {});
 
-// with mustMatch: { test: '$that' }
+// with mustMatch: { test: '^that' }
 describe('the tests that will be run', () => {});
 test('the stuff works', () => {});
 xtest('errors that are thrown have messages', () => {});
@@ -217,11 +217,11 @@ xtest('errors that are thrown have messages', () => {});
 Examples of **correct** code when using `mustMatch`:
 
 ```js
-// with mustMatch: '$that'
+// with mustMatch: '^that'
 describe('that thing that needs to be done', () => {});
 fit('that this there!', () => {});
 
-// with mustMatch: { test: '$that' }
+// with mustMatch: { test: '^that' }
 describe('the tests that will be run', () => {});
 test('that the stuff works', () => {});
 xtest('that errors that thrown have messages', () => {});

package/lib/index.js

@@ -8,9 +8,9 @@ var _globals = _interopRequireDefault(require("./globals.json"));
 
 var snapshotProcessor = _interopRequireWildcard(require("./processors/snapshot-processor"));
 
-function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function () { return cache; }; return cache; }
+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) { if (obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (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 _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 }; }
 

package/lib/rules/max-nested-describe.js

@@ -0,0 +1,87 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _experimentalUtils = require("@typescript-eslint/experimental-utils");
+
+var _utils = require("./utils");
+
+var _default = (0, _utils.createRule)({
+  name: __filename,
+  meta: {
+    docs: {
+      category: 'Best Practices',
+      description: 'Enforces a maximum depth to nested describe calls',
+      recommended: false
+    },
+    messages: {
+      exceededMaxDepth: 'Too many nested describe calls ({{ depth }}). Maximum allowed is {{ max }}.'
+    },
+    type: 'suggestion',
+    schema: [{
+      type: 'object',
+      properties: {
+        max: {
+          type: 'integer',
+          minimum: 0
+        }
+      },
+      additionalProperties: false
+    }]
+  },
+  defaultOptions: [{
+    max: 5
+  }],
+
+  create(context, [{
+    max
+  }]) {
+    const describeCallbackStack = [];
+
+    function pushDescribeCallback(node) {
+      const {
+        parent
+      } = node;
+
+      if ((parent === null || parent === void 0 ? void 0 : parent.type) !== _experimentalUtils.AST_NODE_TYPES.CallExpression || !(0, _utils.isDescribeCall)(parent)) {
+        return;
+      }
+
+      describeCallbackStack.push(0);
+
+      if (describeCallbackStack.length > max) {
+        context.report({
+          node: parent,
+          messageId: 'exceededMaxDepth',
+          data: {
+            depth: describeCallbackStack.length,
+            max
+          }
+        });
+      }
+    }
+
+    function popDescribeCallback(node) {
+      const {
+        parent
+      } = node;
+
+      if ((parent === null || parent === void 0 ? void 0 : parent.type) === _experimentalUtils.AST_NODE_TYPES.CallExpression && (0, _utils.isDescribeCall)(parent)) {
+        describeCallbackStack.pop();
+      }
+    }
+
+    return {
+      FunctionExpression: pushDescribeCallback,
+      'FunctionExpression:exit': popDescribeCallback,
+      ArrowFunctionExpression: pushDescribeCallback,
+      'ArrowFunctionExpression:exit': popDescribeCallback
+    };
+  }
+
+});
+
+exports.default = _default;

package/lib/rules/no-deprecated-functions.js

@@ -24,10 +24,10 @@ const detectJestVersion = () => {
   try {
     const jestPath = require.resolve('jest/package.json', {
       paths: [process.cwd()]
-    }); // eslint-disable-next-line @typescript-eslint/no-require-imports
+    });
 
-
-    const jestPackageJson = require(jestPath);
+    const jestPackageJson = // eslint-disable-next-line @typescript-eslint/no-require-imports
+    require(jestPath);
 
     if (jestPackageJson.version) {
       const [majorVersion] = jestPackageJson.version.split('.');

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

@@ -40,7 +40,8 @@ var _default = (0, _utils.createRule)({
       useAwaitInsteadOfCallback: 'Use await instead of callback in async functions'
     },
     schema: [],
-    type: 'suggestion'
+    type: 'suggestion',
+    hasSuggestions: true
   },
   defaultOptions: [],
 

package/lib/rules/no-focused-tests.js

@@ -41,7 +41,8 @@ var _default = (0, _utils.createRule)({
       suggestRemoveFocus: 'Remove focus from test.'
     },
     schema: [],
-    type: 'suggestion'
+    type: 'suggestion',
+    hasSuggestions: true
   },
   defaultOptions: [],
   create: context => ({

package/lib/rules/prefer-expect-assertions.js

@@ -39,6 +39,7 @@ var _default = (0, _utils.createRule)({
       suggestRemovingExtraArguments: 'Remove extra arguments'
     },
     type: 'suggestion',
+    hasSuggestions: true,
     schema: [{
       type: 'object',
       properties: {

package/lib/rules/prefer-strict-equal.js

@@ -21,7 +21,8 @@ var _default = (0, _utils.createRule)({
       suggestReplaceWithStrictEqual: 'Replace with `toStrictEqual()`'
     },
     type: 'suggestion',
-    schema: []
+    schema: [],
+    hasSuggestions: true
   },
   defaultOptions: [],
 

package/lib/rules/utils.js

@@ -61,8 +61,7 @@ const isStringLiteral = (node, value) => node.type === _experimentalUtils.AST_NO
  *
  * @template V
  */
-const isTemplateLiteral = (node, value) => node.type === _experimentalUtils.AST_NODE_TYPES.TemplateLiteral && node.quasis.length === 1 && ( // bail out if not simple
-value === undefined || node.quasis[0].value.raw === value);
+const isTemplateLiteral = (node, value) => node.type === _experimentalUtils.AST_NODE_TYPES.TemplateLiteral && node.quasis.length === 1 && (value === undefined || node.quasis[0].value.raw === value);
 
 /**
  * Checks if the given `node` is a {@link StringNode}.

package/lib/rules/valid-describe.js

@@ -84,6 +84,13 @@ var _default = (0, _utils.createRule)({
           });
         }
 
+        if (callback.body.type === _experimentalUtils.AST_NODE_TYPES.CallExpression) {
+          context.report({
+            messageId: 'unexpectedReturnInDescribe',
+            node: callback
+          });
+        }
+
         if (callback.body.type === _experimentalUtils.AST_NODE_TYPES.BlockStatement) {
           callback.body.body.forEach(node => {
             if (node.type === _experimentalUtils.AST_NODE_TYPES.ReturnStatement) {

package/lib/rules/valid-expect-in-promise.js

@@ -123,13 +123,12 @@ var _default = (0, _utils.createRule)({
             return;
           }
 
-          const testFunctionBody = body.body;
-          const [fulfillmentCallback, rejectionCallback] = node.arguments; // then block can have two args, fulfillment & rejection
+          const testFunctionBody = body.body; // then block can have two args, fulfillment & rejection
           // then block can have one args, fulfillment
           // catch block can have one args, rejection
           // ref: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise
 
-          verifyExpectWithReturn([fulfillmentCallback, rejectionCallback], node.callee, context, testFunctionBody);
+          verifyExpectWithReturn(node.arguments.slice(0, 2), node.callee, context, testFunctionBody);
         }
       }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-jest",
-  "version": "24.3.6",
+  "version": "24.4.2",
   "description": "Eslint rules for Jest",
   "keywords": [
     "eslint",
@@ -92,12 +92,12 @@
     "@semantic-release/changelog": "^5.0.1",
     "@semantic-release/git": "^9.0.0",
     "@types/dedent": "^0.7.0",
-    "@types/jest": "^26.0.0",
+    "@types/jest": "^27.0.0",
     "@types/node": "^14.0.0",
     "@types/prettier": "^2.0.0",
     "@typescript-eslint/eslint-plugin": "^4.0.1",
     "@typescript-eslint/parser": "^4.0.1",
-    "babel-jest": "^26.0.1",
+    "babel-jest": "^27.0.0",
     "babel-plugin-replace-ts-export-assignment": "^0.0.2",
     "dedent": "^0.7.0",
     "eslint": "^5.1.0 || ^6.0.0 || ^7.0.0",
@@ -110,7 +110,7 @@
     "eslint-plugin-prettier": "^3.0.0",
     "husky": "^6.0.0",
     "is-ci": "^3.0.0",
-    "jest": "^26.0.1",
+    "jest": "^27.0.0",
     "jest-runner-eslint": "^0.10.0",
     "lint-staged": "^10.2.2",
     "pinst": "^2.0.0",
@@ -118,8 +118,9 @@
     "resolve-from": "^5.0.0",
     "rimraf": "^3.0.0",
     "semantic-release": "^17.0.7",
+    "semver": "^7.3.5",
     "ts-node": "^9.0.0",
-    "typescript": "^4.0.0"
+    "typescript": "^4.4.0"
   },
   "peerDependencies": {
     "@typescript-eslint/eslint-plugin": ">= 4",
@@ -135,7 +136,11 @@
   },
   "release": {
     "branches": [
-      "main"
+      "main",
+      {
+        "name": "next",
+        "prerelease": true
+      }
     ],
     "plugins": [
       "@semantic-release/commit-analyzer",