-
-
Notifications
You must be signed in to change notification settings - Fork 26
/
require-description.d.ts
45 lines (41 loc) · 1.18 KB
/
require-description.d.ts
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
import type { RuleConfig } from '../rule-config';
/**
* Option.
*/
export interface RequireDescriptionOption {
ignore?: (
| 'eslint'
| 'eslint-disable'
| 'eslint-disable-line'
| 'eslint-disable-next-line'
| 'eslint-enable'
| 'eslint-env'
| 'exported'
| 'global'
| 'globals'
)[];
}
/**
* Options.
*/
export type RequireDescriptionOptions = [RequireDescriptionOption?];
/**
* Require include descriptions in ESLint directive-comments.
*
* @see [require-description](https://mysticatea.github.io/eslint-plugin-eslint-comments/rules/require-description.html)
*/
export type RequireDescriptionRuleConfig =
RuleConfig<RequireDescriptionOptions>;
/**
* Require include descriptions in ESLint directive-comments.
*
* @see [require-description](https://mysticatea.github.io/eslint-plugin-eslint-comments/rules/require-description.html)
*/
export interface RequireDescriptionRule {
/**
* Require include descriptions in ESLint directive-comments.
*
* @see [require-description](https://mysticatea.github.io/eslint-plugin-eslint-comments/rules/require-description.html)
*/
'eslint-comments/require-description': RequireDescriptionRuleConfig;
}