Skip to content

Commit 79e5829

Browse files
authored
Merge pull request #385 from lo1tuma/lo1tuma-patch-1
Fix valid-suite-title options documentation
2 parents ae3813c + cdd729c commit 79e5829

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

docs/rules/valid-suite-title.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,14 +47,13 @@ suite('Test suite', function () {});
4747

4848
## Options
4949

50-
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:
50+
There are two options available:
51+
52+
- `pattern`: a regexp pattern
53+
- `message`: a custom error message
5154

5255
```js
5356
rules: {
54-
"mocha/valid-suite-title": ["warn", "^[A-Z]", ["describe", "context", "suite", "mysuitename"], "custom error message"]
55-
},
56-
// OR
57-
rules: {
58-
"mocha/valid-suite-title": ["warn", { pattern: "^[A-Z]", suiteNames: ["describe", "context", "suite", "mysuitename"], message: "custom error message" }]
57+
"mocha/valid-suite-title": ["warn", { pattern: "^[A-Z]", message: "custom error message" }]
5958
},
6059
```

0 commit comments

Comments
 (0)