valid-suite-description.md

Require suite descriptions to match a pre-configured regular expression (mocha/valid-suite-description)

🚫 This rule is disabled in the ✅ recommended config.

This rule enforces the suite descriptions to follow the desired format.

Rule Details

By default, the regular expression is not configured and would be required if rule is enabled. By default, the rule supports "describe", "context" and "suite" suite function names, but it can be configured to look for different suite names via rule configuration.

Example of a custom rule configuration:

rules: {
   "mocha/valid-suite-description": ["warn", "^[A-Z]"]
},

where:

• warn is a rule error level (see Configuring Rules)
• ^[A-Z] is a custom regular expression pattern to match suite names against; ^[A-Z] enforces a suite name to start with an upper-case letter

The following patterns are considered warnings (with the example rule configuration posted above):

// bdd
describe("something to test", function() { });
context("something to test", function() { });

// tdd
suite("something to test", function() { });

These patterns would not be considered warnings:

// bdd
describe("Test suite", function() { });
context("Test suite", function() { });

// tdd
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:

rules: {
   "mocha/valid-suite-description": ["warn", "^[A-Z]", ["describe", "context", "suite", "mysuitename"], "custom error message"]
},
// OR
rules: {
   "mocha/valid-suite-description": ["warn", { pattern: "^[A-Z]", suiteNames: ["describe", "context", "suite", "mysuitename"], message: "custom error message" }]
},