-
-
Notifications
You must be signed in to change notification settings - Fork 387
/
types.ts
358 lines (313 loc) · 7.81 KB
/
types.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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
import type { FlatGitignoreOptions } from 'eslint-config-flat-gitignore'
import type { ParserOptions } from '@typescript-eslint/parser'
import type { Options as VueBlocksOptions } from 'eslint-processor-vue-blocks'
import type { Linter } from 'eslint'
import type { StylisticCustomizeOptions } from '@stylistic/eslint-plugin'
import type { VendoredPrettierOptions } from './vender/prettier-types'
import type { ConfigNames, RuleOptions } from './typegen'
export type Awaitable<T> = T | Promise<T>
export type Rules = RuleOptions
export type { ConfigNames }
export type TypedFlatConfigItem = Omit<Linter.FlatConfig<Linter.RulesRecord & Rules>, 'plugins'> & {
// Relax plugins type limitation, as most of the plugins did not have correct type info yet.
/**
* An object containing a name-value mapping of plugin names to plugin objects. When `files` is specified, these plugins are only available to the matching files.
*
* @see [Using plugins in your configuration](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#using-plugins-in-your-configuration)
*/
plugins?: Record<string, any>
}
export interface OptionsFiles {
/**
* Override the `files` option to provide custom globs.
*/
files?: string[]
}
export interface OptionsVue extends OptionsOverrides {
/**
* Create virtual files for Vue SFC blocks to enable linting.
*
* @see https://github.com/antfu/eslint-processor-vue-blocks
* @default true
*/
sfcBlocks?: boolean | VueBlocksOptions
/**
* Vue version. Apply different rules set from `eslint-plugin-vue`.
*
* @default 3
*/
vueVersion?: 2 | 3
}
export type OptionsTypescript =
(OptionsTypeScriptWithTypes & OptionsOverrides)
| (OptionsTypeScriptParserOptions & OptionsOverrides)
export interface OptionsFormatters {
/**
* Enable formatting support for CSS, Less, Sass, and SCSS.
*
* Currently only support Prettier.
*/
css?: 'prettier' | boolean
/**
* Enable formatting support for HTML.
*
* Currently only support Prettier.
*/
html?: 'prettier' | boolean
/**
* Enable formatting support for Markdown.
*
* Support both Prettier and dprint.
*
* When set to `true`, it will use Prettier.
*/
markdown?: 'prettier' | 'dprint' | boolean
/**
* Enable formatting support for GraphQL.
*/
graphql?: 'prettier' | boolean
/**
* Custom options for Prettier.
*
* By default it's controlled by our own config.
*/
prettierOptions?: VendoredPrettierOptions
/**
* Custom options for dprint.
*
* By default it's controlled by our own config.
*/
dprintOptions?: boolean
/**
* Install the prettier plugin for handle Slidev markdown
*
* Only works when `markdown` is enabled with `prettier`.
*/
slidev?: boolean | {
files?: string[]
}
/**
* Enable formatting support for Astro.
*
* Currently only support Prettier.
*/
astro?: 'prettier' | boolean
}
export interface OptionsComponentExts {
/**
* Additional extensions for components.
*
* @example ['vue']
* @default []
*/
componentExts?: string[]
}
export interface OptionsTypeScriptParserOptions {
/**
* Additional parser options for TypeScript.
*/
parserOptions?: Partial<ParserOptions>
/**
* Glob patterns for files that should be type aware.
* @default ['**\/*.{ts,tsx}']
*/
filesTypeAware?: string[]
}
export interface OptionsTypeScriptWithTypes {
/**
* When this options is provided, type aware rules will be enabled.
* @see https://typescript-eslint.io/linting/typed-linting/
*/
tsconfigPath?: string | string[]
}
export interface OptionsHasTypeScript {
typescript?: boolean
}
export interface OptionsStylistic {
stylistic?: boolean | StylisticConfig
}
export interface StylisticConfig extends Pick<StylisticCustomizeOptions, 'indent' | 'quotes' | 'jsx' | 'semi'> {
}
export interface OptionsOverrides {
overrides?: TypedFlatConfigItem['rules']
}
export interface OptionsIsInEditor {
isInEditor?: boolean
}
export interface OptionsUnoCSS extends OptionsOverrides {
/**
* Enable attributify support.
* @default true
*/
attributify?: boolean
/**
* Enable strict mode by throwing errors about blocklisted classes.
* @default false
*/
strict?: boolean
}
export interface OptionsConfig extends OptionsComponentExts {
/**
* Enable gitignore support.
*
* Passing an object to configure the options.
*
* @see https://github.com/antfu/eslint-config-flat-gitignore
* @default true
*/
gitignore?: boolean | FlatGitignoreOptions
/**
* Core rules. Can't be disabled.
*/
javascript?: OptionsOverrides
/**
* Enable TypeScript support.
*
* Passing an object to enable TypeScript Language Server support.
*
* @default auto-detect based on the dependencies
*/
typescript?: boolean | OptionsTypescript
/**
* Enable JSX related rules.
*
* Currently only stylistic rules are included.
*
* @default true
*/
jsx?: boolean
/**
* Enable test support.
*
* @default true
*/
test?: boolean | OptionsOverrides
/**
* Enable Vue support.
*
* @default auto-detect based on the dependencies
*/
vue?: boolean | OptionsVue
/**
* Enable JSONC support.
*
* @default true
*/
jsonc?: boolean | OptionsOverrides
/**
* Enable YAML support.
*
* @default true
*/
yaml?: boolean | OptionsOverrides
/**
* Enable TOML support.
*
* @default true
*/
toml?: boolean | OptionsOverrides
/**
* Enable ASTRO support.
*
* Requires installing:
* - `eslint-plugin-astro`
*
* Requires installing for formatting .astro:
* - `prettier-plugin-astro`
*
* @default false
*/
astro?: boolean | OptionsOverrides
/**
* Enable linting for **code snippets** in Markdown.
*
* For formatting Markdown content, enable also `formatters.markdown`.
*
* @default true
*/
markdown?: boolean | OptionsOverrides
/**
* Enable stylistic rules.
*
* @default true
*/
stylistic?: boolean | (StylisticConfig & OptionsOverrides)
/**
* Enable react rules.
*
* Requires installing:
* - `eslint-plugin-react`
* - `eslint-plugin-react-hooks`
* - `eslint-plugin-react-refresh`
*
* @default false
*/
react?: boolean | OptionsOverrides
/**
* Enable solid rules.
*
* Requires installing:
* - `eslint-plugin-solid`
*
* @default false
*/
solid?: boolean | OptionsOverrides
/**
* Enable svelte rules.
*
* Requires installing:
* - `eslint-plugin-svelte`
*
* @default false
*/
svelte?: boolean
/**
* Enable unocss rules.
*
* Requires installing:
* - `@unocss/eslint-plugin`
*
* @default false
*/
unocss?: boolean | OptionsUnoCSS
/**
* Use external formatters to format files.
*
* Requires installing:
* - `eslint-plugin-format`
*
* When set to `true`, it will enable all formatters.
*
* @default false
*/
formatters?: boolean | OptionsFormatters
/**
* Control to disable some rules in editors.
* @default auto-detect based on the process.env
*/
isInEditor?: boolean
/**
* Automatically rename plugins in the config.
*
* @default true
*/
autoRenamePlugins?: boolean
/**
* Provide overrides for rules for each integration.
*
* @deprecated use `overrides` option in each integration key instead
*/
overrides?: {
stylistic?: TypedFlatConfigItem['rules']
javascript?: TypedFlatConfigItem['rules']
typescript?: TypedFlatConfigItem['rules']
test?: TypedFlatConfigItem['rules']
vue?: TypedFlatConfigItem['rules']
jsonc?: TypedFlatConfigItem['rules']
markdown?: TypedFlatConfigItem['rules']
yaml?: TypedFlatConfigItem['rules']
toml?: TypedFlatConfigItem['rules']
react?: TypedFlatConfigItem['rules']
svelte?: TypedFlatConfigItem['rules']
}
}