eslint-plugin-mocha

ESLint rules for mocha.

Install and configure

This plugin requires ESLint 9.0.0 or later.

npm install --save-dev eslint-plugin-mocha

Configuration via eslint.config.js

To use this plugin with eslint flat configuration format:

import mochaPlugin from "eslint-plugin-mocha";

export default [
    mochaPlugin.configs.recommended, // or `mochaPlugin.configs.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 or mocha-each.

  Example:

  {
      "rules": {
          "mocha/no-pending-tests": "error",
          "mocha/no-exclusive-tests": "error"
      },
      "settings": {
          "mocha/additionalCustomNames": [
              {
                  "name": "describeModule",
                  "type": "suite",
                  "interface": "BDD"
              },
              {
                  "name": "testModule",
                  "type": "testCase",
                  "interface": "TDD"
              }
          ]
      }
  }
  

  The name property can be in any of the following forms:

  • A plain name e.g. describeModule, which allows:

    describeModule("example", function() { ... });
    

  • A dotted name, e.g. describe.modifier, which allows:

    describe.modifier("example", function() { ... });
    

  • A name with parentheses, e.g. forEach().describe, which allows:

    forEach([ 1, 2, 3 ])
        .describe("example", function(n) { ... });
    

  • Any combination of the above, e.g. forEach().describeModule.modifier, which allows:

    forEach([ 1, 2, 3 ])
        .describeModule.modifier("example", function(n) { ... });
    

• interface: This allows to select either TDD, BDD (default) or exports. When using exports mocha variables are resolved from named import statements instead of global variables.

Rules

💼 Configurations enabled in.
⚠️ Configurations set to warn in.
🚫 Configurations disabled in.
✅ Set in the recommended configuration.
🔧 Automatically fixable by the --fix CLI option.