Consistently use shared settings in all rules

lo1tuma · Jul 31, 2020 · eae8586 · eae8586
1 parent a9c51b3
commit eae8586
Show file tree

Hide file tree

Showing 36 changed files with 507 additions and 443 deletions.
diff --git a/README.md b/README.md
@@ -20,9 +20,49 @@ Then add a reference to this plugin and selected rules in your eslint config:
 
 ```json
 {
-  "plugins": [
-    "mocha"
-  ],
+    "plugins": [
+        "mocha"
+    ]
+}
+```
+
+### Plugin Settings
+
+This plugin supports the following settings, which are used by multiple rules:
+
+* `additionalCustomNames`: This allows rules to check additional function names when looking for suites or test cases. This might be used with a custom Mocha extension, such as [`ember-mocha`](https://github.com/switchfly/ember-mocha)
+**Example:**
+
+```json
+{
+    "rules": {
+        "mocha/no-skipped-tests": "error",
+        "mocha/no-exclusive-tests": "error"
+    },
+    "settings": {
+        "mocha/additionalCustomNames": {
+            "suites": [
+                "describeModule"
+            ],
+            "suitesWithSkipModifier": [
+                "describeModule.skip",
+                "xdescribeModule"
+            ],
+            "exclusiveSuites": [
+                "describeModule.only"
+            ],
+            "testCases": [
+                "testModule"
+            ],
+            "testCasesWithSkipModifier": [
+                "testModule.customSkip",
+                "xtestModules"
+            ],
+            "exclusiveTestCases": [
+                "testModule.only"
+            ]
+        }
+    }
 }
 ```
 
@@ -34,9 +74,9 @@ Enable it with the extends option:
 
 ```json
 {
-  "extends": [
-    "plugin:mocha/recommended"
-  ],
+    "extends": [
+        "plugin:mocha/recommended"
+    ]
 }
 ```
 

diff --git a/docs/rules/no-exclusive-tests.md b/docs/rules/no-exclusive-tests.md
@@ -49,25 +49,6 @@ suite.skip("bar", function () {});
 test.skip("bar", function () {});
 ```
 
-## Settings
-
-This rule supports the following shared configuration setting:
-
-* `additionalTestFunctions`: An array of extra test functions to protect.  This might be used with a custom Mocha extension, such as [`ember-mocha`](https://github.com/switchfly/ember-mocha)
-
-```json
-{
-    "rules": {
-        "mocha/no-exclusive-tests": "error"
-    },
-    "settings": {
-       "mocha/additionalTestFunctions": [
-           "describeModule"
-       ]
-    }
-}
-```
-
 ## When Not To Use It
 
 * If you really want to execute only one test-suite or test-case because all other tests should not be executed, turn this rule off.

diff --git a/docs/rules/no-skipped-tests.md b/docs/rules/no-skipped-tests.md
@@ -42,28 +42,6 @@ suite.only("bar", function () {});
 test.only("bar", function () {});
 ```
 
-## Settings
-
-This rule supports the following shared configuration settings:
-
-* `additionalTestFunctions`: An array of extra test functions to protect.  This might be used with a custom Mocha extension, such as [`ember-mocha`](https://github.com/switchfly/ember-mocha)
-* `additionalXFunctions`: An array of extra x-function to protect
-
-```json
-{
-    "rules": {
-        "mocha/no-skipped-tests": "error"
-    },
-    "settings": {
-       "mocha/additionalTestFunctions": [
-           "describeModule"
-       ],
-       "mocha/additionalXFunctions": [
-           "xdescribeModule"
-       ]
-    }
-}
-```
 ## When Not To Use It
 
 * If you really want to commit skipped tests to your repo, turn this rule off.

diff --git a/lib/rules/handle-done-callback.js b/lib/rules/handle-done-callback.js
@@ -1,7 +1,7 @@
 'use strict';
 
 const find = require('ramda/src/find');
-const astUtils = require('../util/ast');
+const createAstUtils = require('../util/ast');
 
 module.exports = {
     meta: {
@@ -23,8 +23,8 @@ module.exports = {
         ]
     },
     create(context) {
-        const [ config = {} ] = context.options;
-        const { ignoreSkipped = false } = config;
+        const astUtils = createAstUtils(context.settings);
+        const [ { ignoreSkipped = false } = {} ] = context.options;
         const modifiersToCheck = ignoreSkipped ? [ 'only' ] : [ 'only', 'skip' ];
 
         function isAsyncFunction(functionExpression) {

diff --git a/lib/rules/max-top-level-suites.js b/lib/rules/max-top-level-suites.js
@@ -6,8 +6,7 @@
  */
 
 const isNil = require('ramda/src/isNil');
-const astUtil = require('../util/ast');
-const { additionalSuiteNames } = require('../util/settings');
+const createAstUtils = require('../util/ast');
 
 const defaultSuiteLimit = 1;
 
@@ -34,9 +33,9 @@ module.exports = {
         ]
     },
     create(context) {
+        const astUtils = createAstUtils(context.settings);
         const topLevelDescribes = [];
         const options = context.options[0] || {};
-        const settings = context.settings;
         let suiteLimit;
 
         if (isNil(options.limit)) {
@@ -47,7 +46,7 @@ module.exports = {
 
         return {
             CallExpression(node) {
-                if (astUtil.isDescribe(node, additionalSuiteNames(settings))) {
+                if (astUtils.isDescribe(node)) {
                     const scope = context.getScope();
 
                     if (isTopLevelScope(scope)) {

diff --git a/lib/rules/no-async-describe.js b/lib/rules/no-async-describe.js
@@ -6,8 +6,7 @@
  * @fileoverview Disallow async functions as arguments to describe
  */
 
-const astUtils = require('../util/ast');
-const { additionalSuiteNames } = require('../util/settings');
+const createAstUtils = require('../util/ast');
 
 module.exports = {
     meta: {
@@ -18,6 +17,7 @@ module.exports = {
         fixable: 'code'
     },
     create(context) {
+        const astUtils = createAstUtils(context.settings);
         const sourceCode = context.getSourceCode();
 
         function isFunction(node) {
@@ -62,7 +62,7 @@ module.exports = {
             CallExpression(node) {
                 const name = astUtils.getNodeName(node.callee);
 
-                if (astUtils.isDescribe(node, additionalSuiteNames(context.settings))) {
+                if (astUtils.isDescribe(node)) {
                     const fnArg = node.arguments.slice(-1)[0];
                     if (isAsyncFunction(fnArg)) {
                         context.report({

diff --git a/lib/rules/no-exclusive-tests.js b/lib/rules/no-exclusive-tests.js
@@ -1,7 +1,6 @@
 'use strict';
 
-const { getAdditionalTestFunctions } = require('../util/settings');
-const astUtils = require('../util/ast');
+const createAstUtils = require('../util/ast');
 
 module.exports = {
     meta: {
@@ -11,40 +10,15 @@ module.exports = {
         }
     },
     create(context) {
-        let mochaTestFunctions = [
-            'it',
-            'describe',
-            'suite',
-            'test',
-            'context',
-            'specify'
-        ];
-        const settings = context.settings;
-        const additionalTestFunctions = getAdditionalTestFunctions(settings);
-
-        mochaTestFunctions = mochaTestFunctions.concat(additionalTestFunctions);
-
-        function matchesMochaTestFunction(object) {
-            const name = astUtils.getNodeName(object);
-
-            return mochaTestFunctions.includes(name);
-        }
-
-        function isPropertyNamedOnly(property) {
-            return property && astUtils.getPropertyName(property) === 'only';
-        }
-
-        function isCallToMochasOnlyFunction(callee) {
-            return callee.type === 'MemberExpression' &&
-                matchesMochaTestFunction(callee.object) &&
-                isPropertyNamedOnly(callee.property);
-        }
+        const astUtils = createAstUtils(context.settings);
 
         return {
             CallExpression(node) {
-                const callee = node.callee;
+                const options = { modifiers: [ 'only' ], baseNames: false };
+
+                if (astUtils.isDescribe(node, options) || astUtils.isTestCase(node, options)) {
+                    const callee = node.callee;
 
-                if (callee && isCallToMochasOnlyFunction(callee)) {
                     context.report({
                         node: callee.property,
                         message: 'Unexpected exclusive mocha test.'

diff --git a/lib/rules/no-global-tests.js b/lib/rules/no-global-tests.js
@@ -1,6 +1,6 @@
 'use strict';
 
-const astUtils = require('../util/ast');
+const createAstUtils = require('../util/ast');
 
 module.exports = {
     meta: {
@@ -10,6 +10,8 @@ module.exports = {
         }
     },
     create(context) {
+        const astUtils = createAstUtils(context.settings);
+
         function isGlobalScope(scope) {
             return scope.type === 'global' || scope.type === 'module';
         }

diff --git a/lib/rules/no-hooks-for-single-case.js b/lib/rules/no-hooks-for-single-case.js
@@ -1,7 +1,6 @@
 'use strict';
 
-const astUtil = require('../util/ast');
-const { additionalSuiteNames } = require('../util/settings');
+const createAstUtils = require('../util/ast');
 
 function newDescribeLayer(describeNode) {
     return {
@@ -32,9 +31,9 @@ module.exports = {
         ]
     },
     create(context) {
+        const astUtils = createAstUtils(context.settings);
         const options = context.options[0] || {};
         const allowedHooks = options.allow || [];
-        const settings = context.settings;
         let layers = [];
 
         function increaseTestCount() {
@@ -72,17 +71,17 @@ module.exports = {
             },
 
             CallExpression(node) {
-                if (astUtil.isDescribe(node, additionalSuiteNames(settings))) {
+                if (astUtils.isDescribe(node)) {
                     increaseTestCount();
                     layers.push(newDescribeLayer(node));
                     return;
                 }
 
-                if (astUtil.isTestCase(node)) {
+                if (astUtils.isTestCase(node)) {
                     increaseTestCount();
                 }
 
-                if (astUtil.isHookIdentifier(node.callee)) {
+                if (astUtils.isHookIdentifier(node.callee)) {
                     layers[layers.length - 1].hookNodes.push(node.callee);
                 }
             },

diff --git a/lib/rules/no-hooks.js b/lib/rules/no-hooks.js
@@ -1,6 +1,6 @@
 'use strict';
 
-const astUtil = require('../util/ast');
+const createAstUtils = require('../util/ast');
 
 module.exports = {
     meta: {
@@ -25,14 +25,15 @@ module.exports = {
     },
 
     create(context) {
+        const astUtils = createAstUtils(context.settings);
         const [ config = {} ] = context.options;
         const { allow = [] } = config;
 
         return {
             CallExpression(node) {
                 const isHookAllowed = allow.includes(node.callee.name);
 
-                if (astUtil.isHookIdentifier(node.callee) && !isHookAllowed) {
+                if (astUtils.isHookIdentifier(node.callee) && !isHookAllowed) {
                     context.report({
                         node: node.callee,
                         message: `Unexpected use of Mocha \`${ node.callee.name }\` hook`