eslint-plugin-jest 27.2.2 → 27.3.0

package/README.md

@@ -220,6 +220,7 @@ set to warn in.\
 | [no-commented-out-tests](docs/rules/no-commented-out-tests.md)               | Disallow commented out tests                                              |     | ✅  |     |     |     |
 | [no-conditional-expect](docs/rules/no-conditional-expect.md)                 | Disallow calling `expect` conditionally                                   | ✅  |     |     |     |     |
 | [no-conditional-in-test](docs/rules/no-conditional-in-test.md)               | Disallow conditional logic in tests                                       |     |     |     |     |     |
+| [no-confusing-set-timeout](docs/rules/no-confusing-set-timeout.md)           | Disallow confusing usages of jest.setTimeout                              |     |     |     |     |     |
 | [no-deprecated-functions](docs/rules/no-deprecated-functions.md)             | Disallow use of deprecated functions                                      | ✅  |     | 🔧  |     |     |
 | [no-disabled-tests](docs/rules/no-disabled-tests.md)                         | Disallow disabled tests                                                   |     | ✅  |     |     |     |
 | [no-done-callback](docs/rules/no-done-callback.md)                           | Disallow using a callback in asynchronous tests and hooks                 | ✅  |     |     | 💡  |     |

package/docs/rules/no-confusing-set-timeout.md

@@ -0,0 +1,62 @@
+# Disallow confusing usages of jest.setTimeout (`no-confusing-set-timeout`)
+
+<!-- end auto-generated rule header -->
+
+While `jest.setTimeout` can be called multiple times anywhere within a single
+test file only the last call before any test functions run will have an effect.
+
+## Rule details
+
+this rule checks for several confusing usages of `jest.setTimeout` that looks
+like it applies to specific tests within the same file, such as:
+
+- being called anywhere other than in global scope
+- being called multiple times
+- being called after other Jest functions like hooks, `describe`, `test`, or
+  `it`
+
+Examples of **incorrect** code for this rule:
+
+```js
+describe('test foo', () => {
+  jest.setTimeout(1000);
+  it('test-description', () => {
+    // test logic;
+  });
+});
+
+describe('test bar', () => {
+  it('test-description', () => {
+    jest.setTimeout(1000);
+    // test logic;
+  });
+});
+
+test('foo-bar', () => {
+  jest.setTimeout(1000);
+});
+
+describe('unit test', () => {
+  beforeEach(() => {
+    jest.setTimeout(1000);
+  });
+});
+```
+
+Examples of **correct** code for this rule:
+
+```js
+jest.setTimeout(500);
+test('test test', () => {
+  // do some stuff
+});
+```
+
+```js
+jest.setTimeout(1000);
+describe('test bar bar', () => {
+  it('test-description', () => {
+    // test logic;
+  });
+});
+```

package/lib/rules/expect-expect.js

@@ -20,7 +20,9 @@ var _utils2 = require("./utils");
  */
 function matchesAssertFunctionName(nodeName, patterns) {
   return patterns.some(p => new RegExp(`^${p.split('.').map(x => {
-    if (x === '**') return '[a-z\\d\\.]*';
+    if (x === '**') {
+      return '[a-z\\d\\.]*';
+    }
     return x.replace(/\*/gu, '[a-z\\d]*');
   }).join('\\.')}(\\.|$)`, 'ui').test(nodeName));
 }

package/lib/rules/no-confusing-set-timeout.js

@@ -0,0 +1,65 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _utils = require("./utils");
+function isJestSetTimeout(jestFnCall) {
+  return jestFnCall.type === 'jest' && jestFnCall.members.length === 1 && (0, _utils.isIdentifier)(jestFnCall.members[0], 'setTimeout');
+}
+var _default = (0, _utils.createRule)({
+  name: __filename,
+  meta: {
+    docs: {
+      category: 'Best Practices',
+      description: 'Disallow confusing usages of jest.setTimeout',
+      recommended: false
+    },
+    messages: {
+      globalSetTimeout: '`jest.setTimeout` should be call in `global` scope',
+      multipleSetTimeouts: 'Do not call `jest.setTimeout` multiple times, as only the last call will have an effect',
+      orderSetTimeout: '`jest.setTimeout` should be placed before any other jest methods'
+    },
+    type: 'problem',
+    schema: []
+  },
+  defaultOptions: [],
+  create(context) {
+    let seenJestTimeout = false;
+    let shouldEmitOrderSetTimeout = false;
+    return {
+      CallExpression(node) {
+        const scope = context.getScope();
+        const jestFnCall = (0, _utils.parseJestFnCall)(node, context);
+        if (!jestFnCall) {
+          return;
+        }
+        if (!isJestSetTimeout(jestFnCall)) {
+          shouldEmitOrderSetTimeout = true;
+          return;
+        }
+        if (!['global', 'module'].includes(scope.type)) {
+          context.report({
+            messageId: 'globalSetTimeout',
+            node
+          });
+        }
+        if (shouldEmitOrderSetTimeout) {
+          context.report({
+            messageId: 'orderSetTimeout',
+            node
+          });
+        }
+        if (seenJestTimeout) {
+          context.report({
+            messageId: 'multipleSetTimeouts',
+            node
+          });
+        }
+        seenJestTimeout = true;
+      }
+    };
+  }
+});
+exports.default = _default;

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

