eslint-plugin-jest 27.1.2 → 27.1.4

package/lib/rules/valid-expect.js

@@ -4,11 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _utils = require("@typescript-eslint/utils");
-
 var _utils2 = require("./utils");
-
 /*
  * This implementation is ported from from eslint-plugin-jasmine.
  * MIT license, Tom Vincent.
@@ -25,52 +22,38 @@ const getPromiseCallExpressionNode = node => {
   if (node.type === _utils.AST_NODE_TYPES.ArrayExpression && node.parent && node.parent.type === _utils.AST_NODE_TYPES.CallExpression) {
     node = node.parent;
   }
-
   if (node.type === _utils.AST_NODE_TYPES.CallExpression && node.callee.type === _utils.AST_NODE_TYPES.MemberExpression && (0, _utils2.isSupportedAccessor)(node.callee.object, 'Promise') && node.parent) {
     return node;
   }
-
   return null;
 };
-
 const findPromiseCallExpressionNode = node => {
   var _node$parent;
-
   return (_node$parent = node.parent) !== null && _node$parent !== void 0 && _node$parent.parent && [_utils.AST_NODE_TYPES.CallExpression, _utils.AST_NODE_TYPES.ArrayExpression].includes(node.parent.type) ? getPromiseCallExpressionNode(node.parent) : null;
 };
-
 const getParentIfThenified = node => {
   var _node$parent2;
-
   const grandParentNode = (_node$parent2 = node.parent) === null || _node$parent2 === void 0 ? void 0 : _node$parent2.parent;
-
   if (grandParentNode && grandParentNode.type === _utils.AST_NODE_TYPES.CallExpression && grandParentNode.callee.type === _utils.AST_NODE_TYPES.MemberExpression && (0, _utils2.isSupportedAccessor)(grandParentNode.callee.property) && ['then', 'catch'].includes((0, _utils2.getAccessorValue)(grandParentNode.callee.property)) && grandParentNode.parent) {
     // Just in case `then`s are chained look one above.
     return getParentIfThenified(grandParentNode);
   }
-
   return node;
 };
-
 const isAcceptableReturnNode = (node, allowReturn) => {
   if (allowReturn && node.type === _utils.AST_NODE_TYPES.ReturnStatement) {
     return true;
   }
-
   if (node.type === _utils.AST_NODE_TYPES.ConditionalExpression && node.parent) {
     return isAcceptableReturnNode(node.parent, allowReturn);
   }
-
   return [_utils.AST_NODE_TYPES.ArrowFunctionExpression, _utils.AST_NODE_TYPES.AwaitExpression].includes(node.type);
 };
-
 const promiseArrayExceptionKey = ({
   start,
   end
 }) => `${start.line}:${start.column}-${end.line}:${end.column}`;
-
 const defaultAsyncMatchers = ['toReject', 'toResolve'];
-
 var _default = (0, _utils2.createRule)({
   name: __filename,
   meta: {
@@ -120,7 +103,6 @@ var _default = (0, _utils2.createRule)({
     minArgs: 1,
     maxArgs: 1
   }],
-
   create(context, [{
     alwaysAwait,
     asyncMatchers = defaultAsyncMatchers,
@@ -129,8 +111,8 @@ var _default = (0, _utils2.createRule)({
   }]) {
     // Context state
     const arrayExceptions = new Set();
-
     const pushPromiseArrayException = loc => arrayExceptions.add(promiseArrayExceptionKey(loc));
+
     /**
      * Promise method that accepts an array of promises,
      * (eg. Promise.all), will throw warnings for the each
@@ -138,37 +120,27 @@ var _default = (0, _utils2.createRule)({
      * multiple warnings, we check if there is a warning in
      * the given location.
      */
-
-
     const promiseArrayExceptionExists = loc => arrayExceptions.has(promiseArrayExceptionKey(loc));
-
     const findTopMostMemberExpression = node => {
       let topMostMemberExpression = node;
       let {
         parent
       } = node;
-
       while (parent) {
         if (parent.type !== _utils.AST_NODE_TYPES.MemberExpression) {
           break;
         }
-
         topMostMemberExpression = parent;
         parent = parent.parent;
       }
-
       return topMostMemberExpression;
     };
