1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
|
# require rules to implement a meta.docs.description property (require-meta-docs-description)
Defining a clear and consistent description for each rule helps developers understand what they're used for.
In particular, each rule description should begin with an allowed prefix:
* `enforce`
* `require`
* `disallow`
## Rule Details
This rule requires ESLint rules to have a valid `meta.docs.description` property.
Examples of **incorrect** code for this rule:
```js
/* eslint eslint-plugin/require-meta-docs-description: error */
module.exports = {
meta: {},
create: function(context) { /* ... */}
};
module.exports = {
meta: { description: 'this rule does ...' }, // missing allowed prefix
create: function(context) { /* ... */}
};
```
Examples of **correct** code for this rule:
```js
/* eslint eslint-plugin/require-meta-docs-description: error */
module.exports = {
meta: { description: 'disallow unused variables' },
create: function(context) { /* ... */}
};
```
## Options
This rule takes an optional object containing:
- `String` — `pattern` — A regular expression that the description must match. Use `'.+'` to allow anything. Defaults to `^(enforce|require|disallow)`.
## Further Reading
* [working-with-rules#options-schemas](https://eslint.org/docs/developer-guide/working-with-rules#options-schemas)
|
