eslint-plugin-jest 26.8.7 → 27.1.5

package/lib/index.js

@@ -1,41 +1,34 @@
 "use strict";
 
 var _fs = require("fs");
-
 var _path = require("path");
-
 var _globals = _interopRequireDefault(require("./globals.json"));
-
 var snapshotProcessor = _interopRequireWildcard(require("./processors/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; }
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 // copied from https://github.com/babel/babel/blob/d8da63c929f2d28c401571e2a43166678c555bc4/packages/babel-helpers/src/helpers.js#L602-L606
-
 /* istanbul ignore next */
 const interopRequireDefault = obj => obj && obj.__esModule ? obj : {
   default: obj
 };
-
-const importDefault = moduleName => // eslint-disable-next-line @typescript-eslint/no-require-imports
+const importDefault = moduleName =>
+// eslint-disable-next-line @typescript-eslint/no-require-imports
 interopRequireDefault(require(moduleName)).default;
-
 const rulesDir = (0, _path.join)(__dirname, 'rules');
 const excludedFiles = ['__tests__', 'detectJestVersion', 'utils'];
-const rules = (0, _fs.readdirSync)(rulesDir).map(rule => (0, _path.parse)(rule).name).filter(rule => !excludedFiles.includes(rule)).reduce((acc, curr) => ({ ...acc,
+const rules = (0, _fs.readdirSync)(rulesDir).map(rule => (0, _path.parse)(rule).name).filter(rule => !excludedFiles.includes(rule)).reduce((acc, curr) => ({
+  ...acc,
   [curr]: importDefault((0, _path.join)(rulesDir, curr))
 }), {});
-const recommendedRules = Object.entries(rules).filter(([, rule]) => rule.meta.docs.recommended).reduce((acc, [name, rule]) => ({ ...acc,
+const recommendedRules = Object.entries(rules).filter(([, rule]) => rule.meta.docs.recommended).reduce((acc, [name, rule]) => ({
+  ...acc,
   [`jest/${name}`]: rule.meta.docs.recommended
 }), {});
-const allRules = Object.entries(rules).filter(([, rule]) => !rule.meta.deprecated).reduce((acc, [name]) => ({ ...acc,
+const allRules = Object.entries(rules).filter(([, rule]) => !rule.meta.deprecated).reduce((acc, [name]) => ({
+  ...acc,
   [`jest/${name}`]: 'error'
 }), {});
-
 const createConfig = rules => ({
   plugins: ['jest'],
   env: {
@@ -43,20 +36,16 @@ const createConfig = rules => ({
   },
   rules
 });
-
 module.exports = {
   configs: {
     all: createConfig(allRules),
     recommended: createConfig(recommendedRules),
-    style: {
-      plugins: ['jest'],
-      rules: {
-        'jest/no-alias-methods': 'warn',
-        'jest/prefer-to-be': 'error',
-        'jest/prefer-to-contain': 'error',
-        'jest/prefer-to-have-length': 'error'
-      }
-    }
+    style: createConfig({
+      'jest/no-alias-methods': 'warn',
+      'jest/prefer-to-be': 'error',
+      'jest/prefer-to-contain': 'error',
+      'jest/prefer-to-have-length': 'error'
+    })
   },
   environments: {
     globals: {

package/lib/processors/snapshot-processor.js

@@ -4,14 +4,12 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.preprocess = exports.postprocess = void 0;
-
 // https://eslint.org/docs/developer-guide/working-with-plugins#processors-in-plugins
 // https://github.com/typescript-eslint/typescript-eslint/issues/808
-const preprocess = source => [source];
 
+const preprocess = source => [source];
 exports.preprocess = preprocess;
-
-const postprocess = messages => // snapshot files should only be linted with snapshot specific rules
+const postprocess = messages =>
+// snapshot files should only be linted with snapshot specific rules
 messages[0].filter(message => message.ruleId === 'jest/no-large-snapshots');
-
 exports.postprocess = postprocess;

package/lib/rules/consistent-test-it.js

@@ -4,19 +4,15 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _utils = require("@typescript-eslint/utils");
-
 var _utils2 = require("./utils");
-
 const buildFixer = (callee, nodeName, preferredTestKeyword) => fixer => [fixer.replaceText(callee.type === _utils.AST_NODE_TYPES.MemberExpression ? callee.object : callee, getPreferredNodeName(nodeName, preferredTestKeyword))];
-
 var _default = (0, _utils2.createRule)({
   name: __filename,
   meta: {
     docs: {
       category: 'Best Practices',
-      description: 'Have control over `test` and `it` usages',
+      description: 'Enforce `test` and `it` usage conventions',
       recommended: false
     },
     fixable: 'code',
@@ -42,7 +38,6 @@ var _default = (0, _utils2.createRule)({
     fn: _utils2.TestCaseName.test,
     withinDescribe: _utils2.TestCaseName.it
   }],
-
   create(context) {
     const configObj = context.options[0] || {};
     const testKeyword = configObj.fn || _utils2.TestCaseName.test;
@@ -51,18 +46,14 @@ var _default = (0, _utils2.createRule)({
     return {
       CallExpression(node) {
         const jestFnCall = (0, _utils2.parseJestFnCall)(node, context);
-
         if (!jestFnCall) {
           return;
         }
-
         if (jestFnCall.type === 'describe') {
           describeNestingLevel++;
           return;
         }
-
         const funcNode = node.callee.type === _utils.AST_NODE_TYPES.TaggedTemplateExpression ? node.callee.tag : node.callee.type === _utils.AST_NODE_TYPES.CallExpression ? node.callee.callee : node.callee;
-
         if (jestFnCall.type === 'test' && describeNestingLevel === 0 && !jestFnCall.name.endsWith(testKeyword)) {
           const oppositeTestKeyword = getOppositeTestKeyword(testKeyword);
           context.report({
@@ -75,7 +66,6 @@ var _default = (0, _utils2.createRule)({
             fix: buildFixer(funcNode, jestFnCall.name, testKeyword)
           });
         }
-
         if (jestFnCall.type === 'test' && describeNestingLevel > 0 && !jestFnCall.name.endsWith(testKeywordWithinDescribe)) {
           const oppositeTestKeyword = getOppositeTestKeyword(testKeywordWithinDescribe);
           context.report({
@@ -89,32 +79,24 @@ var _default = (0, _utils2.createRule)({
           });
         }
       },
-
       'CallExpression:exit'(node) {
         if ((0, _utils2.isTypeOfJestFnCall)(node, context, ['describe'])) {
           describeNestingLevel--;
         }
       }
-
     };
   }
-
 });
-
 exports.default = _default;
-
 function getPreferredNodeName(nodeName, preferredTestKeyword) {
   if (nodeName === _utils2.TestCaseName.fit) {
     return 'test.only';
   }
-
   return nodeName.startsWith('f') || nodeName.startsWith('x') ? nodeName.charAt(0) + preferredTestKeyword : preferredTestKeyword;
 }
-
 function getOppositeTestKeyword(test) {
   if (test === _utils2.TestCaseName.test) {
     return _utils2.TestCaseName.it;
   }
-
   return _utils2.TestCaseName.test;
 }

package/lib/rules/expect-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 adapted from eslint-plugin-jasmine.
  * MIT license, Remco Haszing.
@@ -27,7 +24,6 @@ function matchesAssertFunctionName(nodeName, patterns) {
     return x.replace(/\*/gu, '[a-z\\d]*');
   }).join('\\.')}(\\.|$)`, 'ui').test(nodeName));
 }
-
 var _default = (0, _utils2.createRule)({
   name: __filename,
   meta: {
@@ -63,58 +59,45 @@ var _default = (0, _utils2.createRule)({
     assertFunctionNames: ['expect'],
     additionalTestBlockFunctions: []
   }],
-
   create(context, [{
     assertFunctionNames = ['expect'],
     additionalTestBlockFunctions = []
   }]) {
     const unchecked = [];
-
     function checkCallExpressionUsed(nodes) {
       for (const node of nodes) {
         const index = node.type === _utils.AST_NODE_TYPES.CallExpression ? unchecked.indexOf(node) : -1;
-
         if (node.type === _utils.AST_NODE_TYPES.FunctionDeclaration) {
           const declaredVariables = context.getDeclaredVariables(node);
           const testCallExpressions = (0, _utils2.getTestCallExpressionsFromDeclaredVariables)(declaredVariables, context);
           checkCallExpressionUsed(testCallExpressions);
         }
-
         if (index !== -1) {
           unchecked.splice(index, 1);
           break;
         }
       }
     }
-
     return {
       CallExpression(node) {
-        var _getNodeName;
-
-        const name = (_getNodeName = (0, _utils2.getNodeName)(node.callee)) !== null && _getNodeName !== void 0 ? _getNodeName : '';
-
+        const name = (0, _utils2.getNodeName)(node.callee) ?? '';
         if ((0, _utils2.isTypeOfJestFnCall)(node, context, ['test']) || additionalTestBlockFunctions.includes(name)) {
           if (node.callee.type === _utils.AST_NODE_TYPES.MemberExpression && (0, _utils2.isSupportedAccessor)(node.callee.property, 'todo')) {
             return;
           }
-
           unchecked.push(node);
         } else if (matchesAssertFunctionName(name, assertFunctionNames)) {
           // Return early in case of nested `it` statements.
           checkCallExpressionUsed(context.getAncestors());
         }
       },
-
       'Program:exit'() {
         unchecked.forEach(node => context.report({
           messageId: 'noAssertions',
           node
         }));
       }
-
     };
   }
-
 });
-
 exports.default = _default;

package/lib/rules/max-expects.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");
-
 var _default = (0, _utils2.createRule)({
   name: __filename,
   meta: {
@@ -35,39 +32,29 @@ var _default = (0, _utils2.createRule)({
   defaultOptions: [{
     max: 5
   }],
-
   create(context, [{
     max
   }]) {
     let count = 0;
-
     const maybeResetCount = node => {
       var _node$parent;
-
       const isTestFn = ((_node$parent = node.parent) === null || _node$parent === void 0 ? void 0 : _node$parent.type) !== _utils.AST_NODE_TYPES.CallExpression || (0, _utils2.isTypeOfJestFnCall)(node.parent, context, ['test']);
-
       if (isTestFn) {
         count = 0;
       }
     };
-
     return {
       FunctionExpression: maybeResetCount,
       'FunctionExpression:exit': maybeResetCount,
       ArrowFunctionExpression: maybeResetCount,
       'ArrowFunctionExpression:exit': maybeResetCount,
-
       CallExpression(node) {
         var _jestFnCall$head$node;
-
         const jestFnCall = (0, _utils2.parseJestFnCall)(node, context);
-
         if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) !== 'expect' || ((_jestFnCall$head$node = jestFnCall.head.node.parent) === null || _jestFnCall$head$node === void 0 ? void 0 : _jestFnCall$head$node.type) === _utils.AST_NODE_TYPES.MemberExpression) {
           return;
         }
-
         count += 1;
-
         if (count > max) {
           context.report({
             node,
@@ -79,10 +66,7 @@ var _default = (0, _utils2.createRule)({
           });
         }
       }
-
     };
   }
-
 });
-
 exports.default = _default;

package/lib/rules/max-nested-describe.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");
-
 var _default = (0, _utils2.createRule)({
   name: __filename,
   meta: {
@@ -35,23 +32,18 @@ var _default = (0, _utils2.createRule)({
   defaultOptions: [{
     max: 5
   }],
-
   create(context, [{
     max
   }]) {
     const describeCallbackStack = [];
-
     function pushDescribeCallback(node) {
       const {
         parent
       } = node;
-
       if ((parent === null || parent === void 0 ? void 0 : parent.type) !== _utils.AST_NODE_TYPES.CallExpression || !(0, _utils2.isTypeOfJestFnCall)(parent, context, ['describe'])) {
         return;
       }
-
       describeCallbackStack.push(0);
-
       if (describeCallbackStack.length > max) {
         context.report({
           node: parent,
@@ -63,17 +55,14 @@ var _default = (0, _utils2.createRule)({
         });
       }
     }
-
     function popDescribeCallback(node) {
       const {
         parent
       } = node;
-
       if ((parent === null || parent === void 0 ? void 0 : parent.type) === _utils.AST_NODE_TYPES.CallExpression && (0, _utils2.isTypeOfJestFnCall)(parent, context, ['describe'])) {
         describeCallbackStack.pop();
       }
     }
-
     return {
       FunctionExpression: pushDescribeCallback,
       'FunctionExpression:exit': popDescribeCallback,
@@ -81,7 +70,5 @@ var _default = (0, _utils2.createRule)({
       'ArrowFunctionExpression:exit': popDescribeCallback
     };
   }
-
 });
-
 exports.default = _default;

package/lib/rules/no-alias-methods.js

@@ -4,16 +4,14 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _utils = require("./utils");
-
 var _default = (0, _utils.createRule)({
   name: __filename,
   meta: {
     docs: {
       category: 'Best Practices',
       description: 'Disallow alias methods',
-      recommended: false
+      recommended: 'error'
     },
     messages: {
       replaceAlias: `Replace {{ alias }}() with its canonical name of {{ canonical }}()`
@@ -23,7 +21,6 @@ var _default = (0, _utils.createRule)({
     schema: []
   },
   defaultOptions: [],
-
   create(context) {
     // map of jest matcher aliases & their canonical names
     const methodNames = {
@@ -42,16 +39,13 @@ var _default = (0, _utils.createRule)({
     return {
       CallExpression(node) {
         const jestFnCall = (0, _utils.parseJestFnCall)(node, context);
-
         if ((jestFnCall === null || jestFnCall === void 0 ? void 0 : jestFnCall.type) !== 'expect') {
           return;
         }
-
         const {
           matcher
         } = jestFnCall;
         const alias = (0, _utils.getAccessorValue)(matcher);
-
         if (alias in methodNames) {
           const canonical = methodNames[alias];
           context.report({
@@ -65,10 +59,7 @@ var _default = (0, _utils.createRule)({
           });
         }
       }
-
     };
   }
-
 });
-
 exports.default = _default;

package/lib/rules/no-commented-out-tests.js

@@ -4,13 +4,10 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _utils = require("./utils");
-
 function hasTests(node) {
   return /^\s*[xf]?(test|it|describe)(\.\w+|\[['"]\w+['"]\])?\s*\(/mu.test(node.value);
 }
-
 var _default = (0, _utils.createRule)({
   name: __filename,
   meta: {
@@ -26,30 +23,23 @@ var _default = (0, _utils.createRule)({
     type: 'suggestion'
   },
   defaultOptions: [],
-
   create(context) {
     const sourceCode = context.getSourceCode();
-
     function checkNode(node) {
       if (!hasTests(node)) {
         return;
       }
-
       context.report({
         messageId: 'commentedTests',
         node
       });
     }
-
     return {
       Program() {
         const comments = sourceCode.getAllComments();
         comments.forEach(checkNode);
       }
-
     };
   }
-
 });
-
 exports.default = _default;

package/lib/rules/no-conditional-expect.js

@@ -4,18 +4,14 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _utils = require("@typescript-eslint/utils");
-
 var _utils2 = require("./utils");
-
 const isCatchCall = node => node.callee.type === _utils.AST_NODE_TYPES.MemberExpression && (0, _utils2.isSupportedAccessor)(node.callee.property, 'catch');
-
 var _default = (0, _utils2.createRule)({
   name: __filename,
   meta: {
     docs: {
-      description: 'Prevent calling `expect` conditionally',
+      description: 'Disallow calling `expect` conditionally',
       category: 'Best Practices',
       recommended: 'error'
     },
@@ -26,48 +22,36 @@ var _default = (0, _utils2.createRule)({
     schema: []
   },
   defaultOptions: [],
-
   create(context) {
     let conditionalDepth = 0;
     let inTestCase = false;
     let inPromiseCatch = false;
-
     const increaseConditionalDepth = () => inTestCase && conditionalDepth++;
-
     const decreaseConditionalDepth = () => inTestCase && conditionalDepth--;
-
     return {
       FunctionDeclaration(node) {
         const declaredVariables = context.getDeclaredVariables(node);
         const testCallExpressions = (0, _utils2.getTestCallExpressionsFromDeclaredVariables)(declaredVariables, context);
-
         if (testCallExpressions.length > 0) {
           inTestCase = true;
         }
       },
-
       CallExpression(node) {
-        var _parseJestFnCall;
-
         const {
           type: jestFnCallType
-        } = (_parseJestFnCall = (0, _utils2.parseJestFnCall)(node, context)) !== null && _parseJestFnCall !== void 0 ? _parseJestFnCall : {};
-
+        } = (0, _utils2.parseJestFnCall)(node, context) ?? {};
         if (jestFnCallType === 'test') {
           inTestCase = true;
         }
-
         if (isCatchCall(node)) {
           inPromiseCatch = true;
         }
-
         if (inTestCase && jestFnCallType === 'expect' && conditionalDepth > 0) {
           context.report({
             messageId: 'conditionalExpect',
             node
           });
         }
-
         if (inPromiseCatch && jestFnCallType === 'expect') {
           context.report({
             messageId: 'conditionalExpect',
@@ -75,17 +59,14 @@ var _default = (0, _utils2.createRule)({
           });
         }
       },
-
       'CallExpression:exit'(node) {
         if ((0, _utils2.isTypeOfJestFnCall)(node, context, ['test'])) {
           inTestCase = false;
         }
-
         if (isCatchCall(node)) {
           inPromiseCatch = false;
         }
       },
-
       CatchClause: increaseConditionalDepth,
       'CatchClause:exit': decreaseConditionalDepth,
       IfStatement: increaseConditionalDepth,
@@ -98,7 +79,5 @@ var _default = (0, _utils2.createRule)({
       'LogicalExpression:exit': decreaseConditionalDepth
     };
   }
-
 });
-
 exports.default = _default;

package/lib/rules/no-conditional-in-test.js

@@ -4,9 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _utils = require("./utils");
-
 var _default = (0, _utils.createRule)({
   name: __filename,
   meta: {
@@ -22,10 +20,8 @@ var _default = (0, _utils.createRule)({
     schema: []
   },
   defaultOptions: [],
-
   create(context) {
     let inTestCase = false;
-
     const maybeReportConditional = node => {
       if (inTestCase) {
         context.report({
@@ -34,27 +30,22 @@ var _default = (0, _utils.createRule)({
         });
       }
     };
-
     return {
       CallExpression(node) {
         if ((0, _utils.isTypeOfJestFnCall)(node, context, ['test'])) {
           inTestCase = true;
         }
       },
-
       'CallExpression:exit'(node) {
         if ((0, _utils.isTypeOfJestFnCall)(node, context, ['test'])) {
           inTestCase = false;
         }
       },
-
       IfStatement: maybeReportConditional,
       SwitchStatement: maybeReportConditional,
       ConditionalExpression: maybeReportConditional,
       LogicalExpression: maybeReportConditional
     };
   }
-
 });
-
 exports.default = _default;