-
     return {
       CallExpression(node) {
         const jestFnCall = (0, _utils2.parseJestFnCallWithReason)(node, context);
-
         if (typeof jestFnCall === 'string') {
           var _node$parent3;
-
           const reportingNode = ((_node$parent3 = node.parent) === null || _node$parent3 === void 0 ? void 0 : _node$parent3.type) === _utils.AST_NODE_TYPES.MemberExpression ? findTopMostMemberExpression(node.parent).property : node;
-
           if (jestFnCall === 'matcher-not-found') {
             context.report({
               messageId: 'matcherNotFound',
@@ -176,14 +148,12 @@ var _default = (0, _utils2.createRule)({
             });
             return;
           }
-
           if (jestFnCall === 'matcher-not-called') {
             context.report({
               messageId: (0, _utils2.isSupportedAccessor)(reportingNode) && _utils2.ModifierName.hasOwnProperty((0, _utils2.getAccessorValue)(reportingNode)) ? 'matcherNotFound' : 'matcherNotCalled',
               node: reportingNode
             });
           }
-
           if (jestFnCall === 'modifier-unknown') {
             context.report({
               messageId: 'modifierUnknown',
@@ -191,20 +161,16 @@ var _default = (0, _utils2.createRule)({
             });
             return;
           }
-
           return;
         } else if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) !== 'expect') {
           return;
         }
-
         const {
           parent: expect
         } = jestFnCall.head.node;
-
         if ((expect === null || expect === void 0 ? void 0 : expect.type) !== _utils.AST_NODE_TYPES.CallExpression) {
           return;
         }
-
         if (expect.arguments.length < minArgs) {
           const expectLength = (0, _utils2.getAccessorValue)(jestFnCall.head.node).length;
           const loc = {
@@ -227,7 +193,6 @@ var _default = (0, _utils2.createRule)({
             loc
           });
         }
-
         if (expect.arguments.length > maxArgs) {
           const {
             start
@@ -252,13 +217,11 @@ var _default = (0, _utils2.createRule)({
             loc
           });
         }
-
         const {
           matcher
         } = jestFnCall;
         const parentNode = matcher.parent.parent;
         const shouldBeAwaited = jestFnCall.modifiers.some(nod => (0, _utils2.getAccessorValue)(nod) !== 'not') || asyncMatchers.includes((0, _utils2.getAccessorValue)(matcher));
-
         if (!(parentNode !== null && parentNode !== void 0 && parentNode.parent) || !shouldBeAwaited) {
           return;
         }
@@ -266,8 +229,6 @@ var _default = (0, _utils2.createRule)({
          * If parent node is an array expression, we'll report the warning,
          * for the array object, not for each individual assertion.
          */
-
-
         const isParentArrayExpression = parentNode.parent.type === _utils.AST_NODE_TYPES.ArrayExpression;
         const orReturned = alwaysAwait ? '' : ' or returned';
         /**
@@ -275,12 +236,12 @@ var _default = (0, _utils2.createRule)({
          * In that case our target CallExpression node is the one with
          * the last `then` or `catch` statement.
          */
-
         const targetNode = getParentIfThenified(parentNode);
         const finalNode = findPromiseCallExpressionNode(targetNode) || targetNode;
-
-        if (finalNode.parent && // If node is not awaited or returned
-        !isAcceptableReturnNode(finalNode.parent, !alwaysAwait) && // if we didn't warn user already
+        if (finalNode.parent &&
+        // If node is not awaited or returned
+        !isAcceptableReturnNode(finalNode.parent, !alwaysAwait) &&
+        // if we didn't warn user already
         !promiseArrayExceptionExists(finalNode.loc)) {
           context.report({
             loc: finalNode.loc,
@@ -290,16 +251,12 @@ var _default = (0, _utils2.createRule)({
             messageId: finalNode === targetNode ? 'asyncMustBeAwaited' : 'promisesWithAsyncAssertionsMustBeAwaited',
             node
           });
-
           if (isParentArrayExpression) {
             pushPromiseArrayException(finalNode.loc);
           }
         }
       }
-
     };
   }
-
 });
-
 exports.default = _default;

package/lib/rules/valid-title.js

@@ -4,32 +4,23 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 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 doesBinaryExpressionContainStringNode = binaryExp => {
   if ((0, _utils2.isStringNode)(binaryExp.right)) {
     return true;
   }
-
   if (binaryExp.left.type === _utils.AST_NODE_TYPES.BinaryExpression) {
     return doesBinaryExpressionContainStringNode(binaryExp.left);
   }
-
   return (0, _utils2.isStringNode)(binaryExp.left);
 };
-
 const quoteStringValue = node => node.type === _utils.AST_NODE_TYPES.TemplateLiteral ? `\`${node.quasis[0].value.raw}\`` : node.raw;
-
 const compileMatcherPattern = matcherMaybeWithMessage => {
   const [matcher, message] = Array.isArray(matcherMaybeWithMessage) ? matcherMaybeWithMessage : [matcherMaybeWithMessage];
   return [new RegExp(matcher, 'u'), message];
 };
-
 const compileMatcherPatterns = matchers => {
   if (typeof matchers === 'string' || Array.isArray(matchers)) {
     const compiledMatcher = compileMatcherPattern(matchers);
@@ -39,14 +30,12 @@ const compileMatcherPatterns = matchers => {
       it: compiledMatcher
     };
   }
-
   return {
     describe: matchers.describe ? compileMatcherPattern(matchers.describe) : null,
     test: matchers.test ? compileMatcherPattern(matchers.test) : null,
     it: matchers.it ? compileMatcherPattern(matchers.it) : null
   };
 };
-
 const MatcherAndMessageSchema = {
   type: 'array',
   items: {
@@ -56,7 +45,6 @@ const MatcherAndMessageSchema = {
   maxItems: 2,
   additionalItems: false
 };
-
 var _default = (0, _utils2.createRule)({
   name: __filename,
   meta: {
@@ -116,7 +104,6 @@ var _default = (0, _utils2.createRule)({
     ignoreTypeOfDescribeName: false,
     disallowedWords: []
   }],
-
   create(context, [{
     ignoreTypeOfDescribeName,
     disallowedWords = [],
@@ -129,34 +116,26 @@ var _default = (0, _utils2.createRule)({
     return {
       CallExpression(node) {
         const jestFnCall = (0, _utils2.parseJestFnCall)(node, context);
-
         if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) !== 'describe' && (jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) !== 'test') {
           return;
         }
-
         const [argument] = node.arguments;
-
         if (!argument) {
           return;
         }
-
         if (!(0, _utils2.isStringNode)(argument)) {
           if (argument.type === _utils.AST_NODE_TYPES.BinaryExpression && doesBinaryExpressionContainStringNode(argument)) {
             return;
           }
-
           if (argument.type !== _utils.AST_NODE_TYPES.TemplateLiteral && !(ignoreTypeOfDescribeName && jestFnCall.type === 'describe')) {
             context.report({
               messageId: 'titleMustBeString',
               loc: argument.loc
             });
           }
-
           return;
         }
-
         const title = (0, _utils2.getStringValue)(argument);
-
         if (!title) {
           context.report({
             messageId: 'emptyTitle',
@@ -167,10 +146,8 @@ var _default = (0, _utils2.createRule)({
           });
           return;
         }
-
         if (disallowedWords.length > 0) {
           const disallowedMatch = disallowedWordsRegexp.exec(title);
-
           if (disallowedMatch) {
             context.report({
               data: {
@@ -182,7 +159,6 @@ var _default = (0, _utils2.createRule)({
             return;
           }
         }
-
         if (title.trim().length !== title.length) {
           context.report({
             messageId: 'accidentalSpace',
@@ -190,10 +166,8 @@ var _default = (0, _utils2.createRule)({
             fix: fixer => [fixer.replaceTextRange(argument.range, quoteStringValue(argument).replace(/^([`'"]) +?/u, '$1').replace(/ +?([`'"])$/u, '$1'))]
           });
         }
-
         const unprefixedName = trimFXprefix(jestFnCall.name);
         const [firstWord] = title.split(' ');
-
         if (firstWord.toLowerCase() === unprefixedName) {
           context.report({
             messageId: 'duplicatePrefix',
@@ -201,10 +175,8 @@ var _default = (0, _utils2.createRule)({
             fix: fixer => [fixer.replaceTextRange(argument.range, quoteStringValue(argument).replace(/^([`'"]).+? /u, '$1'))]
           });
         }
-
         const jestFunctionName = unprefixedName;
         const [mustNotMatchPattern, mustNotMatchMessage] = mustNotMatchPatterns[jestFunctionName] ?? [];
-
         if (mustNotMatchPattern) {
           if (mustNotMatchPattern.test(title)) {
             context.report({
@@ -219,9 +191,7 @@ var _default = (0, _utils2.createRule)({
             return;
           }
         }
-
         const [mustMatchPattern, mustMatchMessage] = mustMatchPatterns[jestFunctionName] ?? [];
-
         if (mustMatchPattern) {
           if (!mustMatchPattern.test(title)) {
             context.report({
@@ -237,10 +207,7 @@ var _default = (0, _utils2.createRule)({
           }
         }
       }
-
     };
   }
-
 });
-
 exports.default = _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-jest",
-  "version": "27.1.2",
+  "version": "27.1.4",
   "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",