eslint-plugin-jest 23.6.0 → 23.7.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [23.7.0](https://github.com/jest-community/eslint-plugin-jest/compare/v23.6.0...v23.7.0) (2020-02-07)
+
+### Bug Fixes
+
+- **expect-expect:** use `u` flag in regex
+  ([#532](https://github.com/jest-community/eslint-plugin-jest/issues/532))
+  ([c12b725](https://github.com/jest-community/eslint-plugin-jest/commit/c12b7251ef1506073d268973b93c7fc9fbcf50af))
+
+### Features
+
+- **valid-title:** support `disallowedWords` option
+  ([#522](https://github.com/jest-community/eslint-plugin-jest/issues/522))
+  ([38bbe93](https://github.com/jest-community/eslint-plugin-jest/commit/38bbe93794ed456c6e9e5d7be848b2aeb55ce0ba))
+
 # [23.6.0](https://github.com/jest-community/eslint-plugin-jest/compare/v23.5.0...v23.6.0) (2020-01-12)
 
 ### Features

package/README.md

@@ -1,6 +1,3 @@
-[![Actions Status](https://github.com/jest-community/eslint-plugin-jest/workflows/Unit%20tests/badge.svg)](https://github.com/jest-community/eslint-plugin-jest/actions)
-[![Renovate badge](https://badges.renovateapi.com/github/jest-community/eslint-plugin-jest)](https://renovatebot.com/)
-
 <div align="center">
   <a href="https://eslint.org/">
     <img width="150" height="150" src="https://eslint.org/assets/img/logo.svg">
@@ -12,6 +9,9 @@
   <p>ESLint plugin for Jest</p>
 </div>
 
+[![Actions Status](https://github.com/jest-community/eslint-plugin-jest/workflows/Unit%20tests/badge.svg?branch=master)](https://github.com/jest-community/eslint-plugin-jest/actions)
+[![Renovate badge](https://badges.renovateapi.com/github/jest-community/eslint-plugin-jest)](https://renovatebot.com/)
+
 ## Installation
 
 ```

package/docs/rules/expect-expect.md

@@ -43,8 +43,8 @@ it('should work with callbacks/async', () => {
 ### `assertFunctionNames`
 
 This array option whitelists the assertion function names to look for. Function
-names can be a glob pattern like `request.*.expect` (see
-[micromatch](https://github.com/micromatch/micromatch) for syntax)
+names can use wildcards like `request.*.expect`, `request.**.expect`,
+`request.*.expect*`
 
 Examples of **incorrect** code for the `{ "assertFunctionNames": ["expect"] }`
 option:

package/docs/rules/valid-title.md

@@ -45,7 +45,7 @@ xtest('foo', () => {});
 
 Titles for test blocks should always be a string literal or expression.
 
-This is also applied to describe blocks by default, but can be turned off via
+This is also applied to `describe` blocks by default, but can be turned off via
 the `ignoreTypeOfDescribeName` option:
 
 Examples of **incorrect** code for this rule:
@@ -87,7 +87,7 @@ describe(6, function() {});
 
 **duplicatePrefix**
 
-A describe/ test block should not start with duplicatePrefix
+A `describe` / `test` block should not start with `duplicatePrefix`
 
 Examples of **incorrect** code for this rule
 
@@ -117,7 +117,7 @@ describe('foo', () => {
 
 **accidentalSpace**
 
-A describe/ test block should not contain accidentalSpace
+A `describe` / `test` block should not contain accidentalSpace
 
 Examples of **incorrect** code for this rule
 
@@ -148,3 +148,45 @@ describe('foo', () => {
   test('bar', () => {});
 });
 ```
+
+## Options
+
+```ts
+interface {
+  ignoreTypeOfDescribeName?: boolean;
+  disallowedWords?: string[];
+}
+```
+
+#### `ignoreTypeOfDescribeName`
+
+Default: `false`
+
+When enabled, the type of the first argument to `describe` blocks won't be
+checked.
+
+#### `disallowedWords`
+
+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`:
+
+```js
+// with disallowedWords: ['correct', 'all', 'every', 'properly']
+describe('the correct way to do things', () => {});
+it('has ALL the things', () => {});
+xdescribe('every single one of them', () => {});
+test(`that the value is set properly`, () => {});
+```
+
+Examples of **correct** code when using `disallowedWords`:
+
+```js
+// with disallowedWords: ['correct', 'all', 'every', 'properly']
+it('correctly sets the value', () => {});
+test('that everything is as it should be', () => {});
+describe('the proper way to handle things', () => {});
+```

package/lib/rules/expect-expect.js

@@ -7,16 +7,27 @@ exports.default = void 0;
 
 var _experimentalUtils = require("@typescript-eslint/experimental-utils");
 
-var _micromatch = _interopRequireDefault(require("micromatch"));
-
 var _utils = require("./utils");
 
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /*
  * This implementation is adapted from eslint-plugin-jasmine.
  * MIT license, Remco Haszing.
  */
+
+/**
+ * Checks if node names returned by getNodeName matches any of the given star patterns
+ * Pattern examples:
+ *   request.*.expect
+ *   request.**.expect
+ *   request.**.expect*
+ */
+function matchesAssertFunctionName(nodeName, patterns) {
+  return patterns.some(p => new RegExp(`^${p.split('.').map(x => {
+    if (x === '**') return '[a-z\\.]*';
+    return x.replace(/\*/gu, '[a-z]*');
+  }).join('\\.')}(\\.|$)`, 'ui').test(nodeName));
+}
+
 var _default = (0, _utils.createRule)({
   name: __filename,
   meta: {
@@ -74,7 +85,7 @@ var _default = (0, _utils.createRule)({
 
         if (name === _utils.TestCaseName.it || name === _utils.TestCaseName.test) {
           unchecked.push(node);
-        } else if (name && _micromatch.default.isMatch(name, assertFunctionNames)) {
+        } else if (name && matchesAssertFunctionName(name, assertFunctionNames)) {
           // Return early in case of nested `it` statements.
           checkCallExpressionUsed(context.getAncestors());
         }

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

@@ -8,7 +8,7 @@ exports.default = void 0;
 var _utils = require("./utils");
 
 function hasTests(node) {
-  return /^\s*[xf]?(test|it|describe)(\.\w+|\[['"]\w+['"]\])?\s*\(/m.test(node.value);
+  return /^\s*[xf]?(test|it|describe)(\.\w+|\[['"]\w+['"]\])?\s*\(/mu.test(node.value);
 }
 
 var _default = (0, _utils.createRule)({

package/lib/rules/no-export.js

@@ -63,7 +63,7 @@ var _default = (0, _utils.createRule)({
           } = object);
         }
 
-        if ('name' in object && object.name === 'module' && property.type === _experimentalUtils.AST_NODE_TYPES.Identifier && /^exports?$/.test(property.name)) {
+        if ('name' in object && object.name === 'module' && property.type === _experimentalUtils.AST_NODE_TYPES.Identifier && /^exports?$/u.test(property.name)) {
           exportNodes.push(node);
         }
       }

package/lib/rules/valid-title.js

@@ -23,6 +23,8 @@ const doesBinaryExpressionContainStringNode = binaryExp => {
   return (0, _utils.isStringNode)(binaryExp.left);
 };
 
+const quoteStringValue = node => node.type === _experimentalUtils.AST_NODE_TYPES.TemplateLiteral ? `\`${node.quasis[0].value.raw}\`` : node.raw;
+
 var _default = (0, _utils.createRule)({
   name: __filename,
   meta: {
@@ -35,7 +37,8 @@ var _default = (0, _utils.createRule)({
       titleMustBeString: 'Title must be a string',
       emptyTitle: '{{ jestFunctionName }} should not have an empty title',
       duplicatePrefix: 'should not have duplicate prefix',
-      accidentalSpace: 'should not have leading or trailing spaces'
+      accidentalSpace: 'should not have leading or trailing spaces',
+      disallowedWord: '"{{ word }}" is not allowed in test titles.'
     },
     type: 'suggestion',
     schema: [{
@@ -44,6 +47,13 @@ var _default = (0, _utils.createRule)({
         ignoreTypeOfDescribeName: {
           type: 'boolean',
           default: false
+        },
+        disallowedWords: {
+          type: 'array',
+          items: {
+            type: 'string'
+          },
+          default: []
         }
       },
       additionalProperties: false
@@ -51,12 +61,15 @@ var _default = (0, _utils.createRule)({
     fixable: 'code'
   },
   defaultOptions: [{
-    ignoreTypeOfDescribeName: false
+    ignoreTypeOfDescribeName: false,
+    disallowedWords: []
   }],
 
   create(context, [{
-    ignoreTypeOfDescribeName
+    ignoreTypeOfDescribeName,
+    disallowedWords
   }]) {
+    const disallowedWordsRegexp = new RegExp(`\\b(${disallowedWords.join('|')})\\b`, 'iu');
     return {
       CallExpression(node) {
         if (!((0, _utils.isDescribe)(node) || (0, _utils.isTestCase)(node)) || !node.arguments.length) {
@@ -93,16 +106,26 @@ var _default = (0, _utils.createRule)({
           return;
         }
 
+        if (disallowedWords.length > 0) {
+          const disallowedMatch = disallowedWordsRegexp.exec(title);
+
+          if (disallowedMatch) {
+            context.report({
+              data: {
+                word: disallowedMatch[1]
+              },
+              messageId: 'disallowedWord',
+              node: argument
+            });
+            return;
+          }
+        }
+
         if (title.trim().length !== title.length) {
           context.report({
             messageId: 'accidentalSpace',
             node: argument,
-
-            fix(fixer) {
-              const stringValue = argument.type === _experimentalUtils.AST_NODE_TYPES.TemplateLiteral ? `\`${argument.quasis[0].value.raw}\`` : argument.raw;
-              return [fixer.replaceTextRange(argument.range, stringValue.replace(/^([`'"]) +?/, '$1').replace(/ +?([`'"])$/, '$1'))];
-            }
-
+            fix: fixer => [fixer.replaceTextRange(argument.range, quoteStringValue(argument).replace(/^([`'"]) +?/u, '$1').replace(/ +?([`'"])$/u, '$1'))]
           });
         }
 
@@ -113,12 +136,7 @@ var _default = (0, _utils.createRule)({
           context.report({
             messageId: 'duplicatePrefix',
             node: argument,
-
-            fix(fixer) {
-              const stringValue = argument.type === _experimentalUtils.AST_NODE_TYPES.TemplateLiteral ? `\`${argument.quasis[0].value.raw}\`` : argument.raw;
-              return [fixer.replaceTextRange(argument.range, stringValue.replace(/^([`'"]).+? /, '$1'))];
-            }
-
+            fix: fixer => [fixer.replaceTextRange(argument.range, quoteStringValue(argument).replace(/^([`'"]).+? /u, '$1'))]
           });
         }
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-jest",
-  "version": "23.6.0",
+  "version": "23.7.0",
   "description": "Eslint rules for Jest",
   "repository": "jest-community/eslint-plugin-jest",
   "license": "MIT",
@@ -37,8 +37,7 @@
     "typecheck": "tsc -p ."
   },
   "dependencies": {
-    "@typescript-eslint/experimental-utils": "^2.5.0",
-    "micromatch": "^4.0.2"
+    "@typescript-eslint/experimental-utils": "^2.5.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.4.4",
@@ -51,7 +50,6 @@
     "@semantic-release/git": "^7.0.17",
     "@types/eslint": "^6.1.3",
     "@types/jest": "^24.0.15",
-    "@types/micromatch": "^4.0.0",
     "@types/node": "^12.6.6",
     "@typescript-eslint/eslint-plugin": "^2.5.0",
     "@typescript-eslint/parser": "^2.5.0",