eslint-plugin-jest 24.4.2 → 26.1.0

package/lib/rules/valid-title.js

@@ -5,44 +5,59 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 
-var _experimentalUtils = require("@typescript-eslint/experimental-utils");
+var _utils = require("@typescript-eslint/utils");
 
-var _utils = require("./utils");
+var _utils2 = require("./utils");
 
 const trimFXprefix = word => ['f', 'x'].includes(word.charAt(0)) ? word.substr(1) : word;
 
 const doesBinaryExpressionContainStringNode = binaryExp => {
-  if ((0, _utils.isStringNode)(binaryExp.right)) {
+  if ((0, _utils2.isStringNode)(binaryExp.right)) {
     return true;
   }
 
-  if (binaryExp.left.type === _experimentalUtils.AST_NODE_TYPES.BinaryExpression) {
+  if (binaryExp.left.type === _utils.AST_NODE_TYPES.BinaryExpression) {
     return doesBinaryExpressionContainStringNode(binaryExp.left);
   }
 
-  return (0, _utils.isStringNode)(binaryExp.left);
+  return (0, _utils2.isStringNode)(binaryExp.left);
 };
 
-const quoteStringValue = node => node.type === _experimentalUtils.AST_NODE_TYPES.TemplateLiteral ? `\`${node.quasis[0].value.raw}\`` : node.raw;
+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') {
-    const matcher = new RegExp(matchers, 'u');
+  if (typeof matchers === 'string' || Array.isArray(matchers)) {
+    const compiledMatcher = compileMatcherPattern(matchers);
     return {
-      describe: matcher,
-      test: matcher,
-      it: matcher
+      describe: compiledMatcher,
+      test: compiledMatcher,
+      it: compiledMatcher
     };
   }
 
   return {
-    describe: matchers.describe ? new RegExp(matchers.describe, 'u') : null,
-    test: matchers.test ? new RegExp(matchers.test, 'u') : null,
-    it: matchers.it ? new RegExp(matchers.it, 'u') : null
+    describe: matchers.describe ? compileMatcherPattern(matchers.describe) : null,
+    test: matchers.test ? compileMatcherPattern(matchers.test) : null,
+    it: matchers.it ? compileMatcherPattern(matchers.it) : null
   };
 };
 
-var _default = (0, _utils.createRule)({
+const MatcherAndMessageSchema = {
+  type: 'array',
+  items: {
+    type: 'string'
+  },
+  minItems: 1,
+  maxItems: 2,
+  additionalItems: false
+};
+
+var _default = (0, _utils2.createRule)({
   name: __filename,
   meta: {
     docs: {
@@ -57,7 +72,9 @@ var _default = (0, _utils.createRule)({
       accidentalSpace: 'should not have leading or trailing spaces',
       disallowedWord: '"{{ word }}" is not allowed in test titles.',
       mustNotMatch: '{{ jestFunctionName }} should not match {{ pattern }}',
-      mustMatch: '{{ jestFunctionName }} should match {{ pattern }}'
+      mustMatch: '{{ jestFunctionName }} should match {{ pattern }}',
+      mustNotMatchCustom: '{{ message }}',
+      mustMatchCustom: '{{ message }}'
     },
     type: 'suggestion',
     schema: [{
@@ -72,43 +89,22 @@ var _default = (0, _utils.createRule)({
           items: {
             type: 'string'
           }
-        },
-        mustNotMatch: {
+        }
+      },
+      patternProperties: {
+        [/^must(?:Not)?Match$/u.source]: {
           oneOf: [{
             type: 'string'
-          }, {
+          }, MatcherAndMessageSchema, {
             type: 'object',
-            properties: {
-              describe: {
-                type: 'string'
-              },
-              test: {
-                type: 'string'
-              },
-              it: {
-                type: 'string'
-              }
+            propertyNames: {
+              enum: ['describe', 'test', 'it']
             },
-            additionalProperties: false
-          }]
-        },
-        mustMatch: {
-          oneOf: [{
-            type: 'string'
-          }, {
-            type: 'object',
-            properties: {
-              describe: {
+            additionalProperties: {
+              oneOf: [{
                 type: 'string'
-              },
-              test: {
-                type: 'string'
-              },
-              it: {
-                type: 'string'
-              }
-            },
-            additionalProperties: false
+              }, MatcherAndMessageSchema]
+            }
           }]
         }
       },
@@ -132,7 +128,9 @@ var _default = (0, _utils.createRule)({
     const mustMatchPatterns = compileMatcherPatterns(mustMatch !== null && mustMatch !== void 0 ? mustMatch : {});
     return {
       CallExpression(node) {
-        if (!(0, _utils.isDescribeCall)(node) && !(0, _utils.isTestCaseCall)(node)) {
+        var _mustNotMatchPatterns, _mustMatchPatterns$je;
+
+        if (!(0, _utils2.isDescribeCall)(node) && !(0, _utils2.isTestCaseCall)(node)) {
           return;
         }
 
@@ -142,12 +140,12 @@ var _default = (0, _utils.createRule)({
           return;
         }
 
-        if (!(0, _utils.isStringNode)(argument)) {
-          if (argument.type === _experimentalUtils.AST_NODE_TYPES.BinaryExpression && doesBinaryExpressionContainStringNode(argument)) {
+        if (!(0, _utils2.isStringNode)(argument)) {
+          if (argument.type === _utils.AST_NODE_TYPES.BinaryExpression && doesBinaryExpressionContainStringNode(argument)) {
             return;
           }
 
-          if (argument.type !== _experimentalUtils.AST_NODE_TYPES.TemplateLiteral && !(ignoreTypeOfDescribeName && (0, _utils.isDescribeCall)(node))) {
+          if (argument.type !== _utils.AST_NODE_TYPES.TemplateLiteral && !(ignoreTypeOfDescribeName && (0, _utils2.isDescribeCall)(node))) {
             context.report({
               messageId: 'titleMustBeString',
               loc: argument.loc
@@ -157,13 +155,13 @@ var _default = (0, _utils.createRule)({
           return;
         }
 
-        const title = (0, _utils.getStringValue)(argument);
+        const title = (0, _utils2.getStringValue)(argument);
 
         if (!title) {
           context.report({
             messageId: 'emptyTitle',
             data: {
-              jestFunctionName: (0, _utils.isDescribeCall)(node) ? _utils.DescribeAlias.describe : _utils.TestCaseName.test
+              jestFunctionName: (0, _utils2.isDescribeCall)(node) ? _utils2.DescribeAlias.describe : _utils2.TestCaseName.test
             },
             node
           });
@@ -193,7 +191,7 @@ var _default = (0, _utils.createRule)({
           });
         }
 
-        const nodeName = trimFXprefix((0, _utils.getNodeName)(node));
+        const nodeName = trimFXprefix((0, _utils2.getNodeName)(node));
         const [firstWord] = title.split(' ');
 
         if (firstWord.toLowerCase() === nodeName) {
@@ -205,32 +203,34 @@ var _default = (0, _utils.createRule)({
         }
 
         const [jestFunctionName] = nodeName.split('.');
-        const mustNotMatchPattern = mustNotMatchPatterns[jestFunctionName];
+        const [mustNotMatchPattern, mustNotMatchMessage] = (_mustNotMatchPatterns = mustNotMatchPatterns[jestFunctionName]) !== null && _mustNotMatchPatterns !== void 0 ? _mustNotMatchPatterns : [];
 
         if (mustNotMatchPattern) {
           if (mustNotMatchPattern.test(title)) {
             context.report({
-              messageId: 'mustNotMatch',
+              messageId: mustNotMatchMessage ? 'mustNotMatchCustom' : 'mustNotMatch',
               node: argument,
               data: {
                 jestFunctionName,
-                pattern: mustNotMatchPattern
+                pattern: mustNotMatchPattern,
+                message: mustNotMatchMessage
               }
             });
             return;
           }
         }
 
-        const mustMatchPattern = mustMatchPatterns[jestFunctionName];
+        const [mustMatchPattern, mustMatchMessage] = (_mustMatchPatterns$je = mustMatchPatterns[jestFunctionName]) !== null && _mustMatchPatterns$je !== void 0 ? _mustMatchPatterns$je : [];
 
         if (mustMatchPattern) {
           if (!mustMatchPattern.test(title)) {
             context.report({
-              messageId: 'mustMatch',
+              messageId: mustMatchMessage ? 'mustMatchCustom' : 'mustMatch',
               node: argument,
               data: {
                 jestFunctionName,
-                pattern: mustMatchPattern
+                pattern: mustMatchPattern,
+                message: mustMatchMessage
               }
             });
             return;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "eslint-plugin-jest",
-  "version": "24.4.2",
-  "description": "Eslint rules for Jest",
+  "version": "26.1.0",
+  "description": "ESLint rules for Jest",
   "keywords": [
     "eslint",
     "eslintplugin",
@@ -60,10 +60,13 @@
     "projects": [
       {
         "displayName": "test",
-        "testEnvironment": "node",
+        "moduleNameMapper": {
+          "eslint/use-at-your-own-risk": "eslint/lib/unsupported-api.js"
+        },
         "testPathIgnorePatterns": [
           "<rootDir>/lib/.*",
-          "<rootDir>/src/rules/__tests__/fixtures/*"
+          "<rootDir>/src/rules/__tests__/fixtures/*",
+          "<rootDir>/src/rules/__tests__/test-utils.ts"
         ]
       },
       {
@@ -79,60 +82,64 @@
     ]
   },
   "dependencies": {
-    "@typescript-eslint/experimental-utils": "^4.0.1"
+    "@typescript-eslint/utils": "^5.10.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.4.4",
     "@babel/core": "^7.4.4",
     "@babel/preset-env": "^7.4.4",
     "@babel/preset-typescript": "^7.3.3",
-    "@commitlint/cli": "^12.0.0",
-    "@commitlint/config-conventional": "^12.0.0",
+    "@commitlint/cli": "^16.0.0",
+    "@commitlint/config-conventional": "^16.0.0",
     "@schemastore/package": "^0.0.6",
-    "@semantic-release/changelog": "^5.0.1",
-    "@semantic-release/git": "^9.0.0",
+    "@semantic-release/changelog": "^6.0.0",
+    "@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": "^4.0.1",
-    "@typescript-eslint/parser": "^4.0.1",
+    "@typescript-eslint/eslint-plugin": "^5.0.0",
+    "@typescript-eslint/parser": "^5.0.0",
     "babel-jest": "^27.0.0",
     "babel-plugin-replace-ts-export-assignment": "^0.0.2",
     "dedent": "^0.7.0",
-    "eslint": "^5.1.0 || ^6.0.0 || ^7.0.0",
-    "eslint-config-prettier": "^6.5.0",
+    "eslint": "^6.0.0 || ^7.0.0 || ^8.0.0",
+    "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-eslint-comments": "^3.1.2",
     "eslint-plugin-eslint-config": "^2.0.0",
-    "eslint-plugin-eslint-plugin": "^2.0.0",
-    "eslint-plugin-import": "^2.20.2",
+    "eslint-plugin-eslint-plugin": "^4.0.1",
+    "eslint-plugin-import": "^2.25.1",
     "eslint-plugin-node": "^11.0.0",
-    "eslint-plugin-prettier": "^3.0.0",
-    "husky": "^6.0.0",
+    "eslint-plugin-prettier": "^3.4.1",
+    "eslint-remote-tester": "^2.1.0",
+    "eslint-remote-tester-repositories": "^0.0.4",
+    "husky": "^7.0.2",
     "is-ci": "^3.0.0",
     "jest": "^27.0.0",
-    "jest-runner-eslint": "^0.10.0",
-    "lint-staged": "^10.2.2",
+    "jest-runner-eslint": "^1.0.0",
+    "lint-staged": "^12.0.0",
     "pinst": "^2.0.0",
     "prettier": "^2.0.5",
-    "resolve-from": "^5.0.0",
     "rimraf": "^3.0.0",
-    "semantic-release": "^17.0.7",
+    "semantic-release": "^19.0.0",
     "semver": "^7.3.5",
-    "ts-node": "^9.0.0",
+    "ts-node": "^10.2.1",
     "typescript": "^4.4.0"
   },
   "peerDependencies": {
-    "@typescript-eslint/eslint-plugin": ">= 4",
-    "eslint": ">=5"
+    "@typescript-eslint/eslint-plugin": "^5.0.0",
+    "eslint": "^6.0.0 || ^7.0.0 || ^8.0.0"
   },
   "peerDependenciesMeta": {
     "@typescript-eslint/eslint-plugin": {
       "optional": true
+    },
+    "jest": {
+      "optional": true
     }
   },
   "engines": {
-    "node": ">=10"
+    "node": "^12.13.0 || ^14.15.0 || >=16.0.0"
   },
   "release": {
     "branches": [
@@ -150,5 +157,11 @@
       "@semantic-release/git",
       "@semantic-release/github"
     ]
-  }
+  },
+  "resolutions": {
+    "@semantic-release/npm/npm": "7.20.6",
+    "@typescript-eslint/experimental-utils": "^5.0.0",
+    "fsevents/node-gyp": "^7.0.0"
+  },
+  "packageManager": "yarn@3.1.1"
 }