eslint-plugin-jest 23.17.1 → 23.18.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [23.18.0](https://github.com/jest-community/eslint-plugin-jest/compare/v23.17.1...v23.18.0) (2020-07-05)
+
+
+### Features
+
+* **valid-title:** support `mustMatch` & `mustNotMatch` options ([#608](https://github.com/jest-community/eslint-plugin-jest/issues/608)) ([4c7207e](https://github.com/jest-community/eslint-plugin-jest/commit/4c7207ebbb274f7b584225ad65ffb96a4328240e)), closes [#233](https://github.com/jest-community/eslint-plugin-jest/issues/233)
+
 ## [23.17.1](https://github.com/jest-community/eslint-plugin-jest/compare/v23.17.0...v23.17.1) (2020-06-23)
 
 

package/docs/rules/valid-title.md

@@ -152,9 +152,11 @@ describe('foo', () => {
 ## Options
 
 ```ts
-interface {
+interface Options {
   ignoreTypeOfDescribeName?: boolean;
   disallowedWords?: string[];
+  mustNotMatch?: Partial<Record<'describe' | 'test' | 'it', string>> | string;
+  mustMatch?: Partial<Record<'describe' | 'test' | 'it', string>> | string;
 }
 ```
 
@@ -172,7 +174,7 @@ Default: `[]`
 A string array of words that are not allowed to be used in test titles. Matching
 is not case-sensitive, and looks for complete words:
 
-Examples of **incorrect** code using `disallowedWords`:
+Examples of **incorrect** code when using `disallowedWords`:
 
 ```js
 // with disallowedWords: ['correct', 'all', 'every', 'properly']
@@ -190,3 +192,37 @@ it('correctly sets the value', () => {});
 test('that everything is as it should be', () => {});
 describe('the proper way to handle things', () => {});
 ```
+
+#### `mustMatch` & `mustNotMatch`
+
+Defaults: `{}`
+
+Allows enforcing that titles must match or must not match a given Regular
+Expression. An object can be provided to apply different Regular Expressions to
+specific Jest test function groups (`describe`, `test`, and `it`).
+
+Examples of **incorrect** code when using `mustMatch`:
+
+```js
+// with mustMatch: '$that'
+describe('the correct way to do things', () => {});
+fit('this there!', () => {});
+
+// with mustMatch: { test: '$that' }
+describe('the tests that will be run', () => {});
+test('the stuff works', () => {});
+xtest('errors that are thrown have messages', () => {});
+```
+
+Examples of **correct** code when using `mustMatch`:
+
+```js
+// with mustMatch: '$that'
+describe('that thing that needs to be done', () => {});
+fit('that this there!', () => {});
+
+// with mustMatch: { test: '$that' }
+describe('the tests that will be run', () => {});
+test('that the stuff works', () => {});
+xtest('that errors that thrown have messages', () => {});
+```

package/lib/index.js

@@ -32,45 +32,28 @@ interopRequireDefault(require(moduleName)).default;
 
 const rulesDir = (0, _path.join)(__dirname, 'rules');
 const excludedFiles = ['__tests__', 'utils'];
-const rules = (0, _fs.readdirSync)(rulesDir).map(rule => (0, _path.parse)(rule).name).filter(rule => !excludedFiles.includes(rule)).reduce((acc, curr) => Object.assign(acc, {
+const rules = (0, _fs.readdirSync)(rulesDir).map(rule => (0, _path.parse)(rule).name).filter(rule => !excludedFiles.includes(rule)).reduce((acc, curr) => _objectSpread(_objectSpread({}, acc), {}, {
   [curr]: importDefault((0, _path.join)(rulesDir, curr))
 }), {});
+const recommendedRules = Object.entries(rules).filter(([, rule]) => rule.meta.docs.recommended).reduce((acc, [name, rule]) => _objectSpread(_objectSpread({}, acc), {}, {
+  [`jest/${name}`]: rule.meta.docs.recommended
+}), {});
 const allRules = Object.keys(rules).reduce((rules, key) => _objectSpread(_objectSpread({}, rules), {}, {
   [`jest/${key}`]: 'error'
 }), {});
+
+const createConfig = rules => ({
+  plugins: ['jest'],
+  env: {
+    'jest/globals': true
+  },
+  rules
+});
+
 module.exports = {
   configs: {
-    all: {
-      plugins: ['jest'],
-      env: {
-        'jest/globals': true
-      },
-      rules: allRules
-    },
-    recommended: {
-      plugins: ['jest'],
-      env: {
-        'jest/globals': true
-      },
-      rules: {
-        'jest/expect-expect': 'warn',
-        'jest/no-commented-out-tests': 'warn',
-        'jest/no-disabled-tests': 'warn',
-        'jest/no-export': 'error',
-        'jest/no-focused-tests': 'error',
-        'jest/no-identical-title': 'error',
-        'jest/no-jest-import': 'error',
-        'jest/no-mocks-import': 'error',
-        'jest/no-jasmine-globals': 'warn',
-        'jest/no-standalone-expect': 'error',
-        'jest/no-test-callback': 'error',
-        'jest/no-test-prefixes': 'error',
-        'jest/no-try-expect': 'error',
-        'jest/valid-describe': 'error',
-        'jest/valid-expect': 'error',
-        'jest/valid-expect-in-promise': 'error'
-      }
-    },
+    all: createConfig(allRules),
+    recommended: createConfig(recommendedRules),
     style: {
       plugins: ['jest'],
       rules: {

package/lib/rules/expect-expect.js

@@ -34,7 +34,7 @@ var _default = (0, _utils.createRule)({
     docs: {
       category: 'Best Practices',
       description: 'Enforce assertion to be made in a test body',
-      recommended: false
+      recommended: 'warn'
     },
     messages: {
       noAssertions: 'Test has no assertions'

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

@@ -13,7 +13,7 @@ var _default = (0, _utils.createRule)({
     docs: {
       category: 'Best Practices',
       description: 'Disallow alias methods',
-      recommended: 'warn'
+      recommended: false
     },
     messages: {
       replaceAlias: `Replace {{ alias }}() with its canonical name of {{ canonical }}()`

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

@@ -17,7 +17,7 @@ var _default = (0, _utils.createRule)({
     docs: {
       category: 'Best Practices',
       description: 'Disallow commented out tests',
-      recommended: false
+      recommended: 'warn'
     },
     messages: {
       commentedTests: 'Some tests seem to be commented'

package/lib/rules/no-disabled-tests.js

@@ -13,7 +13,7 @@ var _default = (0, _utils.createRule)({
     docs: {
       category: 'Best Practices',
       description: 'Disallow disabled tests',
-      recommended: false
+      recommended: 'warn'
     },
     messages: {
       missingFunction: 'Test is missing function argument',

package/lib/rules/no-export.js

@@ -15,7 +15,7 @@ var _default = (0, _utils.createRule)({
     docs: {
       category: 'Best Practices',
       description: 'Prevent exporting from test files',
-      recommended: false
+      recommended: 'error'
     },
     messages: {
       unexpectedExport: `Do not export from a test file.`

package/lib/rules/no-focused-tests.js

@@ -26,7 +26,7 @@ var _default = (0, _utils.createRule)({
     docs: {
       category: 'Best Practices',
       description: 'Disallow focused tests',
-      recommended: false
+      recommended: 'error'
     },
     messages: {
       focusedTest: 'Unexpected focused test.'

package/lib/rules/no-jasmine-globals.js

@@ -15,7 +15,7 @@ var _default = (0, _utils.createRule)({
     docs: {
       category: 'Best Practices',
       description: 'Disallow Jasmine globals',
-      recommended: 'error'
+      recommended: 'warn'
     },
     messages: {
       illegalGlobal: 'Illegal usage of global `{{ global }}`, prefer `{{ replacement }}`',

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

@@ -46,7 +46,7 @@ var _default = (0, _utils.createRule)({
     docs: {
       category: 'Best Practices',
       description: 'Prevents expects that are outside of an it or test block.',
-      recommended: false
+      recommended: 'error'
     },
     messages: {
       unexpectedExpect: 'Expect must be inside of a test block.'

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

@@ -15,7 +15,7 @@ var _default = (0, _utils.createRule)({
     docs: {
       category: 'Best Practices',
       description: 'Avoid using a callback in asynchronous tests',
-      recommended: false,
+      recommended: 'error',
       suggestion: true
     },
     messages: {

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

@@ -13,7 +13,7 @@ var _default = (0, _utils.createRule)({
     docs: {
       description: 'Prefer using toThrow for exception tests',
       category: 'Best Practices',
-      recommended: false
+      recommended: 'error'
     },
     deprecated: true,
     replacedBy: ['no-conditional-expect'],

package/lib/rules/valid-describe.js

@@ -25,7 +25,7 @@ var _default = (0, _utils.createRule)({
     docs: {
       category: 'Possible Errors',
       description: 'Enforce valid `describe()` callback',
-      recommended: 'warn'
+      recommended: 'error'
     },
     messages: {
       nameAndCallback: 'Describe requires name and callback arguments',

package/lib/rules/valid-title.js

@@ -25,6 +25,23 @@ const doesBinaryExpressionContainStringNode = binaryExp => {
 
 const quoteStringValue = node => node.type === _experimentalUtils.AST_NODE_TYPES.TemplateLiteral ? `\`${node.quasis[0].value.raw}\`` : node.raw;
 
+const compileMatcherPatterns = matchers => {
+  if (typeof matchers === 'string') {
+    const matcher = new RegExp(matchers, 'u');
+    return {
+      describe: matcher,
+      test: matcher,
+      it: matcher
+    };
+  }
+
+  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
+  };
+};
+
 var _default = (0, _utils.createRule)({
   name: __filename,
   meta: {
@@ -38,7 +55,9 @@ var _default = (0, _utils.createRule)({
       emptyTitle: '{{ jestFunctionName }} should not have an empty title',
       duplicatePrefix: 'should not have duplicate prefix',
       accidentalSpace: 'should not have leading or trailing spaces',
-      disallowedWord: '"{{ word }}" is not allowed in test titles.'
+      disallowedWord: '"{{ word }}" is not allowed in test titles.',
+      mustNotMatch: '{{ jestFunctionName }} should not match {{ pattern }}',
+      mustMatch: '{{ jestFunctionName }} should match {{ pattern }}'
     },
     type: 'suggestion',
     schema: [{
@@ -53,6 +72,44 @@ var _default = (0, _utils.createRule)({
           items: {
             type: 'string'
           }
+        },
+        mustNotMatch: {
+          oneOf: [{
+            type: 'string'
+          }, {
+            type: 'object',
+            properties: {
+              describe: {
+                type: 'string'
+              },
+              test: {
+                type: 'string'
+              },
+              it: {
+                type: 'string'
+              }
+            },
+            additionalProperties: false
+          }]
+        },
+        mustMatch: {
+          oneOf: [{
+            type: 'string'
+          }, {
+            type: 'object',
+            properties: {
+              describe: {
+                type: 'string'
+              },
+              test: {
+                type: 'string'
+              },
+              it: {
+                type: 'string'
+              }
+            },
+            additionalProperties: false
+          }]
         }
       },
       additionalProperties: false
@@ -66,9 +123,13 @@ var _default = (0, _utils.createRule)({
 
   create(context, [{
     ignoreTypeOfDescribeName,
-    disallowedWords = []
+    disallowedWords = [],
+    mustNotMatch,
+    mustMatch
   }]) {
     const disallowedWordsRegexp = new RegExp(`\\b(${disallowedWords.join('|')})\\b`, 'iu');
+    const mustNotMatchPatterns = compileMatcherPatterns(mustNotMatch !== null && mustNotMatch !== void 0 ? mustNotMatch : {});
+    const mustMatchPatterns = compileMatcherPatterns(mustMatch !== null && mustMatch !== void 0 ? mustMatch : {});
     return {
       CallExpression(node) {
         if (!(0, _utils.isDescribe)(node) && !(0, _utils.isTestCase)(node)) {
@@ -142,6 +203,39 @@ var _default = (0, _utils.createRule)({
             fix: fixer => [fixer.replaceTextRange(argument.range, quoteStringValue(argument).replace(/^([`'"]).+? /u, '$1'))]
           });
         }
+
+        const [jestFunctionName] = nodeName.split('.');
+        const mustNotMatchPattern = mustNotMatchPatterns[jestFunctionName];
+
+        if (mustNotMatchPattern) {
+          if (mustNotMatchPattern.test(title)) {
+            context.report({
+              messageId: 'mustNotMatch',
+              node: argument,
+              data: {
+                jestFunctionName,
+                pattern: mustNotMatchPattern
+              }
+            });
+            return;
+          }
+        }
+
+        const mustMatchPattern = mustMatchPatterns[jestFunctionName];
+
+        if (mustMatchPattern) {
+          if (!mustMatchPattern.test(title)) {
+            context.report({
+              messageId: 'mustMatch',
+              node: argument,
+              data: {
+                jestFunctionName,
+                pattern: mustMatchPattern
+              }
+            });
+            return;
+          }
+        }
       }
 
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-jest",
-  "version": "23.17.1",
+  "version": "23.18.0",
   "description": "Eslint rules for Jest",
   "keywords": [
     "eslint",
@@ -23,10 +23,8 @@
     "build": "babel --extensions .js,.ts src --out-dir lib --copy-files",
     "postbuild": "rimraf lib/__tests__ lib/**/__tests__",
     "lint": "eslint . --ignore-pattern '!.eslintrc.js' --ext js,ts",
-    "prepare": "yarn build && yarn postbuild",
-    "prepublishOnly": "yarn build",
+    "prepack": "yarn build",
     "prettylint": "prettylint docs/**/*.md README.md package.json",
-    "pretest": "yarn build",
     "test": "jest",
     "tools:generate-rules-table": "ts-node -T tools/generate-rules-table",
     "typecheck": "tsc -p ."
@@ -120,7 +118,7 @@
     "eslint-plugin-prettier": "^3.0.0",
     "husky": "^3.0.9",
     "jest": "^25.2.0",
-    "jest-runner-eslint": "^0.9.0",
+    "jest-runner-eslint": "^0.10.0",
     "lint-staged": "^9.4.2",
     "prettier": "^1.19.1",
     "prettylint": "^1.0.0",