@@ -6,10 +6,20 @@ import type { Rules } from './rules';
6
6
import type { Settings } from './settings' ;
7
7
8
8
/**
9
+ * ESLint Configuration.
9
10
*
11
+ * @see [ESLint Configuration](https://eslint.org/docs/user-guide/configuring/)
10
12
*/
11
13
export interface EslintConfig {
14
+ /**
15
+ * @see [Using Configuration Files](https://eslint.org/docs/user-guide/configuring/configuration-files#using-configuration-files)
16
+ */
12
17
root ?: boolean ;
18
+ /**
19
+ * Tell ESLint to ignore specific files and directories.
20
+ *
21
+ * @see [Ignore Patterns](https://eslint.org/docs/user-guide/configuring/ignoring-code)
22
+ */
13
23
ignorePatterns ?: string [ ] ;
14
24
/**
15
25
* An environment provides predefined global variables.
@@ -23,16 +33,43 @@ export interface EslintConfig {
23
33
* @see [Extends](https://eslint.org/docs/user-guide/configuring/configuration-files#extending-configuration-files)
24
34
*/
25
35
extends ?: Extends ;
36
+ /**
37
+ * Parser.
38
+ *
39
+ * @see [Working with Custom Parsers](https://eslint.org/docs/developer-guide/working-with-custom-parsers)
40
+ * @see [Specifying Parser](https://eslint.org/docs/user-guide/configuring/plugins#specifying-parser)
41
+ */
26
42
parser ?: string ;
43
+ /**
44
+ * Parser Options.
45
+ *
46
+ * @see [Working with Custom Parsers](https://eslint.org/docs/developer-guide/working-with-custom-parsers)
47
+ * @see [Specifying Parser Options](https://eslint.org/docs/user-guide/configuring/language-options#specifying-parser-options)
48
+ */
27
49
parserOptions ?: ParserOptions ;
50
+ /**
51
+ * Which third-party plugins define additional rules, environments, configs, etc. for ESLint to use.
52
+ *
53
+ * @see [Configuring Plugins](https://eslint.org/docs/user-guide/configuring/plugins#configuring-plugins)
54
+ */
28
55
plugins ?: string [ ] ;
29
56
/**
30
57
* Rules.
31
58
*
32
59
* @see [Rules](https://eslint.org/docs/user-guide/configuring/rules)
33
60
*/
34
61
rules ?: Rules ;
62
+ /**
63
+ * Overrides.
64
+ *
65
+ * @see [How do overrides work](https://eslint.org/docs/user-guide/configuring/configuration-files#how-do-overrides-work)
66
+ */
35
67
overrides ?: Overrides ;
68
+ /**
69
+ * Settings.
70
+ *
71
+ * @see [Settings](https://eslint.org/docs/user-guide/configuring/configuration-files#adding-shared-settings)
72
+ */
36
73
settings ?: Settings ;
37
74
}
38
75
0 commit comments