eslint-plugin-jest 25.1.0 → 25.2.3

package/CHANGELOG.md

@@ -1,3 +1,31 @@
+## [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)
+
+
+### Bug Fixes
+
+* **require-hook:** check variables are either `const` or declarations ([#959](https://github.com/jest-community/eslint-plugin-jest/issues/959)) ([ce8cd61](https://github.com/jest-community/eslint-plugin-jest/commit/ce8cd612b7c4c16dc29934118b191d3fbe1ffc07))
+
+## [25.2.1](https://github.com/jest-community/eslint-plugin-jest/compare/v25.2.0...v25.2.1) (2021-10-15)
+
+
+### Bug Fixes
+
+* **expect-expect:** don't error on `it.todo` & `test.todo` calls ([#954](https://github.com/jest-community/eslint-plugin-jest/issues/954)) ([d3cc0db](https://github.com/jest-community/eslint-plugin-jest/commit/d3cc0db129f8d2021cf278f656b73b8c7efb2dc2))
+
+# [25.2.0](https://github.com/jest-community/eslint-plugin-jest/compare/v25.1.0...v25.2.0) (2021-10-14)
+
+
+### Features
+
+* **expect-expect:** support `additionalTestBlockFunctions` option ([#850](https://github.com/jest-community/eslint-plugin-jest/issues/850)) ([3b94c62](https://github.com/jest-community/eslint-plugin-jest/commit/3b94c62b81a50bc8b213c597bb59799cff1ef207))
+
 # [25.1.0](https://github.com/jest-community/eslint-plugin-jest/compare/v25.0.6...v25.1.0) (2021-10-14)
 
 

package/docs/rules/expect-expect.md

@@ -34,7 +34,8 @@ it('should work with callbacks/async', () => {
   "jest/expect-expect": [
     "error",
     {
-      "assertFunctionNames": ["expect"]
+      "assertFunctionNames": ["expect"],
+      "additionalTestBlockFunctions": []
     }
   ]
 }
@@ -102,3 +103,43 @@ describe('GET /user', function () {
   });
 });
 ```
+
+### `additionalTestBlockFunctions`
+
+This array can be used to specify the names of functions that should also be
+treated as test blocks:
+
+```json
+{
+  "rules": {
+    "jest/expect-expect": [
+      "error",
+      { "additionalTestBlockFunctions": ["theoretically"] }
+    ]
+  }
+}
+```
+
+The following is _correct_ when using the above configuration:
+
+```js
+import theoretically from 'jest-theories';
+
+describe('NumberToLongString', () => {
+  const theories = [
+    { input: 100, expected: 'One hundred' },
+    { input: 1000, expected: 'One thousand' },
+    { input: 10000, expected: 'Ten thousand' },
+    { input: 100000, expected: 'One hundred thousand' },
+  ];
+
+  theoretically(
+    'the number {input} is correctly translated to string',
+    theories,
+    theory => {
+      const output = NumberToLongString(theory.input);
+      expect(output).toBe(theory.expected);
+    },
+  );
+});
+```

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

@@ -19,7 +19,8 @@ directly within the body of a `describe`, _except_ for the following:
 
 - `import` statements
 - `const` variables
-- `let` _declarations_
+- `let` _declarations_, and initializations to `null` or `undefined`
+- Classes
 - Types
 - Calls to the standard Jest globals
 

package/lib/rules/expect-expect.js

@@ -47,6 +47,12 @@ var _default = (0, _utils.createRule)({
           items: [{
             type: 'string'
           }]
+        },
+        additionalTestBlockFunctions: {
+          type: 'array',
+          items: {
+            type: 'string'
+          }
         }
       },
       additionalProperties: false
@@ -54,11 +60,13 @@ var _default = (0, _utils.createRule)({
     type: 'suggestion'
   },
   defaultOptions: [{
-    assertFunctionNames: ['expect']
+    assertFunctionNames: ['expect'],
+    additionalTestBlockFunctions: []
   }],
 
   create(context, [{
-    assertFunctionNames = ['expect']
+    assertFunctionNames = ['expect'],
+    additionalTestBlockFunctions = []
   }]) {
     const unchecked = [];
 
@@ -81,11 +89,17 @@ var _default = (0, _utils.createRule)({
 
     return {
       CallExpression(node) {
-        const name = (0, _utils.getNodeName)(node.callee);
+        var _getNodeName;
+
+        const name = (_getNodeName = (0, _utils.getNodeName)(node.callee)) !== null && _getNodeName !== void 0 ? _getNodeName : '';
+
+        if ((0, _utils.isTestCaseCall)(node) || additionalTestBlockFunctions.includes(name)) {
+          if (node.callee.type === _experimentalUtils.AST_NODE_TYPES.MemberExpression && (0, _utils.isSupportedAccessor)(node.callee.property, 'todo')) {
+            return;
+          }
 
-        if (name === _utils.TestCaseName.it || name === _utils.TestCaseName.test) {
           unchecked.push(node);
-        } else if (name && matchesAssertFunctionName(name, assertFunctionNames)) {
+        } else if (matchesAssertFunctionName(name, assertFunctionNames)) {
           // Return early in case of nested `it` statements.
           checkCallExpressionUsed(context.getAncestors());
         }

package/lib/rules/require-hook.js

@@ -19,6 +19,10 @@ const isJestFnCall = node => {
   return !!((_getNodeName = (0, _utils.getNodeName)(node)) !== null && _getNodeName !== void 0 && _getNodeName.startsWith('jest.'));
 };
 
+const isNullOrUndefined = node => {
+  return node.type === _experimentalUtils.AST_NODE_TYPES.Literal && node.value === null || (0, _utils.isIdentifier)(node, 'undefined');
+};
+
 const shouldBeInHook = node => {
   switch (node.type) {
     case _experimentalUtils.AST_NODE_TYPES.ExpressionStatement:
@@ -27,6 +31,17 @@ const shouldBeInHook = node => {
     case _experimentalUtils.AST_NODE_TYPES.CallExpression:
       return !isJestFnCall(node);
 
+    case _experimentalUtils.AST_NODE_TYPES.VariableDeclaration:
+      {
+        if (node.kind === 'const') {
+          return false;
+        }
+
+        return node.declarations.some(({
+          init
+        }) => init !== null && !isNullOrUndefined(init));
+      }
+
     default:
       return false;
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-jest",
-  "version": "25.1.0",
+  "version": "25.2.3",
   "description": "Eslint rules for Jest",
   "keywords": [
     "eslint",
@@ -96,7 +96,7 @@
     "@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",
@@ -107,7 +107,7 @@
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-eslint-comments": "^3.1.2",
     "eslint-plugin-eslint-config": "^2.0.0",
-    "eslint-plugin-eslint-plugin": "^3.5.3",
+    "eslint-plugin-eslint-plugin": "^4.0.1",
     "eslint-plugin-import": "^2.25.1",
     "eslint-plugin-node": "^11.0.0",
     "eslint-plugin-prettier": "^3.4.1",
@@ -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.0.2"
 }