eslint-plugin-jest 27.1.3 → 27.1.5

package/lib/rules/no-test-prefixes.js

@@ -11,7 +11,7 @@ var _default = (0, _utils2.createRule)({
   meta: {
     docs: {
       category: 'Best Practices',
-      description: 'Use `.only` and `.skip` over `f` and `x`',
+      description: 'Require using `.only` and `.skip` over `f` and `x`',
       recommended: 'error'
     },
     messages: {

package/lib/rules/utils/parseJestFnCall.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.getNodeChain = getNodeChain;
-exports.scopeHasLocalReference = exports.parseJestFnCallWithReason = exports.parseJestFnCall = exports.isTypeOfJestFnCall = void 0;
+exports.resolveScope = exports.parseJestFnCallWithReason = exports.parseJestFnCall = exports.isTypeOfJestFnCall = void 0;
 var _utils = require("@typescript-eslint/utils");
 var _utils2 = require("../utils");
 const isTypeOfJestFnCall = (node, context, types) => {
@@ -286,38 +286,31 @@ const describePossibleImportDef = def => {
   }
   return null;
 };
-const collectReferences = scope => {
-  const locals = new Set();
-  const imports = new Map();
-  const unresolved = new Set();
+const resolveScope = (scope, identifier) => {
   let currentScope = scope;
   while (currentScope !== null) {
-    for (const ref of currentScope.variables) {
-      if (ref.defs.length === 0) {
-        continue;
-      }
+    const ref = currentScope.set.get(identifier);
+    if (ref && ref.defs.length > 0) {
       const def = ref.defs[ref.defs.length - 1];
       const importDetails = describePossibleImportDef(def);
-      if (importDetails) {
-        imports.set(importDetails.local, importDetails);
-        continue;
+      if ((importDetails === null || importDetails === void 0 ? void 0 : importDetails.local) === identifier) {
+        return importDetails;
       }
-      locals.add(ref.name);
-    }
-    for (const ref of currentScope.through) {
-      unresolved.add(ref.identifier.name);
+      return 'local';
     }
     currentScope = currentScope.upper;
   }
-  return {
-    locals,
-    imports,
-    unresolved
-  };
+  return null;
 };
+exports.resolveScope = resolveScope;
 const resolveToJestFn = (context, identifier) => {
-  const references = collectReferences(context.getScope());
-  const maybeImport = references.imports.get(identifier);
+  const maybeImport = resolveScope(context.getScope(), identifier);
+
+  // the identifier was found as a local variable or function declaration
+  // meaning it's not a function from jest
+  if (maybeImport === 'local') {
+    return null;
+  }
   if (maybeImport) {
     // the identifier is imported from @jest/globals,
     // so return the original import name
@@ -330,28 +323,9 @@ const resolveToJestFn = (context, identifier) => {
     }
     return null;
   }
-
-  // the identifier was found as a local variable or function declaration
-  // meaning it's not a function from jest
-  if (references.locals.has(identifier)) {
-    return null;
-  }
   return {
     original: resolvePossibleAliasedGlobal(identifier, context),
     local: identifier,
     type: 'global'
   };
-};
-const scopeHasLocalReference = (scope, referenceName) => {
-  const references = collectReferences(scope);
-  return (
-    // referenceName was found as a local variable or function declaration.
-    references.locals.has(referenceName) ||
-    // referenceName was found as an imported identifier
-    references.imports.has(referenceName) ||
-    // referenceName was not found as an unresolved reference,
-    // meaning it is likely not an implicit global reference.
-    !references.unresolved.has(referenceName)
-  );
-};
-exports.scopeHasLocalReference = scopeHasLocalReference;
+};

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

@@ -208,7 +208,7 @@ var _default = (0, _utils2.createRule)({
   meta: {
     docs: {
       category: 'Best Practices',
-      description: 'Ensure promises that have expectations in their chain are valid',
+      description: 'Require promises that have expectations in their chain to be valid',
       recommended: 'error'
     },
     messages: {

package/lib/rules/valid-title.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 var _utils = require("@typescript-eslint/utils");
 var _utils2 = require("./utils");
-const trimFXprefix = word => ['f', 'x'].includes(word.charAt(0)) ? word.substr(1) : word;
+const trimFXprefix = word => ['f', 'x'].includes(word.charAt(0)) ? word.substring(1) : word;
 const doesBinaryExpressionContainStringNode = binaryExp => {
   if ((0, _utils2.isStringNode)(binaryExp.right)) {
     return true;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-jest",
-  "version": "27.1.3",
+  "version": "27.1.5",
   "description": "ESLint rules for Jest",
   "keywords": [
     "eslint",
@@ -29,7 +29,7 @@
     "prettier:write": "prettier --write 'docs/**/*.md' README.md '.github/**' package.json tsconfig.json src/globals.json .yarnrc.yml",
     "postpublish": "pinst --enable",
     "test": "jest",
-    "tools:regenerate-docs": "ts-node -T tools/regenerate-docs",
+    "tools:regenerate-docs": "yarn prepack && eslint-doc-generator --ignore-config all --rule-doc-title-format desc-parens-name --rule-doc-section-include \"Rule details\" --rule-list-columns name,description,configsError,configsWarn,configsOff,fixable,hasSuggestions,deprecated --split-by meta.docs.requiresTypeChecking --url-configs \"https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations\" && yarn prettier:write",
     "typecheck": "tsc -p ."
   },
   "commitlint": {
@@ -121,6 +121,7 @@
     "dedent": "^0.7.0",
     "eslint": "^6.0.0 || ^7.0.0 || ^8.0.0",
     "eslint-config-prettier": "^8.3.0",
+    "eslint-doc-generator": "^0.19.0",
     "eslint-plugin-eslint-comments": "^3.1.2",
     "eslint-plugin-eslint-plugin": "^5.0.6",
     "eslint-plugin-import": "^2.25.1",