@@ -6,10 +6,20 @@ import type { Rules } from './rules';
66import type { Settings } from './settings' ;
77
88/**
9+ * ESLint Configuration.
910 *
11+ * @see [ESLint Configuration](https://eslint.org/docs/user-guide/configuring/)
1012 */
1113export interface EslintConfig {
14+ /**
15+ * @see [Using Configuration Files](https://eslint.org/docs/user-guide/configuring/configuration-files#using-configuration-files)
16+ */
1217 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+ */
1323 ignorePatterns ?: string [ ] ;
1424 /**
1525 * An environment provides predefined global variables.
@@ -23,16 +33,43 @@ export interface EslintConfig {
2333 * @see [Extends](https://eslint.org/docs/user-guide/configuring/configuration-files#extending-configuration-files)
2434 */
2535 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+ */
2642 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+ */
2749 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+ */
2855 plugins ?: string [ ] ;
2956 /**
3057 * Rules.
3158 *
3259 * @see [Rules](https://eslint.org/docs/user-guide/configuring/rules)
3360 */
3461 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+ */
3567 overrides ?: Overrides ;
68+ /**
69+ * Settings.
70+ *
71+ * @see [Settings](https://eslint.org/docs/user-guide/configuring/configuration-files#adding-shared-settings)
72+ */
3673 settings ?: Settings ;
3774}
3875
0 commit comments