@@ -30,8 +30,8 @@ var _default = (0, _utils2.createRule)({
   },
   defaultOptions: [],
   create(context) {
-    var _context$settings, _context$settings$jes;
-    const jestVersion = parseJestVersion(((_context$settings = context.settings) === null || _context$settings === void 0 ? void 0 : (_context$settings$jes = _context$settings.jest) === null || _context$settings$jes === void 0 ? void 0 : _context$settings$jes.version) || (0, _utils2.detectJestVersion)());
+    var _context$settings;
+    const jestVersion = parseJestVersion(((_context$settings = context.settings) === null || _context$settings === void 0 || (_context$settings = _context$settings.jest) === null || _context$settings === void 0 ? void 0 : _context$settings.version) || (0, _utils2.detectJestVersion)());
     const deprecations = {
       ...(jestVersion >= 15 && {
         'jest.resetModuleRegistry': 'jest.resetModules'

package/lib/rules/no-test-return-statement.js

@@ -36,7 +36,9 @@ var _default = (0, _utils2.createRule)({
         }
         const body = getBody(node.arguments);
         const returnStmt = body.find(t => t.type === _utils.AST_NODE_TYPES.ReturnStatement);
-        if (!returnStmt) return;
+        if (!returnStmt) {
+          return;
+        }
         context.report({
           messageId: 'noReturnValue',
           node: returnStmt
@@ -45,9 +47,13 @@ var _default = (0, _utils2.createRule)({
       FunctionDeclaration(node) {
         const declaredVariables = context.getDeclaredVariables(node);
         const testCallExpressions = (0, _utils2.getTestCallExpressionsFromDeclaredVariables)(declaredVariables, context);
-        if (testCallExpressions.length === 0) return;
+        if (testCallExpressions.length === 0) {
+          return;
+        }
         const returnStmt = node.body.body.find(t => t.type === _utils.AST_NODE_TYPES.ReturnStatement);
-        if (!returnStmt) return;
+        if (!returnStmt) {
+          return;
+        }
         context.report({
           messageId: 'noReturnValue',
           node: returnStmt

package/lib/rules/no-untyped-mock-factory.js

@@ -56,7 +56,9 @@ var _default = (0, _utils2.createRule)({
             },
             node,
             fix(fixer) {
-              if (!moduleName) return [];
+              if (!moduleName) {
+                return [];
+              }
               return [fixer.insertTextAfter(callee, `<typeof import(${moduleName.raw})>`)];
             }
           });

package/lib/rules/prefer-spy-on.js

@@ -61,9 +61,13 @@ var _default = (0, _utils2.createRule)({
           left,
           right
         } = node;
-        if (left.type !== _utils.AST_NODE_TYPES.MemberExpression) return;
+        if (left.type !== _utils.AST_NODE_TYPES.MemberExpression) {
+          return;
+        }
         const jestFnCall = getJestFnCall(right);
-        if (!jestFnCall) return;
+        if (!jestFnCall) {
+          return;
+        }
         context.report({
           node,
           messageId: 'useJestSpyOn',

package/lib/rules/unbound-method.js

@@ -63,7 +63,7 @@ var _default = (0, _utils2.createRule)({
             }
           }
         }
-        (_baseSelectors$Member = baseSelectors.MemberExpression) === null || _baseSelectors$Member === void 0 ? void 0 : _baseSelectors$Member.call(baseSelectors, node);
+        (_baseSelectors$Member = baseSelectors.MemberExpression) === null || _baseSelectors$Member === void 0 || _baseSelectors$Member.call(baseSelectors, node);
       }
     };
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-jest",
-  "version": "27.2.2",
+  "version": "27.3.0",
   "description": "ESLint rules for Jest",
   "keywords": [
     "eslint",
@@ -14,13 +14,13 @@
     "email": "hello@jkimbo.com",
     "url": "jkimbo.com"
   },
-  "main": "lib/",
+  "main": "lib/index.js",
   "files": [
     "docs/",
     "lib/"
   ],
   "scripts": {
-    "build": "babel --extensions .js,.ts src --out-dir lib --copy-files && rimraf lib/__tests__ 'lib/**/__tests__'",
+    "build": "babel --extensions .js,.ts src --out-dir lib --copy-files && rimraf --glob lib/__tests__ 'lib/**/__tests__'",
     "_postinstall": "is-ci || husky install",
     "lint": "eslint . --ignore-pattern '!.eslintrc.js' --ext js,ts",
     "prepack": "rimraf lib && yarn build",
@@ -45,8 +45,7 @@
     "arrowParens": "avoid",
     "endOfLine": "auto",
     "proseWrap": "always",
-    "singleQuote": true,
-    "trailingComma": "all"
+    "singleQuote": true
   },
   "release": {
     "branches": [
@@ -105,28 +104,26 @@
     "@babel/preset-typescript": "^7.3.3",
     "@commitlint/cli": "^17.0.3",
     "@commitlint/config-conventional": "^17.0.3",
-    "@schemastore/package": "^0.0.8",
+    "@schemastore/package": "^0.0.10",
     "@semantic-release/changelog": "^6.0.0",
     "@semantic-release/git": "^10.0.0",
-    "@tsconfig/node14": "^1.0.3",
-    "@types/dedent": "^0.7.0",
+    "@tsconfig/node14": "^14.1.0",
     "@types/eslint": "^8.4.6",
     "@types/jest": "^29.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": "^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",
+    "dedent": "^1.5.0",
+    "eslint": "^7.0.0 || ^8.0.0",
+    "eslint-config-prettier": "^9.0.0",
     "eslint-doc-generator": "^1.0.0",
     "eslint-plugin-eslint-comments": "^3.1.2",
     "eslint-plugin-eslint-plugin": "^5.0.6",
     "eslint-plugin-import": "^2.25.1",
     "eslint-plugin-node": "^11.0.0",
-    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-prettier": "^5.0.0",
     "eslint-remote-tester": "^3.0.0",
     "eslint-remote-tester-repositories": "~1.0.0",
     "husky": "^8.0.1",
@@ -136,7 +133,7 @@
     "lint-staged": "^13.0.3",
     "markdown-link-check": "^3.10.2",
     "pinst": "^3.0.0",
-    "prettier": "^2.0.5",
+    "prettier": "^3.0.0",
     "rimraf": "^5.0.0",
     "semantic-release": "^21.0.0",
     "semver": "^7.3.5",
@@ -144,7 +141,7 @@
     "typescript": "^5.0.4"
   },
   "peerDependencies": {
-    "@typescript-eslint/eslint-plugin": "^5.0.0",
+    "@typescript-eslint/eslint-plugin": "^5.0.0 || ^6.0.0",
     "eslint": "^7.0.0 || ^8.0.0",
     "jest": "*"
   },
@@ -156,7 +153,7 @@
       "optional": true
     }
   },
-  "packageManager": "yarn@3.6.0",
+  "packageManager": "yarn@3.6.3",
   "engines": {
     "node": "^14.15.0 || ^16.10.0 || >=18.0.0"
   },

package/lib/processors/__tests__/snapshot-processor.test.js

@@ -1,36 +0,0 @@
-"use strict";
-
-var snapshotProcessor = _interopRequireWildcard(require("../snapshot-processor"));
-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, 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; }
-describe('snapshot-processor', () => {
-  it('exports an object with preprocess and postprocess functions', () => {
-    expect(snapshotProcessor).toMatchObject({
-      preprocess: expect.any(Function),
-      postprocess: expect.any(Function)
-    });
-  });
-  describe('preprocess function', () => {
-    it('should pass on untouched source code to source array', () => {
-      const {
-        preprocess
-      } = snapshotProcessor;
-      const sourceCode = "const name = 'johnny bravo';";
-      const result = preprocess(sourceCode);
-      expect(result).toEqual([sourceCode]);
-    });
-  });
-  describe('postprocess function', () => {
-    it('should only return messages about snapshot specific rules', () => {
-      const {
-        postprocess
-      } = snapshotProcessor;
-      const result = postprocess([['no-console', 'global-require', 'jest/no-large-snapshots'].map(ruleId => ({
-        ruleId
-      }))]);
-      expect(result).toEqual([{
-        ruleId: 'jest/no-large-snapshots'
-      }]);
-    });
-  });
-});