@kazupon/eslint-config 0.8.0 → 0.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (62) hide show
  1. package/README.md +1 -0
  2. package/dist/config.d.cts +6 -1
  3. package/dist/config.d.ts +6 -1
  4. package/dist/configs/comments.d.cts +14 -3
  5. package/dist/configs/comments.d.ts +14 -3
  6. package/dist/configs/javascript.d.cts +14 -3
  7. package/dist/configs/javascript.d.ts +14 -3
  8. package/dist/configs/jsdoc.d.cts +24 -4
  9. package/dist/configs/jsdoc.d.ts +24 -4
  10. package/dist/configs/jsonc.d.cts +36 -6
  11. package/dist/configs/jsonc.d.ts +36 -6
  12. package/dist/configs/prettier.d.cts +14 -3
  13. package/dist/configs/prettier.d.ts +14 -3
  14. package/dist/configs/promise.d.cts +14 -3
  15. package/dist/configs/promise.d.ts +14 -3
  16. package/dist/configs/regexp.d.cts +14 -3
  17. package/dist/configs/regexp.d.ts +14 -3
  18. package/dist/configs/typescript.d.cts +33 -6
  19. package/dist/configs/typescript.d.ts +33 -6
  20. package/dist/configs/unicorn.d.cts +14 -3
  21. package/dist/configs/unicorn.d.ts +14 -3
  22. package/dist/configs/vue.d.cts +17 -3
  23. package/dist/configs/vue.d.ts +17 -3
  24. package/dist/configs/yml.d.cts +18 -3
  25. package/dist/configs/yml.d.ts +18 -3
  26. package/dist/globs.d.cts +9 -9
  27. package/dist/globs.d.ts +9 -9
  28. package/dist/index.d.cts +1 -0
  29. package/dist/index.d.ts +1 -0
  30. package/dist/types/gens/comments.d.cts +65 -0
  31. package/dist/types/gens/comments.d.ts +65 -0
  32. package/dist/types/gens/eslint.d.cts +17 -0
  33. package/dist/types/gens/eslint.d.ts +17 -0
  34. package/dist/types/gens/javascript.d.cts +3162 -0
  35. package/dist/types/gens/javascript.d.ts +3162 -0
  36. package/dist/types/gens/jsdoc.d.cts +744 -0
  37. package/dist/types/gens/jsdoc.d.ts +744 -0
  38. package/dist/types/gens/jsonc.d.cts +513 -0
  39. package/dist/types/gens/jsonc.d.ts +513 -0
  40. package/dist/types/gens/prettier.d.cts +2 -0
  41. package/dist/types/gens/prettier.d.ts +2 -0
  42. package/dist/types/gens/promise.d.cts +107 -0
  43. package/dist/types/gens/promise.d.ts +107 -0
  44. package/dist/types/gens/regexp.d.cts +553 -0
  45. package/dist/types/gens/regexp.d.ts +553 -0
  46. package/dist/types/gens/typescript.d.cts +2253 -0
  47. package/dist/types/gens/typescript.d.ts +2253 -0
  48. package/dist/types/gens/unicorn.d.cts +905 -0
  49. package/dist/types/gens/unicorn.d.ts +905 -0
  50. package/dist/types/gens/vue.d.cts +2465 -0
  51. package/dist/types/gens/vue.d.ts +2465 -0
  52. package/dist/types/gens/yml.d.cts +375 -0
  53. package/dist/types/gens/yml.d.ts +375 -0
  54. package/dist/types/index.d.cts +14 -0
  55. package/dist/types/index.d.ts +14 -0
  56. package/dist/types/overrides.d.cts +6 -0
  57. package/dist/types/overrides.d.ts +6 -0
  58. package/dist/types/utils.d.cts +4 -0
  59. package/dist/types/utils.d.ts +4 -0
  60. package/dist/utils.d.cts +22 -1
  61. package/dist/utils.d.ts +22 -1
  62. package/package.json +4 -2
package/README.md CHANGED
@@ -134,6 +134,7 @@ This eslint config is inspired by:
134
134
 
