.github/workflows/ci.yml

@@ -25,6 +25,10 @@ jobs:
                   github-token: ${{ secrets.GITHUB_TOKEN }}
                   path-to-lcov: ./build/lcov.info
                   parallel: true
+    coverage:
+        needs: build
+        runs-on: ubuntu-latest
+        steps:
             - name: Coveralls Finished
               uses: coverallsapp/github-action@master
               with:

CHANGELOG.md

@@ -1,3 +1,35 @@
+## 6.3.0 (February 19, 2020)
+
+### Bug Fixes
+
+* no-hooks-for-single-case: fix false postive in nested suites ([#238](https://github.com/lo1tuma/eslint-plugin-mocha/pull/238))
+* Fix max-top-level-suites to ignore generated suites ([#239](https://github.com/lo1tuma/eslint-plugin-mocha/pull/239))
+* Check static template strings in valid-test-description and valid-suite-description ([#237](https://github.com/lo1tuma/eslint-plugin-mocha/pull/237))
+
+### Enhancements
+
+* no-hooks: add option to allow certain kind of hooks ([#236](https://github.com/lo1tuma/eslint-plugin-mocha/pull/236))
+* Add schemas for options (and remove for files which are using settings) ([#234](https://github.com/lo1tuma/eslint-plugin-mocha/pull/234))
+* Add `u` flag in RegExp for `valid-test-description` and `valid-suite-description` ([#232](https://github.com/lo1tuma/eslint-plugin-mocha/pull/232))
+* Add `fixable` property to fixable rules (and mention in docs) ([#228](https://github.com/lo1tuma/eslint-plugin-mocha/pull/228))
+* add plugin to recommended config ([#226](https://github.com/lo1tuma/eslint-plugin-mocha/pull/226))
+
+### Documentation
+
+* Indicate whether rule is recommended ([#229](https://github.com/lo1tuma/eslint-plugin-mocha/pull/229))
+* "Options" heading in doc files (and consistent level 2 heading) ([#233](https://github.com/lo1tuma/eslint-plugin-mocha/pull/233))
+* Doc syntax issue ([#231](https://github.com/lo1tuma/eslint-plugin-mocha/pull/231))
+
+### Code Refactoring
+
+* Nondeprecated rule format ([#235](https://github.com/lo1tuma/eslint-plugin-mocha/pull/235))
+* Alphabetize rule lists ([#227](https://github.com/lo1tuma/eslint-plugin-mocha/pull/227))
+
+### Build-Related
+
+* - npm: Add package-lock.json ([#230](https://github.com/lo1tuma/eslint-plugin-mocha/pull/230))
+* ✉️ Send a webhook to Coveralls when the build completes ([#222](https://github.com/lo1tuma/eslint-plugin-mocha/pull/222))
+
 ## 6.2.2 (November 22, 2019)
 
 ### Bug Fixes

README.md

@@ -1,5 +1,5 @@
 [![NPM Version](https://img.shields.io/npm/v/eslint-plugin-mocha.svg?style=flat)](https://www.npmjs.org/package/eslint-plugin-mocha)
-[![Build Status](https://img.shields.io/travis/lo1tuma/eslint-plugin-mocha/master.svg?style=flat)](https://travis-ci.org/lo1tuma/eslint-plugin-mocha)
+[![GitHub Actions status](https://github.com/lo1tuma/eslint-plugin-mocha/workflows/CI/badge.svg)](https://github.com/lo1tuma/eslint-plugin-mocha/actions)
 [![Coverage Status](https://img.shields.io/coveralls/lo1tuma/eslint-plugin-mocha/master.svg?style=flat)](https://coveralls.io/r/lo1tuma/eslint-plugin-mocha)
 [![Peer Dependencies](http://img.shields.io/david/peer/lo1tuma/eslint-plugin-mocha.svg?style=flat)](https://david-dm.org/lo1tuma/eslint-plugin-mocha#info=peerDependencies&view=table)
 [![NPM Downloads](https://img.shields.io/npm/dm/eslint-plugin-mocha.svg?style=flat)](https://www.npmjs.org/package/eslint-plugin-mocha)

docs/rules/README.md

@@ -1,23 +1,25 @@
 # Rules
 
-* [handle-done-callback](handle-done-callback.md) - enforces handling of callbacks for async tests
-* [max-top-level-suites](max-top-level-suites.md) - limit the number of top-level suites in a single file
-* [no-exclusive-tests](no-exclusive-tests.md) - disallow exclusive mocha tests
-* [no-global-tests](no-global-tests.md) - disallow global tests
-* [no-hooks](no-hooks.md) - disallow hooks
-* [no-hooks-for-single-case](no-hooks-for-single-case.md) - disallow hooks for a single test or test suite
-* [no-identical-title](no-identical-title.md) - disallow identical titles
-* [no-mocha-arrows](no-mocha-arrows.md) - disallow arrow functions as arguments to mocha globals
-* [no-nested-tests](no-nested-tests.md) - disallow tests to be nested within other tests
-* [no-pending-tests](no-pending-tests.md) - disallow pending/unimplemented mocha tests
-* [no-return-and-callback](no-return-and-callback.md) - disallow returning in a test or hook function that uses a callback
-* [no-return-from-async](no-return-from-async.md) - disallow returning from an async test or hook
-* [no-setup-in-describe](no-setup-in-describe.md) - disallow calling functions and dot operators directly in describe blocks
-* [no-sibling-hooks](no-sibling-hooks.md) - disallow duplicate uses of a hook at the same level inside a describe
-* [no-skipped-tests](no-skipped-tests.md) - disallow skipped mocha tests (fixable)
-* [no-synchronous-tests](no-synchronous-tests.md) - disallow synchronous tests
-* [no-top-level-hooks](no-top-level-hooks.md) - disallow top-level hooks
-* [prefer-arrow-callback](prefer-arrow-callback.md) - prefer arrow function callbacks (mocha-aware)
-* [valid-suite-description](valid-suite-description.md) - match suite descriptions against a pre-configured regular expression
-* [valid-test-description](valid-test-description.md) - match test descriptions against a pre-configured regular expression
-* [no-async-describe](no-async-describe.md) - disallow async functions passed to describe
+|recommended|fixable|rule|description|
+|-|-|-|-|
+|:heavy_check_mark:|| [handle-done-callback](handle-done-callback.md) | enforces handling of callbacks for async tests
+|:heavy_check_mark:|| [max-top-level-suites](max-top-level-suites.md) | limit the number of top-level suites in a single file
+|:heavy_check_mark:|:wrench:| [no-async-describe](no-async-describe.md) | disallow async functions passed to describe
+|:heavy_check_mark:|| [no-exclusive-tests](no-exclusive-tests.md) | disallow exclusive mocha tests
+|:heavy_check_mark:|| [no-global-tests](no-global-tests.md) | disallow global tests
+||| [no-hooks](no-hooks.md) | disallow hooks
+|:heavy_check_mark:|| [no-hooks-for-single-case](no-hooks-for-single-case.md) | disallow hooks for a single test or test suite
+|:heavy_check_mark:|| [no-identical-title](no-identical-title.md) | disallow identical titles
+|:heavy_check_mark:|:wrench:| [no-mocha-arrows](no-mocha-arrows.md) | disallow arrow functions as arguments to mocha globals
+|:heavy_check_mark:|| [no-nested-tests](no-nested-tests.md) | disallow tests to be nested within other tests
+|:heavy_check_mark:|| [no-pending-tests](no-pending-tests.md) | disallow pending/unimplemented mocha tests
+|:heavy_check_mark:|| [no-return-and-callback](no-return-and-callback.md) | disallow returning in a test or hook function that uses a callback
+||| [no-return-from-async](no-return-from-async.md) | disallow returning from an async test or hook
+|:heavy_check_mark:|| [no-setup-in-describe](no-setup-in-describe.md) | disallow calling functions and dot operators directly in describe blocks
+|:heavy_check_mark:|| [no-sibling-hooks](no-sibling-hooks.md) | disallow duplicate uses of a hook at the same level inside a describe
+|:heavy_check_mark:|:wrench:| [no-skipped-tests](no-skipped-tests.md) | disallow skipped mocha tests
+||| [no-synchronous-tests](no-synchronous-tests.md) | disallow synchronous tests
+|:heavy_check_mark:|| [no-top-level-hooks](no-top-level-hooks.md) | disallow top-level hooks
+||:wrench:| [prefer-arrow-callback](prefer-arrow-callback.md) | prefer arrow function callbacks (mocha-aware)
+||| [valid-suite-description](valid-suite-description.md) | match suite descriptions against a pre-configured regular expression
+||| [valid-test-description](valid-test-description.md) | match test descriptions against a pre-configured regular expression

docs/rules/max-top-level-suites.md

@@ -33,6 +33,8 @@ describe('foo', function () {
 });
 ```
 
+## Options
+
 If you want to change the suite limit to, for instance, 2 suites per file:
 
 ```js

docs/rules/no-async-describe.md

@@ -15,6 +15,8 @@ describe('the thing', async function () {
 });
 ```
 
+**Fixable:** Problems detected by this rule are automatically fixable using the `--fix` flag on the command line.
+
 ## Rule Details
 
 The rule supports "describe", "context" and "suite" suite function names and different valid suite name prefixes like "skip" or "only".

docs/rules/no-exclusive-tests.md

@@ -49,9 +49,9 @@ suite.skip("bar", function () {});
 test.skip("bar", function () {});
 ```
 
-# Options
+## Settings
 
-This rule supports the following shared configuration options:
+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)
 

docs/rules/no-hooks-for-single-case.md

@@ -58,7 +58,7 @@ describe('foo', function () {
 });
 ```
 
-# Options
+## Options
 
 This rule supports the following options:
 

docs/rules/no-hooks.md

@@ -43,6 +43,21 @@ describe('foo', function () {
 });
 ```
 
+## Options
+
+This rule supports the following options:
+
+* `allow`: An array containing the names of hooks to allow. Defaults to an empty array.
+
+```json
+{
+    "rules": {
+        "mocha/no-hooks": ["error", {"allow": ["after"]}]
+    }
+}
+```
+
+
 ## When Not To Use It
 
 * If you use another library which exposes a similar API as mocha (e.g. `before`, `after`), you should turn this rule off, because it would raise warnings.

docs/rules/no-mocha-arrows.md

@@ -2,6 +2,8 @@
 
 Mocha [discourages](http://mochajs.org/#arrow-functions) passing it arrow functions as arguments. This rule prevents their use on the Mocha globals.
 
+**Fixable:** Problems detected by this rule are automatically fixable using the `--fix` flag on the command line.
+
 ## Rule Details
 
 This rule looks for occurrences of the Mocha functions (`describe`, `it`, `beforeEach`, etc.) within the source code.

docs/rules/no-skipped-tests.md

@@ -44,9 +44,9 @@ suite.only("bar", function () {});
 test.only("bar", function () {});
 ```
 
-# Options
+## Settings
 
-This rule supports the following shared configuration options:
+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

docs/rules/no-synchronous-tests.md

@@ -10,7 +10,7 @@ By default, this rule looks for the presence of one of:
 - An async function provided to a mocha test statement.
 - A return statement within the function body of any mocha test statement.
 
-If none of these three options is used in a test method, the rule will raise a warning.
+If none of these three alternatives is used in a test method, the rule will raise a warning.
 
 The following patterns are considered warnings:
 
@@ -37,9 +37,11 @@ it('should do foo', async function () {
 
 it('should do foo', function () {
     return promise;
-}
+});
 ```
 
+## Options
+
 You can change the acceptable asynchronous test methods to only allow a combination of async functions/callbacks/promises:
 
 ```js
@@ -48,7 +50,6 @@ rules: {
 },
 ```
 
-
 ### Caveats:
 
 This rule cannot guarantee that a returned function call is actually a promise, it only confirms that the return was made.

docs/rules/prefer-arrow-callback.md

@@ -13,6 +13,8 @@ You will want to disable the original `prefer-arrow-callback` rule and configure
 }
 ```
 
+**Fixable:** Problems detected by this rule are automatically fixable using the `--fix` flag on the command line.
+
 ## Rule Overview
 
 Arrow functions can be an attractive alternative to function expressions for callbacks or function arguments.

docs/rules/valid-suite-description.md

@@ -42,6 +42,8 @@ context("Test suite", function() { });
 suite("Test suite", function() { });
 ```
 
+## Options
+
 There is also possible to configure a custom list of suite names and a custom error message via the second and third rule configuration option:
 
 ```js

docs/rules/valid-test-description.md

@@ -7,6 +7,8 @@ This rule enforces the test descriptions to follow the desired format.
 By default, the regular expression is configured to be "^should" which requires test descriptions to start with "should".
 By default, the rule supports "it", "specify" and "test" test function names, but it can be configured to look for different test names via rule configuration.
 
+## Options
+
 Example of a custom rule configuration:
 
 ```js

index.js

@@ -2,33 +2,35 @@
 
 module.exports = {
     rules: {
-        'no-exclusive-tests': require('./lib/rules/no-exclusive-tests'),
-        'no-pending-tests': require('./lib/rules/no-pending-tests'),
-        'no-skipped-tests': require('./lib/rules/no-skipped-tests'),
         'handle-done-callback': require('./lib/rules/handle-done-callback'),
-        'no-synchronous-tests': require('./lib/rules/no-synchronous-tests'),
+        'max-top-level-suites': require('./lib/rules/max-top-level-suites'),
+        'no-async-describe': require('./lib/rules/no-async-describe'),
+        'no-exclusive-tests': require('./lib/rules/no-exclusive-tests'),
         'no-global-tests': require('./lib/rules/no-global-tests'),
-        'no-return-and-callback': require('./lib/rules/no-return-and-callback'),
-        'no-return-from-async': require('./lib/rules/no-return-from-async'),
-        'valid-test-description': require('./lib/rules/valid-test-description'),
-        'valid-suite-description': require('./lib/rules/valid-suite-description'),
-        'no-mocha-arrows': require('./lib/rules/no-mocha-arrows'),
         'no-hooks': require('./lib/rules/no-hooks'),
         'no-hooks-for-single-case': require('./lib/rules/no-hooks-for-single-case'),
-        'no-sibling-hooks': require('./lib/rules/no-sibling-hooks'),
-        'no-top-level-hooks': require('./lib/rules/no-top-level-hooks'),
         'no-identical-title': require('./lib/rules/no-identical-title'),
-        'max-top-level-suites': require('./lib/rules/max-top-level-suites'),
+        'no-mocha-arrows': require('./lib/rules/no-mocha-arrows'),
         'no-nested-tests': require('./lib/rules/no-nested-tests'),
+        'no-pending-tests': require('./lib/rules/no-pending-tests'),
+        'no-return-and-callback': require('./lib/rules/no-return-and-callback'),
+        'no-return-from-async': require('./lib/rules/no-return-from-async'),
         'no-setup-in-describe': require('./lib/rules/no-setup-in-describe'),
+        'no-sibling-hooks': require('./lib/rules/no-sibling-hooks'),
+        'no-skipped-tests': require('./lib/rules/no-skipped-tests'),
+        'no-synchronous-tests': require('./lib/rules/no-synchronous-tests'),
+        'no-top-level-hooks': require('./lib/rules/no-top-level-hooks'),
         'prefer-arrow-callback': require('./lib/rules/prefer-arrow-callback'),
-        'no-async-describe': require('./lib/rules/no-async-describe')
+        'valid-suite-description': require('./lib/rules/valid-suite-description'),
+        'valid-test-description': require('./lib/rules/valid-test-description')
     },
     configs: {
         recommended: {
+            plugins: [ 'mocha' ],
             rules: {
                 'mocha/handle-done-callback': 'error',
                 'mocha/max-top-level-suites': [ 'error', { limit: 1 } ],
+                'mocha/no-async-describe': 'error',
                 'mocha/no-exclusive-tests': 'warn',
                 'mocha/no-global-tests': 'error',
                 'mocha/no-hooks': 'off',
@@ -38,15 +40,15 @@ module.exports = {
                 'mocha/no-nested-tests': 'error',
                 'mocha/no-pending-tests': 'warn',
                 'mocha/no-return-and-callback': 'error',
+                'mocha/no-return-from-async': 'off',
                 'mocha/no-setup-in-describe': 'error',
                 'mocha/no-sibling-hooks': 'error',
                 'mocha/no-skipped-tests': 'warn',
                 'mocha/no-synchronous-tests': 'off',
                 'mocha/no-top-level-hooks': 'warn',
                 'mocha/prefer-arrow-callback': 'off',
                 'mocha/valid-suite-description': 'off',
-                'mocha/valid-test-description': 'off',
-                'mocha/no-async-describe': 'error'
+                'mocha/valid-test-description': 'off'
             }
         }
     }

lib/rules/handle-done-callback.js

@@ -3,46 +3,48 @@
 const find = require('ramda/src/find');
 const astUtils = require('../util/ast');
 
-module.exports = function (context) {
-    function isAsyncFunction(functionExpression) {
-        return functionExpression.params.length === 1;
-    }
+module.exports = {
+    create(context) {
+        function isAsyncFunction(functionExpression) {
+            return functionExpression.params.length === 1;
+        }
 
-    function findParamInScope(paramName, scope) {
-        return find(function (variable) {
-            return variable.name === paramName && variable.defs[0].type === 'Parameter';
-        }, scope.variables);
-    }
+        function findParamInScope(paramName, scope) {
+            return find(function (variable) {
+                return variable.name === paramName && variable.defs[0].type === 'Parameter';
+            }, scope.variables);
+        }
 
-    function isReferenceHandled(reference) {
-        const parent = context.getNodeByRangeIndex(reference.identifier.range[0]).parent;
+        function isReferenceHandled(reference) {
+            const parent = context.getNodeByRangeIndex(reference.identifier.range[0]).parent;
 
-        return parent.type === 'CallExpression';
-    }
+            return parent.type === 'CallExpression';
+        }
 
-    function hasHandledReferences(references) {
-        return references.some(isReferenceHandled);
-    }
+        function hasHandledReferences(references) {
+            return references.some(isReferenceHandled);
+        }
 
-    function checkAsyncMochaFunction(functionExpression) {
-        const scope = context.getScope();
-        const callback = functionExpression.params[0];
-        const callbackName = callback.name;
-        const callbackVariable = findParamInScope(callbackName, scope);
+        function checkAsyncMochaFunction(functionExpression) {
+            const scope = context.getScope();
+            const callback = functionExpression.params[0];
+            const callbackName = callback.name;
+            const callbackVariable = findParamInScope(callbackName, scope);
 
-        if (callbackVariable && !hasHandledReferences(callbackVariable.references)) {
-            context.report(callback, 'Expected "{{name}}" callback to be handled.', { name: callbackName });
+            if (callbackVariable && !hasHandledReferences(callbackVariable.references)) {
+                context.report(callback, 'Expected "{{name}}" callback to be handled.', { name: callbackName });
+            }
         }
-    }
 
-    function check(node) {
-        if (astUtils.hasParentMochaFunctionCall(node) && isAsyncFunction(node)) {
-            checkAsyncMochaFunction(node);
+        function check(node) {
+            if (astUtils.hasParentMochaFunctionCall(node) && isAsyncFunction(node)) {
+                checkAsyncMochaFunction(node);
+            }
         }
-    }
 
-    return {
-        FunctionExpression: check,
-        ArrowFunctionExpression: check
-    };
+        return {
+            FunctionExpression: check,
+            ArrowFunctionExpression: check
+        };
+    }
 };