eslint-plugin-mocha
Version:
Eslint rules for mocha.
153 lines (114 loc) ā¢ 8.75 kB
Markdown
[](https://www.npmjs.org/package/eslint-plugin-mocha)
[](https://github.com/lo1tuma/eslint-plugin-mocha/actions)
[](https://coveralls.io/r/lo1tuma/eslint-plugin-mocha)
[](https://www.npmjs.org/package/eslint-plugin-mocha)
# eslint-plugin-mocha
ESLint rules for [mocha](http://mochajs.org/).
## Install and configure
This plugin requires ESLint `4.0.0` or later.
```bash
npm install --save-dev eslint-plugin-mocha
```
### `.eslintrc.json`
Then add a reference to this plugin and selected rules in your eslint config:
```json
{
"plugins": [
"mocha"
]
}
```
### `eslint.config.js` (requires eslint >= 8.23.0)
To use this plugin with [the new eslint configuration format (flat config)](https://eslint.org/docs/latest/use/configure/configuration-files-new):
```js
import mochaPlugin from 'eslint-plugin-mocha';
export default [
mochaPlugin.configs.flat.recommended // or `mochaPlugin.configs.flat.all` to enable all
// ... Your configurations here
];
```
### 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) or [`mocha-each`](https://github.com/ryym/mocha-each).
**Example:**
```json
{
"rules": {
"mocha/no-skipped-tests": "error",
"mocha/no-exclusive-tests": "error"
},
"settings": {
"mocha/additionalCustomNames": [
{ "name": "describeModule", "type": "suite", "interfaces": [ "BDD" ] },
{ "name": "testModule", "type": "testCase", "interfaces": [ "TDD" ] }
]
}
}
```
The `name` property can be in any of the following forms:
* A plain name e.g. `describeModule`, which allows:
```javascript
describeModule("example", function() { ... });
```
* A dotted name, e.g. `describe.modifier`, which allows:
```javascript
describe.modifier("example", function() { ... });
```
* A name with parentheses, e.g. `forEach().describe`, which allows:
```javascript
forEach([ 1, 2, 3 ])
.describe("example", function(n) { ... });
```
* Any combination of the above, e.g. `forEach().describeModule.modifier`, which allows:
```javascript
forEach([ 1, 2, 3 ])
.describeModule.modifier("example", function(n) { ... });
```
## Configs
### `recommended`
This plugin exports a recommended config that enforces good practices.
Enable it with the extends option:
```json
{
"extends": [
"plugin:mocha/recommended"
]
}
```
### `all`
There's also a configuration that enables all of our rules.
See [Configuring Eslint](http://eslint.org/docs/user-guide/configuring) on [eslint.org](http://eslint.org) for more info.
## Rules
<!-- begin auto-generated rules list -->
š¼ [Configurations](https://github.com/lo1tuma/eslint-plugin-mocha#configs) enabled in.\
ā ļø [Configurations](https://github.com/lo1tuma/eslint-plugin-mocha#configs) set to warn in.\
š« [Configurations](https://github.com/lo1tuma/eslint-plugin-mocha#configs) disabled in.\
ā
Set in the `recommended` [configuration](https://github.com/lo1tuma/eslint-plugin-mocha#configs).\
š§ Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).
| NameĀ Ā Ā Ā Ā Ā Ā Ā Ā Ā Ā Ā Ā Ā Ā Ā Ā Ā Ā Ā Ā Ā Ā Ā Ā Ā Ā Ā Ā | Description | š¼ | ā ļø | š« | š§ |
| :----------------------------------------------------------------------------------- | :---------------------------------------------------------------------- | :- | :- | :- | :- |
| [consistent-spacing-between-blocks](docs/rules/consistent-spacing-between-blocks.md) | Require consistent spacing between blocks | ā
| | | š§ |
| [handle-done-callback](docs/rules/handle-done-callback.md) | Enforces handling of callbacks for async tests | ā
| | | |
| [max-top-level-suites](docs/rules/max-top-level-suites.md) | Enforce the number of top-level suites in a single file | ā
| | | |
| [no-async-describe](docs/rules/no-async-describe.md) | Disallow async functions passed to describe | ā
| | | š§ |
| [no-empty-description](docs/rules/no-empty-description.md) | Disallow empty test descriptions | ā
| | | |
| [no-exclusive-tests](docs/rules/no-exclusive-tests.md) | Disallow exclusive tests | | ā
| | |
| [no-exports](docs/rules/no-exports.md) | Disallow exports from test files | ā
| | | |
| [no-global-tests](docs/rules/no-global-tests.md) | Disallow global tests | ā
| | | |
| [no-hooks](docs/rules/no-hooks.md) | Disallow hooks | | | ā
| |
| [no-hooks-for-single-case](docs/rules/no-hooks-for-single-case.md) | Disallow hooks for a single test or test suite | | | ā
| |
| [no-identical-title](docs/rules/no-identical-title.md) | Disallow identical titles | ā
| | | |
| [no-mocha-arrows](docs/rules/no-mocha-arrows.md) | Disallow arrow functions as arguments to mocha functions | ā
| | | š§ |
| [no-nested-tests](docs/rules/no-nested-tests.md) | Disallow tests to be nested within other tests | ā
| | | |
| [no-pending-tests](docs/rules/no-pending-tests.md) | Disallow pending tests | | ā
| | |
| [no-return-and-callback](docs/rules/no-return-and-callback.md) | Disallow returning in a test or hook function that uses a callback | ā
| | | |
| [no-return-from-async](docs/rules/no-return-from-async.md) | Disallow returning from an async test or hook | | | ā
| |
| [no-setup-in-describe](docs/rules/no-setup-in-describe.md) | Disallow setup in describe blocks | ā
| | | |
| [no-sibling-hooks](docs/rules/no-sibling-hooks.md) | Disallow duplicate uses of a hook at the same level inside a describe | ā
| | | |
| [no-skipped-tests](docs/rules/no-skipped-tests.md) | Disallow skipped tests | | ā
| | |
| [no-synchronous-tests](docs/rules/no-synchronous-tests.md) | Disallow synchronous tests | | | ā
| |
| [no-top-level-hooks](docs/rules/no-top-level-hooks.md) | Disallow top-level hooks | | ā
| | |
| [prefer-arrow-callback](docs/rules/prefer-arrow-callback.md) | Require using arrow functions for callbacks | | | ā
| š§ |
| [valid-suite-description](docs/rules/valid-suite-description.md) | Require suite descriptions to match a pre-configured regular expression | | | ā
| |
| [valid-test-description](docs/rules/valid-test-description.md) | Require test descriptions to match a pre-configured regular expression | | | ā
| |
<!-- end auto-generated rules list -->