eslint-plugin-jest 25.0.0-next.6 → 25.0.2

package/CHANGELOG.md

@@ -1,3 +1,67 @@
+## [25.0.2](https://github.com/jest-community/eslint-plugin-jest/compare/v25.0.1...v25.0.2) (2021-10-11)
+
+
+### Bug Fixes
+
+* **valid-expect-in-promise:** support out of order awaits ([#939](https://github.com/jest-community/eslint-plugin-jest/issues/939)) ([07d2137](https://github.com/jest-community/eslint-plugin-jest/commit/07d213719de974d6b5a1cab75e836dc39b432f87))
+
+## [25.0.1](https://github.com/jest-community/eslint-plugin-jest/compare/v25.0.0...v25.0.1) (2021-10-10)
+
+
+### Bug Fixes
+
+* specify peer dependency ranges correctly ([cb87458](https://github.com/jest-community/eslint-plugin-jest/commit/cb87458d5f7dc7f669ab0c4067d75fc06ee29553))
+
+# [25.0.0](https://github.com/jest-community/eslint-plugin-jest/compare/v24.7.0...v25.0.0) (2021-10-10)
+
+
+### Bug Fixes
+
+* stop testing ESLint 5 ([#893](https://github.com/jest-community/eslint-plugin-jest/issues/893)) ([47a0138](https://github.com/jest-community/eslint-plugin-jest/commit/47a0138856e6247cde00b17682e49865b8f5a1f6))
+* stop testing on Node 10 and 15 ([#891](https://github.com/jest-community/eslint-plugin-jest/issues/891)) ([bcd8d11](https://github.com/jest-community/eslint-plugin-jest/commit/bcd8d112fcd98a7652c767bd246d05101979239c))
+
+
+### Features
+
+* add `prefer-to-be` to style ruleset ([2a3376f](https://github.com/jest-community/eslint-plugin-jest/commit/2a3376fc9f5fe60d03d9aad0c4e5c7c423487e60))
+* **lowercase-name:** rename to `prefer-lowercase-title` ([b860084](https://github.com/jest-community/eslint-plugin-jest/commit/b8600841e371d5d9f36be4e50e53252fd8f62734))
+* **prefer-to-be-null:** remove rule ([809bcda](https://github.com/jest-community/eslint-plugin-jest/commit/809bcda12c555a24c764d152bcac9814ea55e72f))
+* **prefer-to-be-undefined:** remove rule ([3434d9b](https://github.com/jest-community/eslint-plugin-jest/commit/3434d9bd22b92bace6e0a50e2c72b401ac17704d))
+* remove deprecated rules ([#661](https://github.com/jest-community/eslint-plugin-jest/issues/661)) ([e8f16ec](https://github.com/jest-community/eslint-plugin-jest/commit/e8f16ec0e204a94a0e549cb9b415b3c6c8981aee))
+* **valid-describe:** rename to `valid-describe-callback` ([f3e9e9a](https://github.com/jest-community/eslint-plugin-jest/commit/f3e9e9a64e183a0fb8af3436611a7f70366a528d))
+
+
+### BREAKING CHANGES
+
+* **valid-describe:** renamed `valid-describe` to `valid-describe-callback`
+* **lowercase-name:** renamed `lowercase-name` to `prefer-lowercase-title`
+* **prefer-to-be-undefined:** removed `prefer-to-be-undefined` rule
+* **prefer-to-be-null:** removed `prefer-to-be-null` rule
+* recommend `prefer-to-be` rule
+* Removes rules `no-expect-resolves`, `no-truthy-falsy`, `no-try-expect`, and `prefer-inline-snapshots`
+* Drop support for ESLint 5
+* Drop support for Node 10 and 15
+
+# [25.0.0-next.7](https://github.com/jest-community/eslint-plugin-jest/compare/v25.0.0-next.6...v25.0.0-next.7) (2021-10-10)
+
+
+### Features
+
+* add `prefer-to-be` to style ruleset ([2a3376f](https://github.com/jest-community/eslint-plugin-jest/commit/2a3376fc9f5fe60d03d9aad0c4e5c7c423487e60))
+* **lowercase-name:** rename to `prefer-lowercase-title` ([b860084](https://github.com/jest-community/eslint-plugin-jest/commit/b8600841e371d5d9f36be4e50e53252fd8f62734))
+* **prefer-to-be-null:** remove rule ([809bcda](https://github.com/jest-community/eslint-plugin-jest/commit/809bcda12c555a24c764d152bcac9814ea55e72f))
+* **prefer-to-be-undefined:** remove rule ([3434d9b](https://github.com/jest-community/eslint-plugin-jest/commit/3434d9bd22b92bace6e0a50e2c72b401ac17704d))
+* **valid-describe:** rename to `valid-describe-callback` ([f3e9e9a](https://github.com/jest-community/eslint-plugin-jest/commit/f3e9e9a64e183a0fb8af3436611a7f70366a528d))
+
+
+### BREAKING CHANGES
+
+* **valid-describe:** renamed `valid-describe` to `valid-describe-callback`
+* **lowercase-name:** renamed `lowercase-name` to `prefer-lowercase-title`
+* **prefer-to-be-undefined:** removed `prefer-to-be-undefined` rule
+* **prefer-to-be-null:** removed `prefer-to-be-null` rule
+* recommend `prefer-to-be` rule
+
 # [25.0.0-next.6](https://github.com/jest-community/eslint-plugin-jest/compare/v25.0.0-next.5...v25.0.0-next.6) (2021-10-10)
 
 

package/README.md

@@ -154,7 +154,6 @@ 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][] |              |
@@ -181,16 +180,17 @@ installations requiring long-term consistency.
 | [prefer-expect-assertions](docs/rules/prefer-expect-assertions.md)           | Suggest using `expect.assertions()` OR `expect.hasAssertions()`     |                  | ![suggest][] |
 | [prefer-expect-resolves](docs/rules/prefer-expect-resolves.md)               | Prefer `await expect(...).resolves` over `expect(await ...)` syntax |                  | ![fixable][] |
 | [prefer-hooks-on-top](docs/rules/prefer-hooks-on-top.md)                     | Suggest having hooks before any test cases                          |                  |              |
+| [prefer-lowercase-title](docs/rules/prefer-lowercase-title.md)               | Enforce lowercase test names                                        |                  | ![fixable][] |
 | [prefer-spy-on](docs/rules/prefer-spy-on.md)                                 | Suggest using `jest.spyOn()`                                        |                  | ![fixable][] |
 | [prefer-strict-equal](docs/rules/prefer-strict-equal.md)                     | Suggest using `toStrictEqual()`                                     |                  | ![suggest][] |
-| [prefer-to-be](docs/rules/prefer-to-be.md)                                   | Suggest using `toBe()` for primitive literals                       |                  | ![fixable][] |
+| [prefer-to-be](docs/rules/prefer-to-be.md)                                   | Suggest using `toBe()` for primitive literals                       | ![style][]       | ![fixable][] |
 | [prefer-to-contain](docs/rules/prefer-to-contain.md)                         | Suggest using `toContain()`                                         | ![style][]       | ![fixable][] |
 | [prefer-to-have-length](docs/rules/prefer-to-have-length.md)                 | Suggest using `toHaveLength()`                                      | ![style][]       | ![fixable][] |
 | [prefer-todo](docs/rules/prefer-todo.md)                                     | Suggest using `test.todo`                                           |                  | ![fixable][] |
 | [require-hook](docs/rules/require-hook.md)                                   | Require setup and teardown code to be within a hook                 |                  |              |
 | [require-to-throw-message](docs/rules/require-to-throw-message.md)           | Require a message for `toThrow()`                                   |                  |              |
 | [require-top-level-describe](docs/rules/require-top-level-describe.md)       | Require test cases and hooks to be inside a `describe` block        |                  |              |
-| [valid-describe](docs/rules/valid-describe.md)                               | Enforce valid `describe()` callback                                 | ![recommended][] |              |
+| [valid-describe-callback](docs/rules/valid-describe-callback.md)             | Enforce valid `describe()` callback                                 | ![recommended][] |              |
 | [valid-expect](docs/rules/valid-expect.md)                                   | Enforce valid `expect()` usage                                      | ![recommended][] |              |
 | [valid-expect-in-promise](docs/rules/valid-expect-in-promise.md)             | Ensure promises that have expectations in their chain are valid     | ![recommended][] |              |
 | [valid-title](docs/rules/valid-title.md)                                     | Enforce valid titles                                                | ![recommended][] | ![fixable][] |

package/docs/rules/{lowercase-name.md → prefer-lowercase-title.md}

@@ -1,4 +1,4 @@
-# Enforce lowercase test names (`lowercase-name`)
+# Enforce lowercase test names (`prefer-lowercase-title`)
 
 ## Rule details
 

package/docs/rules/{valid-describe.md → valid-describe-callback.md}

@@ -1,4 +1,4 @@
-# Enforce valid `describe()` callback (`valid-describe`)
+# Enforce valid `describe()` callback (`valid-describe-callback`)
 
 Using an improper `describe()` callback function can lead to unexpected test
 errors.

package/lib/index.js

@@ -52,8 +52,7 @@ module.exports = {
       plugins: ['jest'],
       rules: {
         'jest/no-alias-methods': 'warn',
-        'jest/prefer-to-be-null': 'error',
-        'jest/prefer-to-be-undefined': 'error',
+        'jest/prefer-to-be': 'error',
         'jest/prefer-to-contain': 'error',
         'jest/prefer-to-have-length': 'error'
       }

package/lib/processors/snapshot-processor.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.postprocess = exports.preprocess = void 0;
+exports.preprocess = exports.postprocess = void 0;
 
 // https://eslint.org/docs/developer-guide/working-with-plugins#processors-in-plugins
 // https://github.com/typescript-eslint/typescript-eslint/issues/808

package/lib/rules/utils.js

@@ -3,8 +3,9 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.getAccessorValue = exports.followTypeAssertionChain = exports.createRule = exports.TestCaseProperty = exports.TestCaseName = exports.ModifierName = exports.HookName = exports.EqualityMatcher = exports.DescribeProperty = exports.DescribeAlias = void 0;
 exports.getNodeName = getNodeName;
-exports.scopeHasLocalReference = exports.isDescribeCall = exports.isTestCaseCall = exports.getTestCallExpressionsFromDeclaredVariables = exports.isHook = exports.isFunction = exports.TestCaseProperty = exports.DescribeProperty = exports.HookName = exports.TestCaseName = exports.DescribeAlias = exports.parseExpectCall = exports.isParsedEqualityMatcherCall = exports.EqualityMatcher = exports.ModifierName = exports.isExpectMember = exports.isExpectCall = exports.getAccessorValue = exports.isSupportedAccessor = exports.isIdentifier = exports.hasOnlyOneArgument = exports.getStringValue = exports.isStringNode = exports.followTypeAssertionChain = exports.createRule = void 0;
+exports.scopeHasLocalReference = exports.parseExpectCall = exports.isTestCaseCall = exports.isSupportedAccessor = exports.isStringNode = exports.isParsedEqualityMatcherCall = exports.isIdentifier = exports.isHook = exports.isFunction = exports.isExpectMember = exports.isExpectCall = exports.isDescribeCall = exports.hasOnlyOneArgument = exports.getTestCallExpressionsFromDeclaredVariables = exports.getStringValue = void 0;
 
 var _path = require("path");
 
@@ -61,7 +62,8 @@ 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 && (value === undefined || node.quasis[0].value.raw === value);
+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);
 
 /**
  * Checks if the given `node` is a {@link StringNode}.

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

@@ -101,7 +101,7 @@ const isPromiseMethodThatUsesValue = (node, identifier) => {
     }
   }
 
-  return node.argument.type === _experimentalUtils.AST_NODE_TYPES.Identifier && (0, _utils.isIdentifier)(node.argument, name);
+  return (0, _utils.isIdentifier)(node.argument, name);
 };
 /**
  * Attempts to determine if the runtime value represented by the given `identifier`
@@ -126,8 +126,8 @@ const isValueAwaitedOrReturned = (identifier, body) => {
     }
 
     if (node.type === _experimentalUtils.AST_NODE_TYPES.ExpressionStatement) {
-      if (node.expression.type === _experimentalUtils.AST_NODE_TYPES.AwaitExpression) {
-        return isPromiseMethodThatUsesValue(node.expression, identifier);
+      if (node.expression.type === _experimentalUtils.AST_NODE_TYPES.AwaitExpression && isPromiseMethodThatUsesValue(node.expression, identifier)) {
+        return true;
       } // (re)assignment changes the runtime value, so if we've not found an
       // await or return already we act as if we've reached the end of the body
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-jest",
-  "version": "25.0.0-next.6",
+  "version": "25.0.2",
   "description": "Eslint rules for Jest",
   "keywords": [
     "eslint",
@@ -123,8 +123,8 @@
     "typescript": "^4.4.0"
   },
   "peerDependencies": {
-    "@typescript-eslint/eslint-plugin": ">= 4",
-    "eslint": ">=6"
+    "@typescript-eslint/eslint-plugin": "^4.0.0",
+    "eslint": "^6.0.0 || ^7.0.0"
   },
   "peerDependenciesMeta": {
     "@typescript-eslint/eslint-plugin": {

package/docs/rules/prefer-to-be-null.md

@@ -1,37 +0,0 @@
-# Suggest using `toBeNull()` (`prefer-to-be-null`)
-
-## Deprecated
-
-This rule has been deprecated in favor of [`prefer-to-be`](prefer-to-be.md).
-
-In order to have a better failure message, `toBeNull()` should be used upon
-asserting expectations on null value.
-
-## Rule details
-
-This rule triggers a warning if `toBe()`, `toEqual()` or `toStrictEqual()` is
-used to assert a null value.
-
-```js
-expect(null).toBe(null);
-```
-
-This rule is enabled by default.
-
-### Default configuration
-
-The following patterns are considered warnings:
-
-```js
-expect(null).toBe(null);
-
-expect(null).toEqual(null);
-
-expect(null).toStrictEqual(null);
-```
-
-The following pattern is not warning:
-
-```js
-expect(null).toBeNull();
-```

package/docs/rules/prefer-to-be-undefined.md

@@ -1,37 +0,0 @@
-# Suggest using `toBeUndefined()` (`prefer-to-be-undefined`)
-
-## Deprecated
-
-This rule has been deprecated in favor of [`prefer-to-be`](prefer-to-be.md).
-
-In order to have a better failure message, `toBeUndefined()` should be used upon
-asserting expectations on undefined value.
-
-## Rule details
-
-This rule triggers a warning if `toBe()`, `toEqual()` or `toStrictEqual()` is
-used to assert an undefined value.
-
-```js
-expect(undefined).toBe(undefined);
-```
-
-This rule is enabled by default.
-
-### Default configuration
-
-The following patterns are considered warnings:
-
-```js
-expect(undefined).toBe(undefined);
-
-expect(undefined).toEqual(undefined);
-
-expect(undefined).toStrictEqual(undefined);
-```
-
-The following pattern is not warning:
-
-```js
-expect(undefined).toBeUndefined();
-```

package/lib/rules/prefer-to-be-null.js

@@ -1,69 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _experimentalUtils = require("@typescript-eslint/experimental-utils");
-
-var _utils = require("./utils");
-
-const isNullLiteral = node => node.type === _experimentalUtils.AST_NODE_TYPES.Literal && node.value === null;
-/**
- * Checks if the given `ParsedExpectMatcher` is a call to one of the equality matchers,
- * with a `null` literal as the sole argument.
- *
- * @param {ParsedExpectMatcher} matcher
- *
- * @return {matcher is ParsedEqualityMatcherCall<MaybeTypeCast<NullLiteral>>}
- */
-
-
-const isNullEqualityMatcher = matcher => (0, _utils.isParsedEqualityMatcherCall)(matcher) && isNullLiteral((0, _utils.followTypeAssertionChain)(matcher.arguments[0]));
-
-var _default = (0, _utils.createRule)({
-  name: __filename,
-  meta: {
-    docs: {
-      category: 'Best Practices',
-      description: 'Suggest using `toBeNull()`',
-      recommended: false
-    },
-    messages: {
-      useToBeNull: 'Use toBeNull() instead'
-    },
-    deprecated: true,
-    replacedBy: ['prefer-to-be'],
-    fixable: 'code',
-    type: 'suggestion',
-    schema: []
-  },
-  defaultOptions: [],
-
-  create(context) {
-    return {
-      CallExpression(node) {
-        if (!(0, _utils.isExpectCall)(node)) {
-          return;
-        }
-
-        const {
-          matcher
-        } = (0, _utils.parseExpectCall)(node);
-
-        if (matcher && isNullEqualityMatcher(matcher)) {
-          context.report({
-            fix: fixer => [fixer.replaceText(matcher.node.property, 'toBeNull'), fixer.remove(matcher.arguments[0])],
-            messageId: 'useToBeNull',
-            node: matcher.node.property
-          });
-        }
-      }
-
-    };
-  }
-
-});
-
-exports.default = _default;

package/lib/rules/prefer-to-be-undefined.js

@@ -1,69 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _experimentalUtils = require("@typescript-eslint/experimental-utils");
-
-var _utils = require("./utils");
-
-const isUndefinedIdentifier = node => node.type === _experimentalUtils.AST_NODE_TYPES.Identifier && node.name === 'undefined';
-/**
- * Checks if the given `ParsedExpectMatcher` is a call to one of the equality matchers,
- * with a `undefined` identifier as the sole argument.
- *
- * @param {ParsedExpectMatcher} matcher
- *
- * @return {matcher is ParsedEqualityMatcherCall<MaybeTypeCast<UndefinedIdentifier>>}
- */
-
-
-const isUndefinedEqualityMatcher = matcher => (0, _utils.isParsedEqualityMatcherCall)(matcher) && isUndefinedIdentifier((0, _utils.followTypeAssertionChain)(matcher.arguments[0]));
-
-var _default = (0, _utils.createRule)({
-  name: __filename,
-  meta: {
-    docs: {
-      category: 'Best Practices',
-      description: 'Suggest using `toBeUndefined()`',
-      recommended: false
-    },
-    messages: {
-      useToBeUndefined: 'Use toBeUndefined() instead'
-    },
-    deprecated: true,
-    replacedBy: ['prefer-to-be'],
-    fixable: 'code',
-    type: 'suggestion',
-    schema: []
-  },
-  defaultOptions: [],
-
-  create(context) {
-    return {
-      CallExpression(node) {
-        if (!(0, _utils.isExpectCall)(node)) {
-          return;
-        }
-
-        const {
-          matcher
-        } = (0, _utils.parseExpectCall)(node);
-
-        if (matcher && isUndefinedEqualityMatcher(matcher)) {
-          context.report({
-            fix: fixer => [fixer.replaceText(matcher.node.property, 'toBeUndefined'), fixer.remove(matcher.arguments[0])],
-            messageId: 'useToBeUndefined',
-            node: matcher.node.property
-          });
-        }
-      }
-
-    };
-  }
-
-});
-
-exports.default = _default;