eslint-plugin-jest 25.2.2 → 25.3.1

package/CHANGELOG.md

@@ -1,3 +1,31 @@
+## [25.3.1](https://github.com/jest-community/eslint-plugin-jest/compare/v25.3.0...v25.3.1) (2021-12-27)
+
+
+### Bug Fixes
+
+* **prefer-to-be:** support template literals ([#1006](https://github.com/jest-community/eslint-plugin-jest/issues/1006)) ([aa428e6](https://github.com/jest-community/eslint-plugin-jest/commit/aa428e6598d5f7b259d3cec1bc505989a0fe9885))
+
+# [25.3.0](https://github.com/jest-community/eslint-plugin-jest/compare/v25.2.4...v25.3.0) (2021-11-23)
+
+
+### Features
+
+* **require-hook:** add `allowedFunctionCalls` setting ([#983](https://github.com/jest-community/eslint-plugin-jest/issues/983)) ([9d9336a](https://github.com/jest-community/eslint-plugin-jest/commit/9d9336a7624c53c0bb3ee899b8cc336a0b3349cb))
+
+## [25.2.4](https://github.com/jest-community/eslint-plugin-jest/compare/v25.2.3...v25.2.4) (2021-11-08)
+
+
+### Bug Fixes
+
+* **prefer-to-be:** preserve `resolves` and `rejects` modifiers ([#980](https://github.com/jest-community/eslint-plugin-jest/issues/980)) ([a1296bd](https://github.com/jest-community/eslint-plugin-jest/commit/a1296bdee3a3a8ec5f64f95735ca01b91e8f4118))
+
+## [25.2.3](https://github.com/jest-community/eslint-plugin-jest/compare/v25.2.2...v25.2.3) (2021-11-04)
+
+
+### Bug Fixes
+
+* **no-deprecated-functions:** mark jest as an optional peer dependency ([#970](https://github.com/jest-community/eslint-plugin-jest/issues/970)) ([f468752](https://github.com/jest-community/eslint-plugin-jest/commit/f468752fc0aba89dd9bcce5fe676a04cb2fa6407))
+
 ## [25.2.2](https://github.com/jest-community/eslint-plugin-jest/compare/v25.2.1...v25.2.2) (2021-10-17)
 
 

package/README.md

@@ -128,7 +128,7 @@ config file:
 ```
 
 See
-[ESLint documentation](http://eslint.org/docs/user-guide/configuring#extending-configuration-files)
+[ESLint documentation](https://eslint.org/docs/user-guide/configuring/configuration-files#extending-configuration-files)
 for more information about extending configuration files.
 
 ### All

package/docs/rules/prefer-lowercase-title.md

@@ -26,7 +26,7 @@ it('adds 1 + 2 to equal 3', () => {
 
 ```json
 {
-  "jest/prefer-lowercase-name": [
+  "jest/prefer-lowercase-title": [
     "error",
     {
       "ignore": ["describe", "test"]
@@ -50,7 +50,7 @@ By default, none of these options are enabled (the equivalent of
 Example of **correct** code for the `{ "ignore": ["describe"] }` option:
 
 ```js
-/* eslint jest/prefer-lowercase-name: ["error", { "ignore": ["describe"] }] */
+/* eslint jest/prefer-lowercase-title: ["error", { "ignore": ["describe"] }] */
 
 describe('Uppercase description');
 ```
@@ -58,7 +58,7 @@ describe('Uppercase description');
 Example of **correct** code for the `{ "ignore": ["test"] }` option:
 
 ```js
-/* eslint jest/prefer-lowercase-name: ["error", { "ignore": ["test"] }] */
+/* eslint jest/prefer-lowercase-title: ["error", { "ignore": ["test"] }] */
 
 test('Uppercase description');
 ```
@@ -66,7 +66,7 @@ test('Uppercase description');
 Example of **correct** code for the `{ "ignore": ["it"] }` option:
 
 ```js
-/* eslint jest/prefer-lowercase-name: ["error", { "ignore": ["it"] }] */
+/* eslint jest/prefer-lowercase-title: ["error", { "ignore": ["it"] }] */
 
 it('Uppercase description');
 ```
@@ -82,7 +82,7 @@ By default, nothing is allowed (the equivalent of `{ "allowedPrefixes": [] }`).
 Example of **correct** code for the `{ "allowedPrefixes": ["GET"] }` option:
 
 ```js
-/* eslint jest/prefer-lowercase-name: ["error", { "allowedPrefixes": ["GET"] }] */
+/* eslint jest/prefer-lowercase-title: ["error", { "allowedPrefixes": ["GET"] }] */
 
 describe('GET /live');
 ```
@@ -95,7 +95,7 @@ title starting with an upper-case letter.
 Example of **correct** code for the `{ "ignoreTopLevelDescribe": true }` option:
 
 ```js
-/* eslint jest/prefer-lowercase-name: ["error", { "ignoreTopLevelDescribe": true }] */
+/* eslint jest/prefer-lowercase-title: ["error", { "ignoreTopLevelDescribe": true }] */
 describe('MyClass', () => {
   describe('#myMethod', () => {
     it('does things', () => {

package/docs/rules/require-hook.md

@@ -148,3 +148,40 @@ afterEach(() => {
   clearCityDatabase();
 });
 ```
+
+## Options
+
+If there are methods that you want to call outside of hooks and tests, you can
+mark them as allowed using the `allowedFunctionCalls` option.
+
+```json
+{
+  "jest/require-hook": [
+    "error",
+    {
+      "allowedFunctionCalls": ["enableAutoDestroy"]
+    }
+  ]
+}
+```
+
+Examples of **correct** code when using
+`{ "allowedFunctionCalls": ["enableAutoDestroy"] }` option:
+
+```js
+/* eslint jest/require-hook: ["error", { "allowedFunctionCalls": ["enableAutoDestroy"] }] */
+
+import { enableAutoDestroy, mount } from '@vue/test-utils';
+import { initDatabase, tearDownDatabase } from './databaseUtils';
+
+enableAutoDestroy(afterEach);
+
+beforeEach(initDatabase);
+afterEach(tearDownDatabase);
+
+describe('Foo', () => {
+  test('always returns 42', () => {
+    expect(global.getAnswer()).toBe(42);
+  });
+});
+```

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

@@ -20,9 +20,16 @@ const isNullEqualityMatcher = matcher => isNullLiteral(getFirstArgument(matcher)
 
 const isFirstArgumentIdentifier = (matcher, name) => (0, _utils.isIdentifier)(getFirstArgument(matcher), name);
 
-const isPrimitiveLiteral = matcher => {
+const shouldUseToBe = matcher => {
   const firstArg = getFirstArgument(matcher);
-  return firstArg.type === _experimentalUtils.AST_NODE_TYPES.Literal && !('regex' in firstArg);
+
+  if (firstArg.type === _experimentalUtils.AST_NODE_TYPES.Literal) {
+    // regex literals are classed as literals, but they're actually objects
+    // which means "toBe" will give different results than other matchers
+    return !('regex' in firstArg);
+  }
+
+  return firstArg.type === _experimentalUtils.AST_NODE_TYPES.TemplateLiteral;
 };
 
 const getFirstArgument = matcher => {
@@ -30,7 +37,7 @@ const getFirstArgument = matcher => {
 };
 
 const reportPreferToBe = (context, whatToBe, matcher, modifier) => {
-  const modifierNode = (modifier === null || modifier === void 0 ? void 0 : modifier.negation) || (modifier === null || modifier === void 0 ? void 0 : modifier.node);
+  const modifierNode = (modifier === null || modifier === void 0 ? void 0 : modifier.negation) || (modifier === null || modifier === void 0 ? void 0 : modifier.name) === _utils.ModifierName.not && (modifier === null || modifier === void 0 ? void 0 : modifier.node);
   context.report({
     messageId: `useToBe${whatToBe}`,
 
@@ -116,7 +123,7 @@ var _default = (0, _utils.createRule)({
           return;
         }
 
-        if (isPrimitiveLiteral(matcher) && matcher.name !== _utils.EqualityMatcher.toBe) {
+        if (shouldUseToBe(matcher) && matcher.name !== _utils.EqualityMatcher.toBe) {
           reportPreferToBe(context, '', matcher);
         }
       }

package/lib/rules/require-hook.js

@@ -23,13 +23,13 @@ const isNullOrUndefined = node => {
   return node.type === _experimentalUtils.AST_NODE_TYPES.Literal && node.value === null || (0, _utils.isIdentifier)(node, 'undefined');
 };
 
-const shouldBeInHook = node => {
+const shouldBeInHook = (node, allowedFunctionCalls = []) => {
   switch (node.type) {
     case _experimentalUtils.AST_NODE_TYPES.ExpressionStatement:
-      return shouldBeInHook(node.expression);
+      return shouldBeInHook(node.expression, allowedFunctionCalls);
 
     case _experimentalUtils.AST_NODE_TYPES.CallExpression:
-      return !isJestFnCall(node);
+      return !(isJestFnCall(node) || allowedFunctionCalls.includes((0, _utils.getNodeName)(node)));
 
     case _experimentalUtils.AST_NODE_TYPES.VariableDeclaration:
       {
@@ -59,14 +59,33 @@ var _default = (0, _utils.createRule)({
       useHook: 'This should be done within a hook'
     },
     type: 'suggestion',
-    schema: []
+    schema: [{
+      type: 'object',
+      properties: {
+        allowedFunctionCalls: {
+          type: 'array',
+          items: {
+            type: 'string'
+          }
+        }
+      },
+      additionalProperties: false
+    }]
   },
-  defaultOptions: [],
+  defaultOptions: [{
+    allowedFunctionCalls: []
+  }],
 
   create(context) {
+    var _context$options$;
+
+    const {
+      allowedFunctionCalls
+    } = (_context$options$ = context.options[0]) !== null && _context$options$ !== void 0 ? _context$options$ : {};
+
     const checkBlockBody = body => {
       for (const statement of body) {
-        if (shouldBeInHook(statement)) {
+        if (shouldBeInHook(statement, allowedFunctionCalls)) {
           context.report({
             node: statement,
             messageId: 'useHook'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-jest",
-  "version": "25.2.2",
+  "version": "25.3.1",
   "description": "Eslint rules for Jest",
   "keywords": [
     "eslint",
@@ -89,14 +89,14 @@
     "@babel/core": "^7.4.4",
     "@babel/preset-env": "^7.4.4",
     "@babel/preset-typescript": "^7.3.3",
-    "@commitlint/cli": "^13.1.0",
-    "@commitlint/config-conventional": "^13.1.0",
+    "@commitlint/cli": "^15.0.0",
+    "@commitlint/config-conventional": "^15.0.0",
     "@schemastore/package": "^0.0.6",
     "@semantic-release/changelog": "^6.0.0",
     "@semantic-release/git": "^10.0.0",
     "@types/dedent": "^0.7.0",
     "@types/jest": "^27.0.0",
-    "@types/node": "^14.0.0",
+    "@types/node": "^16.0.0",
     "@types/prettier": "^2.0.0",
     "@typescript-eslint/eslint-plugin": "^5.0.0",
     "@typescript-eslint/parser": "^5.0.0",
@@ -115,7 +115,7 @@
     "is-ci": "^3.0.0",
     "jest": "^27.0.0",
     "jest-runner-eslint": "^1.0.0",
-    "lint-staged": "^11.1.2",
+    "lint-staged": "^12.0.0",
     "pinst": "^2.0.0",
     "prettier": "^2.0.5",
     "rimraf": "^3.0.0",
@@ -131,6 +131,9 @@
   "peerDependenciesMeta": {
     "@typescript-eslint/eslint-plugin": {
       "optional": true
+    },
+    "jest": {
+      "optional": true
     }
   },
   "engines": {
@@ -155,5 +158,6 @@
   },
   "resolutions": {
     "@typescript-eslint/experimental-utils": "^5.0.0"
-  }
+  },
+  "packageManager": "yarn@3.1.1"
 }