135
135
  - [`@antfu/eslint-config`](https://github.com/antfu/eslint-config), created by [Anthony Fu](https://github.com/antfu)
136
136
  - [`@sxzz/eslint-config`](https://github.com/sxzz/eslint-config), created by [Kevin Deng 三咲智子](https://github.com/sxzz)
137
+ - [Vite](https://github.com/vitejs/vite), created by [Evan You](https://github.com/yyx990803) and Vite community
137
138
 
138
139
  Thank you! ❤️
139
140
 
package/dist/config.d.cts CHANGED
@@ -1,4 +1,9 @@
1
1
  import { FlatConfigComposer } from 'eslint-flat-config-utils';
2
2
  import type { Linter } from 'eslint';
3
3
  import type { Awaitable } from './types';
4
- export declare function defineConfig(...configs: (Awaitable<((Linter.FlatConfig) | ((Linter.FlatConfig)[]))>)[]): FlatConfigComposer;
4
+ /**
5
+ * define eslint configurations
6
+ * @param {Awaitable<Linter.FlatConfig | Linter.FlatConfig[]>[]} configs eslint flat configurations
7
+ * @returns {FlatConfigComposer} eslint flat configuration composer
8
+ */
9
+ export declare function defineConfig(...configs: Awaitable<Linter.FlatConfig | Linter.FlatConfig[]>[]): FlatConfigComposer;
package/dist/config.d.ts CHANGED
@@ -1,4 +1,9 @@
1
1
  import { FlatConfigComposer } from 'eslint-flat-config-utils';
2
2
  import type { Linter } from 'eslint';
3
3
  import type { Awaitable } from './types';
4
- export declare function defineConfig(...configs: (Awaitable<((Linter.FlatConfig) | ((Linter.FlatConfig)[]))>)[]): FlatConfigComposer;
4
+ /**
5
+ * define eslint configurations
6
+ * @param {Awaitable<Linter.FlatConfig | Linter.FlatConfig[]>[]} configs eslint flat configurations
7
+ * @returns {FlatConfigComposer} eslint flat configuration composer
8
+ */
9
+ export declare function defineConfig(...configs: Awaitable<Linter.FlatConfig | Linter.FlatConfig[]>[]): FlatConfigComposer;
@@ -1,4 +1,15 @@
1
1
  import type { Linter } from 'eslint';
2
- import type { OverridesOptions } from '../types';
3
- export interface CommentsOptions {}
4
- export declare function comments(options?: ((CommentsOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
2
+ import type { OverridesOptions, CommentsRules } from '../types';
3
+ /**
4
+ * eslint comments configuration options
5
+ */
6
+ export interface CommentsOptions {
7
+ }
8
+ /**
9
+ * `@eslint-community/eslint-plugin-eslint-comments` and overrides configuration options
10
+ * @param {CommentsOptions & OverridesOptions} options
11
+ * eslint comments configuration options for eslint comment directives
12
+ * @returns {Promise<Linter.FlatConfig[]>}
13
+ * eslint flat configurations with `@eslint-community/eslint-plugin-eslint-comments` and overrides
14
+ */
15
+ export declare function comments(options?: CommentsOptions & OverridesOptions<CommentsRules>): Promise<Linter.FlatConfig[]>;
@@ -1,4 +1,15 @@
1
1
  import type { Linter } from 'eslint';
2
- import type { OverridesOptions } from '../types';
3
- export interface CommentsOptions {}
4
- export declare function comments(options?: ((CommentsOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
2
+ import type { OverridesOptions, CommentsRules } from '../types';
3
+ /**
4
+ * eslint comments configuration options
5
+ */
6
+ export interface CommentsOptions {
7
+ }
8
+ /**
9
+ * `@eslint-community/eslint-plugin-eslint-comments` and overrides configuration options
10
+ * @param {CommentsOptions & OverridesOptions} options
11
+ * eslint comments configuration options for eslint comment directives
12
+ * @returns {Promise<Linter.FlatConfig[]>}
13
+ * eslint flat configurations with `@eslint-community/eslint-plugin-eslint-comments` and overrides
14
+ */
15
+ export declare function comments(options?: CommentsOptions & OverridesOptions<CommentsRules>): Promise<Linter.FlatConfig[]>;
@@ -1,4 +1,15 @@
1
1
  import type { Linter } from 'eslint';
2
- import type { OverridesOptions } from '../types';
3
- export interface JavaScriptOptions {}
4
- export declare function javascript(options?: ((JavaScriptOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
2
+ import type { OverridesOptions, JavascriptRules } from '../types';
3
+ /**
4
+ * JavaScript configuration options
5
+ */
6
+ export interface JavaScriptOptions {
7
+ }
8
+ /**
9
+ * `@eslint/js` and overrides configuration options
10
+ * @param {JavaScriptOptions & OverridesOptions} options
11
+ * eslint configuration options for JavaScript
12
+ * @returns {Promise<Linter.FlatConfig[]>}
13
+ * eslint flat configurations with `@eslint/js` and overrides
14
+ */
15
+ export declare function javascript(options?: JavaScriptOptions & OverridesOptions<JavascriptRules>): Promise<Linter.FlatConfig[]>;
@@ -1,4 +1,15 @@
1
1
  import type { Linter } from 'eslint';
2
- import type { OverridesOptions } from '../types';
3
- export interface JavaScriptOptions {}
4
- export declare function javascript(options?: ((JavaScriptOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
2
+ import type { OverridesOptions, JavascriptRules } from '../types';
3
+ /**
4
+ * JavaScript configuration options
5
+ */
6
+ export interface JavaScriptOptions {
7
+ }
8
+ /**
9
+ * `@eslint/js` and overrides configuration options
10
+ * @param {JavaScriptOptions & OverridesOptions} options
11
+ * eslint configuration options for JavaScript
12
+ * @returns {Promise<Linter.FlatConfig[]>}
13
+ * eslint flat configurations with `@eslint/js` and overrides
14
+ */
15
+ export declare function javascript(options?: JavaScriptOptions & OverridesOptions<JavascriptRules>): Promise<Linter.FlatConfig[]>;
@@ -1,7 +1,27 @@
1
1
  import type { Linter } from 'eslint';
2
- import type { OverridesOptions } from '../types';
2
+ import type { OverridesOptions, JsdocRules } from '../types';
3
+ /**
4
+ * jsdoc configuration options
5
+ */
3
6
  export interface JsDocumentOptions {
4
- typescript?: (('syntax') | ('flavor'));
5
- error?: boolean;
7
+ /**
8
+ * If you want to use TypeScript, you need to set `syntax`, else if you want to use JavaScript and TypeScript flavor in comments, you need to set `flavor`.
9
+ * @see https://github.com/gajus/eslint-plugin-jsdoc?tab=readme-ov-file#configuration
10
+ * @default undefined
11
+ */
12
+ typescript?: 'syntax' | 'flavor';
13
+ /**
14
+ * If you wish to have all linting issues reported as failing errors, you can set this to `true`.
15
+ * @see https://github.com/gajus/eslint-plugin-jsdoc?tab=readme-ov-file#configuration
16
+ * @default false
17
+ */
18
+ error?: boolean;
6
19
  }
7
- export declare function jsdoc(options?: ((JsDocumentOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
20
+ /**
21
+ * `eslint-plugin-jsdoc` and overrides configuration options
22
+ * @param {JsDocOptions & OverridesOptions} options
23
+ * eslint configuration options for JavaScript
24
+ * @returns {Promise<Linter.FlatConfig[]>}
25
+ * eslint flat configurations with `eslint-plugin-jsdoc` and overrides
26
+ */
27
+ export declare function jsdoc(options?: JsDocumentOptions & OverridesOptions<JsdocRules>): Promise<Linter.FlatConfig[]>;
@@ -1,7 +1,27 @@
1
1
  import type { Linter } from 'eslint';
2
- import type { OverridesOptions } from '../types';
2
+ import type { OverridesOptions, JsdocRules } from '../types';
3
+ /**
4
+ * jsdoc configuration options
5
+ */
3
6
  export interface JsDocumentOptions {
4
- typescript?: (('syntax') | ('flavor'));
5
- error?: boolean;
7
+ /**
8
+ * If you want to use TypeScript, you need to set `syntax`, else if you want to use JavaScript and TypeScript flavor in comments, you need to set `flavor`.
9
+ * @see https://github.com/gajus/eslint-plugin-jsdoc?tab=readme-ov-file#configuration
10
+ * @default undefined
11
+ */
12
+ typescript?: 'syntax' | 'flavor';
13
+ /**
14
+ * If you wish to have all linting issues reported as failing errors, you can set this to `true`.
15
+ * @see https://github.com/gajus/eslint-plugin-jsdoc?tab=readme-ov-file#configuration
16
+ * @default false
17
+ */
18
+ error?: boolean;
6
19
  }
7
- export declare function jsdoc(options?: ((JsDocumentOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
20
+ /**
21
+ * `eslint-plugin-jsdoc` and overrides configuration options
22
+ * @param {JsDocOptions & OverridesOptions} options
23
+ * eslint configuration options for JavaScript
24
+ * @returns {Promise<Linter.FlatConfig[]>}
25
+ * eslint flat configurations with `eslint-plugin-jsdoc` and overrides
26
+ */
27
+ export declare function jsdoc(options?: JsDocumentOptions & OverridesOptions<JsdocRules>): Promise<Linter.FlatConfig[]>;
@@ -1,9 +1,39 @@
1
1
  import type { Linter } from 'eslint';
2
- import type { OverridesOptions } from '../types';
2
+ import type { OverridesOptions, JsoncRules } from '../types';
3
+ /**
4
+ * eslint jsonc configuration options
5
+ */
3
6
  export interface JsoncOptions {
4
- json?: boolean;
5
- jsonc?: boolean;
6
- json5?: boolean;
7
- prettier?: boolean;
7
+ /**
8
+ * whether to enable config `'flat/recommended-with-json'`of `eslint-plugin-jsonc`.
9
+ * @see https://ota-meshi.github.io/eslint-plugin-jsonc/user-guide/#usage
10
+ * @default false
11
+ */
12
+ json?: boolean;
13
+ /**
14
+ * whether to enable config `'flat/recommended-with-jsonc'`of `eslint-plugin-jsonc`.
15
+ * @see https://ota-meshi.github.io/eslint-plugin-jsonc/user-guide/#usage
16
+ * @default false
17
+ */
18
+ jsonc?: boolean;
19
+ /**
20
+ * whether to enable config `'flat/recommended-with-json5'`of `eslint-plugin-jsonc`.
21
+ * @see https://ota-meshi.github.io/eslint-plugin-jsonc/user-guide/#usage
22
+ * @default false
23
+ */
24
+ json5?: boolean;
25
+ /**
26
+ * whether to enable config `'flat/prettier'`of `eslint-plugin-jsonc`.
27
+ * @see https://ota-meshi.github.io/eslint-plugin-jsonc/user-guide/#usage
28
+ * @default false
29
+ */
30
+ prettier?: boolean;
8
31
  }
9
- export declare function jsonc(options?: ((JsoncOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
32
+ /**
33
+ * `eslint-plugin-jsonc` and overrides configuration options
34
+ * @param {JsoncOptions & OverridesOptions} options
35
+ * eslint jsonc configuration options for json, jsonc, json5
36
+ * @returns {Promise<Linter.FlatConfig[]>}
37
+ * eslint flat configurations with `eslint-plugin-jsonc` and overrides
38
+ */
39
+ export declare function jsonc(options?: JsoncOptions & OverridesOptions<JsoncRules>): Promise<Linter.FlatConfig[]>;
@@ -1,9 +1,39 @@
1
1
  import type { Linter } from 'eslint';
2
- import type { OverridesOptions } from '../types';
2
+ import type { OverridesOptions, JsoncRules } from '../types';
3
+ /**
4
+ * eslint jsonc configuration options
5
+ */
3
6
  export interface JsoncOptions {
4
- json?: boolean;
5
- jsonc?: boolean;
6
- json5?: boolean;
7
- prettier?: boolean;
7
+ /**
8
+ * whether to enable config `'flat/recommended-with-json'`of `eslint-plugin-jsonc`.
9
+ * @see https://ota-meshi.github.io/eslint-plugin-jsonc/user-guide/#usage
10
+ * @default false
11
+ */
12
+ json?: boolean;
13
+ /**
14
+ * whether to enable config `'flat/recommended-with-jsonc'`of `eslint-plugin-jsonc`.
15
+ * @see https://ota-meshi.github.io/eslint-plugin-jsonc/user-guide/#usage
16
+ * @default false
17
+ */
18
+ jsonc?: boolean;
19
+ /**
20
+ * whether to enable config `'flat/recommended-with-json5'`of `eslint-plugin-jsonc`.
21
+ * @see https://ota-meshi.github.io/eslint-plugin-jsonc/user-guide/#usage
22
+ * @default false
23
+ */
24
+ json5?: boolean;
25
+ /**
26
+ * whether to enable config `'flat/prettier'`of `eslint-plugin-jsonc`.
27
+ * @see https://ota-meshi.github.io/eslint-plugin-jsonc/user-guide/#usage
28
+ * @default false
29
+ */
30
+ prettier?: boolean;
8
31
  }
9
- export declare function jsonc(options?: ((JsoncOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
32
+ /**
33
+ * `eslint-plugin-jsonc` and overrides configuration options
34
+ * @param {JsoncOptions & OverridesOptions} options
35
+ * eslint jsonc configuration options for json, jsonc, json5
36
+ * @returns {Promise<Linter.FlatConfig[]>}
37
+ * eslint flat configurations with `eslint-plugin-jsonc` and overrides
38
+ */
39
+ export declare function jsonc(options?: JsoncOptions & OverridesOptions<JsoncRules>): Promise<Linter.FlatConfig[]>;
@@ -1,4 +1,15 @@
1
1
  import type { Linter } from 'eslint';
2
- import type { OverridesOptions } from '../types';
3
- export interface PrettierOptions {}
4
- export declare function prettier(options?: ((PrettierOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
2
+ import type { OverridesOptions, PrettierRules } from '../types';
3
+ /**
4
+ * Prettier configuration options
5
+ */
6
+ export interface PrettierOptions {
7
+ }
8
+ /**
9
+ * `eslint-config-prettier` and overrides configuration options
10
+ * @param {PrettierOptions & OverridesOptions} options
11
+ * eslint configuration options for Prettier
12
+ * @returns {Promise<Linter.FlatConfig[]>}
13
+ * eslint flat configurations with `eslint-config-prettier` and overrides
14
+ */
15
+ export declare function prettier(options?: PrettierOptions & OverridesOptions<PrettierRules>): Promise<Linter.FlatConfig[]>;
@@ -1,4 +1,15 @@
1
1
  import type { Linter } from 'eslint';
2
- import type { OverridesOptions } from '../types';
3
- export interface PrettierOptions {}
4
- export declare function prettier(options?: ((PrettierOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
2
+ import type { OverridesOptions, PrettierRules } from '../types';
3
+ /**
4
+ * Prettier configuration options
5
+ */
6
+ export interface PrettierOptions {
7
+ }
8
+ /**
9
+ * `eslint-config-prettier` and overrides configuration options
10
+ * @param {PrettierOptions & OverridesOptions} options
11
+ * eslint configuration options for Prettier
12
+ * @returns {Promise<Linter.FlatConfig[]>}
13
+ * eslint flat configurations with `eslint-config-prettier` and overrides
14
+ */
15
+ export declare function prettier(options?: PrettierOptions & OverridesOptions<PrettierRules>): Promise<Linter.FlatConfig[]>;
@@ -1,4 +1,15 @@
1
1
  import type { Linter } from 'eslint';
2
- import type { OverridesOptions } from '../types';
3
- export interface PromiseOptions {}
4
- export declare function promise(options?: ((PromiseOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
2
+ import type { OverridesOptions, PromiseRules } from '../types';
3
+ /**
4
+ * eslint promise configuration options
5
+ */
6
+ export interface PromiseOptions {
7
+ }
8
+ /**
9
+ * `eslint-plugin-promise` and overrides configuration options
10
+ * @param {PromiseOptions & OverridesOptions} options
11
+ * eslint promise configuration options
12
+ * @returns {Promise<Linter.FlatConfig[]>}
13
+ * eslint flat configurations with `eslint-plugin-promise` and overrides
14
+ */
15
+ export declare function promise(options?: PromiseOptions & OverridesOptions<PromiseRules>): Promise<Linter.FlatConfig[]>;
@@ -1,4 +1,15 @@
1
1
  import type { Linter } from 'eslint';
2
- import type { OverridesOptions } from '../types';
3
- export interface PromiseOptions {}
4
- export declare function promise(options?: ((PromiseOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
2
+ import type { OverridesOptions, PromiseRules } from '../types';
3
+ /**
4
+ * eslint promise configuration options
5
+ */
6
+ export interface PromiseOptions {
7
+ }
8
+ /**
9
+ * `eslint-plugin-promise` and overrides configuration options
10
+ * @param {PromiseOptions & OverridesOptions} options
11
+ * eslint promise configuration options
12
+ * @returns {Promise<Linter.FlatConfig[]>}
13
+ * eslint flat configurations with `eslint-plugin-promise` and overrides
14
+ */
15
+ export declare function promise(options?: PromiseOptions & OverridesOptions<PromiseRules>): Promise<Linter.FlatConfig[]>;
@@ -1,4 +1,15 @@
1
1
  import type { Linter } from 'eslint';
2
- import type { OverridesOptions } from '../types';
3
- export interface RegexpOptions {}
4
- export declare function regexp(options?: ((RegexpOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
2
+ import type { OverridesOptions, RegexpRules } from '../types';
3
+ /**
4
+ * eslint regexp configuration options
5
+ */
6
+ export interface RegexpOptions {
7
+ }
8
+ /**
9
+ * `eslint-plugin-regexp` and overrides configuration options
10
+ * @param {RegexpOptions & OverridesOptions} options
11
+ * eslint regexp configuration options for regular expressions
12
+ * @returns {Promise<Linter.FlatConfig[]>}
13
+ * eslint flat configurations with `eslint-plugin-regexp` and overrides
14
+ */
15
+ export declare function regexp(options?: RegexpOptions & OverridesOptions<RegexpRules>): Promise<Linter.FlatConfig[]>;
@@ -1,4 +1,15 @@
1
1
  import type { Linter } from 'eslint';
2
- import type { OverridesOptions } from '../types';
3
- export interface RegexpOptions {}
4
- export declare function regexp(options?: ((RegexpOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
2
+ import type { OverridesOptions, RegexpRules } from '../types';
3
+ /**
4
+ * eslint regexp configuration options
5
+ */
6
+ export interface RegexpOptions {
7
+ }
8
+ /**
9
+ * `eslint-plugin-regexp` and overrides configuration options
10
+ * @param {RegexpOptions & OverridesOptions} options
11
+ * eslint regexp configuration options for regular expressions
12
+ * @returns {Promise<Linter.FlatConfig[]>}
13
+ * eslint flat configurations with `eslint-plugin-regexp` and overrides
14
+ */
15
+ export declare function regexp(options?: RegexpOptions & OverridesOptions<RegexpRules>): Promise<Linter.FlatConfig[]>;
@@ -1,11 +1,38 @@
1
1
  import type { Linter } from 'eslint';
2
- import type { OverridesOptions } from '../types';
2
+ import type { OverridesOptions, TypescriptRules } from '../types';
3
+ /**
4
+ * TypeScript configuration options
5
+ */
3
6
  export interface TypeScriptOptions {
4
- extraFileExtensions?: (string)[];
5
- parserOptions?: TypeScriptParserOptions;
7
+ /**
8
+ * Additional extensions for files.
9
+ * @see https://typescript-eslint.io/packages/parser/#extrafileextensions
10
+ */
11
+ extraFileExtensions?: string[];
12
+ /**
13
+ * typescript-eslint parser options
14
+ */
15
+ parserOptions?: TypeScriptParserOptions;
6
16
  }
17
+ /**
18
+ * @see https://typescript-eslint.io/getting-started/typed-linting
19
+ */
7
20
  export interface TypeScriptParserOptions {
8
- project?: ((boolean) | (string) | ((string)[]));
9
- tsconfigRootDir?: string;
21
+ /**
22
+ * @see https://typescript-eslint.io/packages/parser#project
23
+ * @default true
24
+ */
25
+ project?: boolean | string | string[];
26
+ /**
27
+ * @see https://typescript-eslint.io/packages/parser#tsconfigrootdir
28
+ */
29
+ tsconfigRootDir?: string;
10
30
  }
11
- export declare function typescript(options?: ((TypeScriptOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
31
+ /**
32
+ * `typescript-eslint` and overrides configuration options
33
+ * @param {TypeScriptOptions & OverridesOptions} options
34
+ * eslint configuration options for TypeScript
35
+ * @returns {Promise<Linter.FlatConfig[]>}
36
+ * eslint flat configurations with `typescript-eslint` and overrides
37
+ */
38
+ export declare function typescript(options?: TypeScriptOptions & OverridesOptions<TypescriptRules>): Promise<Linter.FlatConfig[]>;
@@ -1,11 +1,38 @@
1
1
  import type { Linter } from 'eslint';
2
- import type { OverridesOptions } from '../types';
2
+ import type { OverridesOptions, TypescriptRules } from '../types';
3
+ /**
4
+ * TypeScript configuration options
5
+ */
3
6
  export interface TypeScriptOptions {
4
- extraFileExtensions?: (string)[];
5
- parserOptions?: TypeScriptParserOptions;
7
+ /**
8
+ * Additional extensions for files.
9
+ * @see https://typescript-eslint.io/packages/parser/#extrafileextensions
10
+ */
11
+ extraFileExtensions?: string[];
12
+ /**
13
+ * typescript-eslint parser options
14
+ */
15
+ parserOptions?: TypeScriptParserOptions;
6
16
  }
17
+ /**
18
+ * @see https://typescript-eslint.io/getting-started/typed-linting
19
+ */
7
20
  export interface TypeScriptParserOptions {
8
- project?: ((boolean) | (string) | ((string)[]));
9
- tsconfigRootDir?: string;
21
+ /**
22
+ * @see https://typescript-eslint.io/packages/parser#project
23
+ * @default true
24
+ */
25
+ project?: boolean | string | string[];
26
+ /**
27
+ * @see https://typescript-eslint.io/packages/parser#tsconfigrootdir
28
+ */
29
+ tsconfigRootDir?: string;
10
30
  }
11
- export declare function typescript(options?: ((TypeScriptOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
31
+ /**
32
+ * `typescript-eslint` and overrides configuration options
33
+ * @param {TypeScriptOptions & OverridesOptions} options
34
+ * eslint configuration options for TypeScript
35
+ * @returns {Promise<Linter.FlatConfig[]>}
36
+ * eslint flat configurations with `typescript-eslint` and overrides
37
+ */
38
+ export declare function typescript(options?: TypeScriptOptions & OverridesOptions<TypescriptRules>): Promise<Linter.FlatConfig[]>;
@@ -1,4 +1,15 @@
1
1
  import type { Linter } from 'eslint';
2
- import type { OverridesOptions } from '../types';
3
- export interface UnicornOptions {}
4
- export declare function unicorn(options?: ((UnicornOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
2
+ import type { OverridesOptions, UnicornRules } from '../types';
3
+ /**
4
+ * eslint unicorn configuration options
5
+ */
6
+ export interface UnicornOptions {
7
+ }
8
+ /**
9
+ * `eslint-plugin-unicorn` and overrides configuration options
10
+ * @param {UnicornOptions & OverridesOptions} options
11
+ * eslint unicorn configuration options
12
+ * @returns {Promise<Linter.FlatConfig[]>}
13
+ * eslint flat configurations with `eslint-plugin-unicorn` and overrides
14
+ */
15
+ export declare function unicorn(options?: UnicornOptions & OverridesOptions<UnicornRules>): Promise<Linter.FlatConfig[]>;
@@ -1,4 +1,15 @@
1
1
  import type { Linter } from 'eslint';
2
- import type { OverridesOptions } from '../types';
3
- export interface UnicornOptions {}
4
- export declare function unicorn(options?: ((UnicornOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
2
+ import type { OverridesOptions, UnicornRules } from '../types';
3
+ /**
4
+ * eslint unicorn configuration options
5
+ */
6
+ export interface UnicornOptions {
7
+ }
8
+ /**
9
+ * `eslint-plugin-unicorn` and overrides configuration options
10
+ * @param {UnicornOptions & OverridesOptions} options
11
+ * eslint unicorn configuration options
12
+ * @returns {Promise<Linter.FlatConfig[]>}
13
+ * eslint flat configurations with `eslint-plugin-unicorn` and overrides
14
+ */
15
+ export declare function unicorn(options?: UnicornOptions & OverridesOptions<UnicornRules>): Promise<Linter.FlatConfig[]>;
@@ -1,7 +1,21 @@
1
1
  import type { Linter } from 'eslint';
2
- import type { OverridesOptions } from '../types';
3
2
  import type { TypeScriptOptions } from './typescript';
3
+ import type { OverridesOptions, VueRules } from '../types';
4
+ /**
5
+ * Vue configuration options
6
+ */
4
7
  export interface VueScriptOptions {
5
- typescript?: boolean;
8
+ /**
9
+ * use TypeScript in `template` block
10
+ * @default false
11
+ */
12
+ typescript?: boolean;
6
13
  }
7
- export declare function vue(options?: ((VueScriptOptions) & (TypeScriptOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
14
+ /**
15
+ * `eslint-plugin-vue` and overrides configuration options
16
+ * @param {VueScriptOptions & TypeScriptOptions & OverridesOptions} options
17
+ * eslint configuration options for Vue
18
+ * @returns {Promise<Linter.FlatConfig[]>}
19
+ * eslint flat configurations with `eslint-plugin-vue` and overrides
20
+ */
21
+ export declare function vue(options?: VueScriptOptions & TypeScriptOptions & OverridesOptions<VueRules>): Promise<Linter.FlatConfig[]>;
@@ -1,7 +1,21 @@
1
1
  import type { Linter } from 'eslint';
2
- import type { OverridesOptions } from '../types';
3
2
  import type { TypeScriptOptions } from './typescript';
3
+ import type { OverridesOptions, VueRules } from '../types';
4
+ /**
5
+ * Vue configuration options
6
+ */
4
7
  export interface VueScriptOptions {
5
- typescript?: boolean;
8
+ /**
9
+ * use TypeScript in `template` block
10
+ * @default false
11
+ */
12
+ typescript?: boolean;
6
13
  }
7
- export declare function vue(options?: ((VueScriptOptions) & (TypeScriptOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
14
+ /**
15
+ * `eslint-plugin-vue` and overrides configuration options
16
+ * @param {VueScriptOptions & TypeScriptOptions & OverridesOptions} options
17
+ * eslint configuration options for Vue
18
+ * @returns {Promise<Linter.FlatConfig[]>}
19
+ * eslint flat configurations with `eslint-plugin-vue` and overrides
20
+ */
21
+ export declare function vue(options?: VueScriptOptions & TypeScriptOptions & OverridesOptions<VueRules>): Promise<Linter.FlatConfig[]>;
@@ -1,7 +1,22 @@
1
1
  import type { Linter } from 'eslint';
2
- import type { OverridesOptions } from '../types';
2
+ import type { OverridesOptions, YmlRules } from '../types';
3
+ /**
4
+ * eslint yml configuration options
5
+ */
3
6
  export interface YmlOptions {
4
- prettier?: boolean;
7
+ /**
8
+ * whether to enable config `'flat/prettier'`of `eslint-plugin-jsonc`.
9
+ * @see https://ota-meshi.github.io/eslint-plugin-yml/user-guide/#configuration
10
+ * @default false
11
+ */
12
+ prettier?: boolean;
5
13
  }
6
- export declare function yml(options?: ((YmlOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
14
+ /**
15
+ * `eslint-plugin-yml` and overrides configuration options
16
+ * @param {YmlOptions & OverridesOptions} options
17
+ * eslint yml configuration options for yml, yaml
18
+ * @returns {Promise<Linter.FlatConfig[]>}
19
+ * eslint flat configurations with `eslint-plugin-yml` and overrides
20
+ */
21
+ export declare function yml(options?: YmlOptions & OverridesOptions<YmlRules>): Promise<Linter.FlatConfig[]>;
7
22
  export declare const yaml: typeof yml;
@@ -1,7 +1,22 @@
1
1
  import type { Linter } from 'eslint';
2
- import type { OverridesOptions } from '../types';
2
+ import type { OverridesOptions, YmlRules } from '../types';
3
+ /**
4
+ * eslint yml configuration options
5
+ */
3
6
  export interface YmlOptions {
4
- prettier?: boolean;
7
+ /**
8
+ * whether to enable config `'flat/prettier'`of `eslint-plugin-jsonc`.
9
+ * @see https://ota-meshi.github.io/eslint-plugin-yml/user-guide/#configuration
10
+ * @default false
11
+ */
12
+ prettier?: boolean;
5
13
  }
6
- export declare function yml(options?: ((YmlOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
14
+ /**
15
+ * `eslint-plugin-yml` and overrides configuration options
16
+ * @param {YmlOptions & OverridesOptions} options
17
+ * eslint yml configuration options for yml, yaml
18
+ * @returns {Promise<Linter.FlatConfig[]>}
19
+ * eslint flat configurations with `eslint-plugin-yml` and overrides
20
+ */
21
+ export declare function yml(options?: YmlOptions & OverridesOptions<YmlRules>): Promise<Linter.FlatConfig[]>;
7
22
  export declare const yaml: typeof yml;
package/dist/globs.d.cts CHANGED
@@ -1,9 +1,9 @@
1
- export declare const GLOB_JS = '**/*.?([cm])js';
2
- export declare const GLOB_JSX = '**/*.?([cm])jsx';
3
- export declare const GLOB_TS = '**/*.?([cm])ts';
4
- export declare const GLOB_TSX = '**/*.?([cm])tsx';
5
- export declare const GLOB_JSON = '**/*.json';
6
- export declare const GLOB_JSON5 = '**/*.json5';
7
- export declare const GLOB_JSONC = '**/*.jsonc';
8
- export declare const GLOB_YAML = '**/*.y?(a)ml';
9
- export declare const GLOB_VUE = '**/*.vue';
1
+ export declare const GLOB_JS = "**/*.?([cm])js";
2
+ export declare const GLOB_JSX = "**/*.?([cm])jsx";
3
+ export declare const GLOB_TS = "**/*.?([cm])ts";
4
+ export declare const GLOB_TSX = "**/*.?([cm])tsx";
5
+ export declare const GLOB_JSON = "**/*.json";
6
+ export declare const GLOB_JSON5 = "**/*.json5";
7
+ export declare const GLOB_JSONC = "**/*.jsonc";
8
+ export declare const GLOB_YAML = "**/*.y?(a)ml";
9
+ export declare const GLOB_VUE = "**/*.vue";