@kazupon/eslint-config 0.7.0 → 0.9.0

package/README.md

@@ -14,6 +14,7 @@ ESLint config for @kazupon
   - `typescript`
   - `jsdoc`
   - `regexp`
+  - `promise`
   - `unicorn`
   - `prettier`
   - `jsonc`
@@ -96,18 +97,19 @@ Add the following settings to your `.vscode/settings.json`:
 
 The following built-in configurations are supported:
 
-| Configuration | Powered by eslint plugin or package                                                            | Need to install eslint plugin or package? |
-| ------------- | ---------------------------------------------------------------------------------------------- | ----------------------------------------- |
-| `javascript`  | [`@eslint/js`](https://www.npmjs.com/package/@eslint/js)                                       | no (built-in)                             |
-| `comments`    | [`eslint-plugin-eslint-comments`](https://www.npmjs.com/package/eslint-plugin-eslint-comments) | no (built-in)                             |
-| `typescript`  | [`typescript-eslint`](https://www.npmjs.com/package/typescript-eslint)                         | yes                                       |
-| `jsdoc`       | [`eslint-plugin-jsdoc`](https://www.npmjs.com/package/eslint-plugin-jsdoc)                     | yes                                       |
-| `regexp`      | [`eslint-plugin-regexp`](https://www.npmjs.com/package/eslint-plugin-regexp)                   | yes                                       |
-| `unicorn`     | [`eslint-plugin-unicorn`](https://www.npmjs.com/package/eslint-plugin-unicorn)                 | yes                                       |
-| `prettier`    | [`eslint-config-prettier`](https://www.npmjs.com/package/eslint-config-prettier)               | yes                                       |
-| `jsonc`       | [`eslint-plugin-jsonc`](https://www.npmjs.com/package/eslint-plugin-jsonc)                     | yes                                       |
-| `vue`         | [`eslint-plugin-vue`](https://www.npmjs.com/package/eslint-plugin-vue)                         | yes                                       |
-| `yml`         | [`eslint-plugin-yml`](https://www.npmjs.com/package/eslint-plugin-yml)                         | yes                                       |
+| Configuration | Powered by eslint plugin or package                                                                                                | Need to install eslint plugin or package? |
+| ------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |
+| `javascript`  | [`@eslint/js`](https://www.npmjs.com/package/@eslint/js)                                                                           | no (built-in)                             |
+| `comments`    | [`@eslint-community/eslint-plugin-eslint-comments`](https://www.npmjs.com/package/@eslint-community/eslint-plugin-eslint-comments) | no (built-in)                             |
+| `typescript`  | [`typescript-eslint`](https://www.npmjs.com/package/typescript-eslint)                                                             | yes                                       |
+| `jsdoc`       | [`eslint-plugin-jsdoc`](https://www.npmjs.com/package/eslint-plugin-jsdoc)                                                         | yes                                       |
+| `regexp`      | [`eslint-plugin-regexp`](https://www.npmjs.com/package/eslint-plugin-regexp)                                                       | yes                                       |
+| `promise`     | [`eslint-plugin-promise`](https://www.npmjs.com/package/eslint-plugin-promise)                                                     | yes                                       |
+| `unicorn`     | [`eslint-plugin-unicorn`](https://www.npmjs.com/package/eslint-plugin-unicorn)                                                     | yes                                       |
+| `prettier`    | [`eslint-config-prettier`](https://www.npmjs.com/package/eslint-config-prettier)                                                   | yes                                       |
+| `jsonc`       | [`eslint-plugin-jsonc`](https://www.npmjs.com/package/eslint-plugin-jsonc)                                                         | yes                                       |
+| `vue`         | [`eslint-plugin-vue`](https://www.npmjs.com/package/eslint-plugin-vue)                                                             | yes                                       |
+| `yml`         | [`eslint-plugin-yml`](https://www.npmjs.com/package/eslint-plugin-yml)                                                             | yes                                       |
 
 You can use `import` syntax:
 
@@ -132,6 +134,7 @@ This eslint config is inspired by:
 
 - [`@antfu/eslint-config`](https://github.com/antfu/eslint-config), created by [Anthony Fu](https://github.com/antfu)
 - [`@sxzz/eslint-config`](https://github.com/sxzz/eslint-config), created by [Kevin Deng 三咲智子](https://github.com/sxzz)
+- [Vite](https://github.com/vitejs/vite), created by [Evan You](https://github.com/yyx990803) and Vite community
 
 Thank you! ❤️
 

package/dist/config.d.cts

@@ -1,4 +1,9 @@
 import { FlatConfigComposer } from 'eslint-flat-config-utils';
 import type { Linter } from 'eslint';
 import type { Awaitable } from './types';
-export declare function defineConfig(...configs: (Awaitable<((Linter.FlatConfig) | ((Linter.FlatConfig)[]))>)[]): FlatConfigComposer;
+/**
+ * define eslint configurations
+ * @param {Awaitable<Linter.FlatConfig | Linter.FlatConfig[]>[]} configs eslint flat configurations
+ * @returns {FlatConfigComposer} eslint flat configuration composer
+ */
+export declare function defineConfig(...configs: Awaitable<Linter.FlatConfig | Linter.FlatConfig[]>[]): FlatConfigComposer;

package/dist/config.d.ts

@@ -1,4 +1,9 @@
 import { FlatConfigComposer } from 'eslint-flat-config-utils';
 import type { Linter } from 'eslint';
 import type { Awaitable } from './types';
-export declare function defineConfig(...configs: (Awaitable<((Linter.FlatConfig) | ((Linter.FlatConfig)[]))>)[]): FlatConfigComposer;
+/**
+ * define eslint configurations
+ * @param {Awaitable<Linter.FlatConfig | Linter.FlatConfig[]>[]} configs eslint flat configurations
+ * @returns {FlatConfigComposer} eslint flat configuration composer
+ */
+export declare function defineConfig(...configs: Awaitable<Linter.FlatConfig | Linter.FlatConfig[]>[]): FlatConfigComposer;

package/dist/configs/comments.d.cts

@@ -1,4 +1,15 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions } from '../types';
-export interface CommentsOptions {}
-export declare function comments(options?: ((CommentsOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
+import type { OverridesOptions, CommentsRules } from '../types';
+/**
+ * eslint comments configuration options
+ */
+export interface CommentsOptions {
+}
+/**
+ * `@eslint-community/eslint-plugin-eslint-comments` and overrides configuration options
+ * @param {CommentsOptions & OverridesOptions} options
+ *  eslint comments configuration options for eslint comment directives
+ * @returns {Promise<Linter.FlatConfig[]>}
+ *  eslint flat configurations with `@eslint-community/eslint-plugin-eslint-comments` and overrides
+ */
+export declare function comments(options?: CommentsOptions & OverridesOptions<CommentsRules>): Promise<Linter.FlatConfig[]>;

package/dist/configs/comments.d.ts

@@ -1,4 +1,15 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions } from '../types';
-export interface CommentsOptions {}
-export declare function comments(options?: ((CommentsOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
+import type { OverridesOptions, CommentsRules } from '../types';
+/**
+ * eslint comments configuration options
+ */
+export interface CommentsOptions {
+}
+/**
+ * `@eslint-community/eslint-plugin-eslint-comments` and overrides configuration options
+ * @param {CommentsOptions & OverridesOptions} options
+ *  eslint comments configuration options for eslint comment directives
+ * @returns {Promise<Linter.FlatConfig[]>}
+ *  eslint flat configurations with `@eslint-community/eslint-plugin-eslint-comments` and overrides
+ */
+export declare function comments(options?: CommentsOptions & OverridesOptions<CommentsRules>): Promise<Linter.FlatConfig[]>;

package/dist/configs/index.d.cts

@@ -2,6 +2,7 @@ export * from './javascript';
 export * from './comments';
 export * from './typescript';
 export * from './jsdoc';
+export * from './promise';
 export * from './regexp';
 export * from './unicorn';
 export * from './prettier';

package/dist/configs/index.d.ts

@@ -2,6 +2,7 @@ export * from './javascript';
 export * from './comments';
 export * from './typescript';
 export * from './jsdoc';
+export * from './promise';
 export * from './regexp';
 export * from './unicorn';
 export * from './prettier';

package/dist/configs/javascript.d.cts

@@ -1,4 +1,15 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions } from '../types';
-export interface JavaScriptOptions {}
-export declare function javascript(options?: ((JavaScriptOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
+import type { OverridesOptions, JavascriptRules } from '../types';
+/**
+ * JavaScript configuration options
+ */
+export interface JavaScriptOptions {
+}
+/**
+ * `@eslint/js` and overrides configuration options
+ * @param {JavaScriptOptions & OverridesOptions} options
+ * eslint configuration options for JavaScript
+ * @returns {Promise<Linter.FlatConfig[]>}
+ * eslint flat configurations with `@eslint/js` and overrides
+ */
+export declare function javascript(options?: JavaScriptOptions & OverridesOptions<JavascriptRules>): Promise<Linter.FlatConfig[]>;

package/dist/configs/javascript.d.ts

@@ -1,4 +1,15 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions } from '../types';
-export interface JavaScriptOptions {}
-export declare function javascript(options?: ((JavaScriptOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
+import type { OverridesOptions, JavascriptRules } from '../types';
+/**
+ * JavaScript configuration options
+ */
+export interface JavaScriptOptions {
+}
+/**
+ * `@eslint/js` and overrides configuration options
+ * @param {JavaScriptOptions & OverridesOptions} options
+ * eslint configuration options for JavaScript
+ * @returns {Promise<Linter.FlatConfig[]>}
+ * eslint flat configurations with `@eslint/js` and overrides
+ */
+export declare function javascript(options?: JavaScriptOptions & OverridesOptions<JavascriptRules>): Promise<Linter.FlatConfig[]>;

package/dist/configs/jsdoc.d.cts

@@ -1,7 +1,27 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions } from '../types';
+import type { OverridesOptions, JsdocRules } from '../types';
+/**
+ * jsdoc configuration options
+ */
 export interface JsDocumentOptions {
-	typescript?: (('syntax') | ('flavor'));
-	error?: boolean;
+    /**
+     * 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`.
+     * @see https://github.com/gajus/eslint-plugin-jsdoc?tab=readme-ov-file#configuration
+     * @default undefined
+     */
+    typescript?: 'syntax' | 'flavor';
+    /**
+     * If you wish to have all linting issues reported as failing errors, you can set this to `true`.
+     * @see https://github.com/gajus/eslint-plugin-jsdoc?tab=readme-ov-file#configuration
+     * @default false
+     */
+    error?: boolean;
 }
-export declare function jsdoc(options?: ((JsDocumentOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
+/**
+ * `eslint-plugin-jsdoc` and overrides configuration options
+ * @param {JsDocOptions & OverridesOptions} options
+ * eslint configuration options for JavaScript
+ * @returns {Promise<Linter.FlatConfig[]>}
+ * eslint flat configurations with `eslint-plugin-jsdoc` and overrides
+ */
+export declare function jsdoc(options?: JsDocumentOptions & OverridesOptions<JsdocRules>): Promise<Linter.FlatConfig[]>;

package/dist/configs/jsdoc.d.ts

@@ -1,7 +1,27 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions } from '../types';
+import type { OverridesOptions, JsdocRules } from '../types';
+/**
+ * jsdoc configuration options
+ */
 export interface JsDocumentOptions {
-	typescript?: (('syntax') | ('flavor'));
-	error?: boolean;
+    /**
+     * 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`.
+     * @see https://github.com/gajus/eslint-plugin-jsdoc?tab=readme-ov-file#configuration
+     * @default undefined
+     */
+    typescript?: 'syntax' | 'flavor';
+    /**
+     * If you wish to have all linting issues reported as failing errors, you can set this to `true`.
+     * @see https://github.com/gajus/eslint-plugin-jsdoc?tab=readme-ov-file#configuration
+     * @default false
+     */
+    error?: boolean;
 }
-export declare function jsdoc(options?: ((JsDocumentOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
+/**
+ * `eslint-plugin-jsdoc` and overrides configuration options
+ * @param {JsDocOptions & OverridesOptions} options
+ * eslint configuration options for JavaScript
+ * @returns {Promise<Linter.FlatConfig[]>}
+ * eslint flat configurations with `eslint-plugin-jsdoc` and overrides
+ */
+export declare function jsdoc(options?: JsDocumentOptions & OverridesOptions<JsdocRules>): Promise<Linter.FlatConfig[]>;

package/dist/configs/jsonc.d.cts

@@ -1,9 +1,39 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions } from '../types';
+import type { OverridesOptions, JsoncRules } from '../types';
+/**
+ * eslint jsonc configuration options
+ */
 export interface JsoncOptions {
-	json?: boolean;
-	jsonc?: boolean;
-	json5?: boolean;
-	prettier?: boolean;
+    /**
+     * whether to enable config `'flat/recommended-with-json'`of `eslint-plugin-jsonc`.
+     * @see https://ota-meshi.github.io/eslint-plugin-jsonc/user-guide/#usage
+     * @default false
+     */
+    json?: boolean;
+    /**
+     * whether to enable config `'flat/recommended-with-jsonc'`of `eslint-plugin-jsonc`.
+     * @see https://ota-meshi.github.io/eslint-plugin-jsonc/user-guide/#usage
+     * @default false
+     */
+    jsonc?: boolean;
+    /**
+     * whether to enable config `'flat/recommended-with-json5'`of `eslint-plugin-jsonc`.
+     * @see https://ota-meshi.github.io/eslint-plugin-jsonc/user-guide/#usage
+     * @default false
+     */
+    json5?: boolean;
+    /**
+     * whether to enable config `'flat/prettier'`of `eslint-plugin-jsonc`.
+     * @see https://ota-meshi.github.io/eslint-plugin-jsonc/user-guide/#usage
+     * @default false
+     */
+    prettier?: boolean;
 }
-export declare function jsonc(options?: ((JsoncOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
+/**
+ * `eslint-plugin-jsonc` and overrides configuration options
+ * @param {JsoncOptions & OverridesOptions} options
+ *  eslint jsonc configuration options for json, jsonc, json5
+ * @returns {Promise<Linter.FlatConfig[]>}
+ *  eslint flat configurations with `eslint-plugin-jsonc` and overrides
+ */
+export declare function jsonc(options?: JsoncOptions & OverridesOptions<JsoncRules>): Promise<Linter.FlatConfig[]>;

package/dist/configs/jsonc.d.ts

@@ -1,9 +1,39 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions } from '../types';
+import type { OverridesOptions, JsoncRules } from '../types';
+/**
+ * eslint jsonc configuration options
+ */
 export interface JsoncOptions {
-	json?: boolean;
-	jsonc?: boolean;
-	json5?: boolean;
-	prettier?: boolean;
+    /**
+     * whether to enable config `'flat/recommended-with-json'`of `eslint-plugin-jsonc`.
+     * @see https://ota-meshi.github.io/eslint-plugin-jsonc/user-guide/#usage
+     * @default false
+     */
+    json?: boolean;
+    /**
+     * whether to enable config `'flat/recommended-with-jsonc'`of `eslint-plugin-jsonc`.
+     * @see https://ota-meshi.github.io/eslint-plugin-jsonc/user-guide/#usage
+     * @default false
+     */
+    jsonc?: boolean;
+    /**
+     * whether to enable config `'flat/recommended-with-json5'`of `eslint-plugin-jsonc`.
+     * @see https://ota-meshi.github.io/eslint-plugin-jsonc/user-guide/#usage
+     * @default false
+     */
+    json5?: boolean;
+    /**
+     * whether to enable config `'flat/prettier'`of `eslint-plugin-jsonc`.
+     * @see https://ota-meshi.github.io/eslint-plugin-jsonc/user-guide/#usage
+     * @default false
+     */
+    prettier?: boolean;
 }
-export declare function jsonc(options?: ((JsoncOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
+/**
+ * `eslint-plugin-jsonc` and overrides configuration options
+ * @param {JsoncOptions & OverridesOptions} options
+ *  eslint jsonc configuration options for json, jsonc, json5
+ * @returns {Promise<Linter.FlatConfig[]>}
+ *  eslint flat configurations with `eslint-plugin-jsonc` and overrides
+ */
+export declare function jsonc(options?: JsoncOptions & OverridesOptions<JsoncRules>): Promise<Linter.FlatConfig[]>;

package/dist/configs/prettier.d.cts

@@ -1,4 +1,15 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions } from '../types';
-export interface PrettierOptions {}
-export declare function prettier(options?: ((PrettierOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
+import type { OverridesOptions, PrettierRules } from '../types';
+/**
+ * Prettier configuration options
+ */
+export interface PrettierOptions {
+}
+/**
+ * `eslint-config-prettier` and overrides configuration options
+ * @param {PrettierOptions & OverridesOptions} options
+ * eslint configuration options for Prettier
+ * @returns {Promise<Linter.FlatConfig[]>}
+ * eslint flat configurations with `eslint-config-prettier` and overrides
+ */
+export declare function prettier(options?: PrettierOptions & OverridesOptions<PrettierRules>): Promise<Linter.FlatConfig[]>;

package/dist/configs/prettier.d.ts

@@ -1,4 +1,15 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions } from '../types';
-export interface PrettierOptions {}
-export declare function prettier(options?: ((PrettierOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
+import type { OverridesOptions, PrettierRules } from '../types';
+/**
+ * Prettier configuration options
+ */
+export interface PrettierOptions {
+}
+/**
+ * `eslint-config-prettier` and overrides configuration options
+ * @param {PrettierOptions & OverridesOptions} options
+ * eslint configuration options for Prettier
+ * @returns {Promise<Linter.FlatConfig[]>}
+ * eslint flat configurations with `eslint-config-prettier` and overrides
+ */
+export declare function prettier(options?: PrettierOptions & OverridesOptions<PrettierRules>): Promise<Linter.FlatConfig[]>;

package/dist/configs/promise.d.cts

@@ -0,0 +1,15 @@
+import type { Linter } from 'eslint';
+import type { OverridesOptions, PromiseRules } from '../types';
+/**
+ * eslint promise configuration options
+ */
+export interface PromiseOptions {
+}
+/**
+ * `eslint-plugin-promise` and overrides configuration options
+ * @param {PromiseOptions & OverridesOptions} options
+ *  eslint promise configuration options
+ * @returns {Promise<Linter.FlatConfig[]>}
+ *  eslint flat configurations with `eslint-plugin-promise` and overrides
+ */
+export declare function promise(options?: PromiseOptions & OverridesOptions<PromiseRules>): Promise<Linter.FlatConfig[]>;

package/dist/configs/promise.d.ts

@@ -0,0 +1,15 @@
+import type { Linter } from 'eslint';
+import type { OverridesOptions, PromiseRules } from '../types';
+/**
+ * eslint promise configuration options
+ */
+export interface PromiseOptions {
+}
+/**
+ * `eslint-plugin-promise` and overrides configuration options
+ * @param {PromiseOptions & OverridesOptions} options
+ *  eslint promise configuration options
+ * @returns {Promise<Linter.FlatConfig[]>}
+ *  eslint flat configurations with `eslint-plugin-promise` and overrides
+ */
+export declare function promise(options?: PromiseOptions & OverridesOptions<PromiseRules>): Promise<Linter.FlatConfig[]>;

package/dist/configs/regexp.d.cts

@@ -1,4 +1,15 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions } from '../types';
-export interface RegexpOptions {}
-export declare function regexp(options?: ((RegexpOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
+import type { OverridesOptions, RegexpRules } from '../types';
+/**
+ * eslint regexp configuration options
+ */
+export interface RegexpOptions {
+}
+/**
+ * `eslint-plugin-regexp` and overrides configuration options
+ * @param {RegexpOptions & OverridesOptions} options
+ *  eslint regexp configuration options for regular expressions
+ * @returns {Promise<Linter.FlatConfig[]>}
+ *  eslint flat configurations with `eslint-plugin-regexp` and overrides
+ */
+export declare function regexp(options?: RegexpOptions & OverridesOptions<RegexpRules>): Promise<Linter.FlatConfig[]>;

package/dist/configs/regexp.d.ts

@@ -1,4 +1,15 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions } from '../types';
-export interface RegexpOptions {}
-export declare function regexp(options?: ((RegexpOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
+import type { OverridesOptions, RegexpRules } from '../types';
+/**
+ * eslint regexp configuration options
+ */
+export interface RegexpOptions {
+}
+/**
+ * `eslint-plugin-regexp` and overrides configuration options
+ * @param {RegexpOptions & OverridesOptions} options
+ *  eslint regexp configuration options for regular expressions
+ * @returns {Promise<Linter.FlatConfig[]>}
+ *  eslint flat configurations with `eslint-plugin-regexp` and overrides
+ */
+export declare function regexp(options?: RegexpOptions & OverridesOptions<RegexpRules>): Promise<Linter.FlatConfig[]>;

package/dist/configs/typescript.d.cts

@@ -1,11 +1,38 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions } from '../types';
+import type { OverridesOptions, TypescriptRules } from '../types';
+/**
+ * TypeScript configuration options
+ */
 export interface TypeScriptOptions {
-	extraFileExtensions?: (string)[];
-	parserOptions?: TypeScriptParserOptions;
+    /**
+     * Additional extensions for files.
+     * @see https://typescript-eslint.io/packages/parser/#extrafileextensions
+     */
+    extraFileExtensions?: string[];
+    /**
+     * typescript-eslint parser options
+     */
+    parserOptions?: TypeScriptParserOptions;
 }
+/**
+ * @see https://typescript-eslint.io/getting-started/typed-linting
+ */
 export interface TypeScriptParserOptions {
-	project?: ((boolean) | (string) | ((string)[]));
-	tsconfigRootDir?: string;
+    /**
+     * @see https://typescript-eslint.io/packages/parser#project
+     * @default true
+     */
+    project?: boolean | string | string[];
+    /**
+     * @see https://typescript-eslint.io/packages/parser#tsconfigrootdir
+     */
+    tsconfigRootDir?: string;
 }
-export declare function typescript(options?: ((TypeScriptOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
+/**
+ * `typescript-eslint` and overrides configuration options
+ * @param {TypeScriptOptions & OverridesOptions} options
+ * eslint configuration options for TypeScript
+ * @returns {Promise<Linter.FlatConfig[]>}
+ * eslint flat configurations with `typescript-eslint` and overrides
+ */
+export declare function typescript(options?: TypeScriptOptions & OverridesOptions<TypescriptRules>): Promise<Linter.FlatConfig[]>;

package/dist/configs/typescript.d.ts

@@ -1,11 +1,38 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions } from '../types';
+import type { OverridesOptions, TypescriptRules } from '../types';
+/**
+ * TypeScript configuration options
+ */
 export interface TypeScriptOptions {
-	extraFileExtensions?: (string)[];
-	parserOptions?: TypeScriptParserOptions;
+    /**
+     * Additional extensions for files.
+     * @see https://typescript-eslint.io/packages/parser/#extrafileextensions
+     */
+    extraFileExtensions?: string[];
+    /**
+     * typescript-eslint parser options
+     */
+    parserOptions?: TypeScriptParserOptions;
 }
+/**
+ * @see https://typescript-eslint.io/getting-started/typed-linting
+ */
 export interface TypeScriptParserOptions {
-	project?: ((boolean) | (string) | ((string)[]));
-	tsconfigRootDir?: string;
+    /**
+     * @see https://typescript-eslint.io/packages/parser#project
+     * @default true
+     */
+    project?: boolean | string | string[];
+    /**
+     * @see https://typescript-eslint.io/packages/parser#tsconfigrootdir
+     */
+    tsconfigRootDir?: string;
 }
-export declare function typescript(options?: ((TypeScriptOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
+/**
+ * `typescript-eslint` and overrides configuration options
+ * @param {TypeScriptOptions & OverridesOptions} options
+ * eslint configuration options for TypeScript
+ * @returns {Promise<Linter.FlatConfig[]>}
+ * eslint flat configurations with `typescript-eslint` and overrides
+ */
+export declare function typescript(options?: TypeScriptOptions & OverridesOptions<TypescriptRules>): Promise<Linter.FlatConfig[]>;

package/dist/configs/unicorn.d.cts

@@ -1,4 +1,15 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions } from '../types';
-export interface UnicornOptions {}
-export declare function unicorn(options?: ((UnicornOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
+import type { OverridesOptions, UnicornRules } from '../types';
+/**
+ * eslint unicorn configuration options
+ */
+export interface UnicornOptions {
+}
+/**
+ * `eslint-plugin-unicorn` and overrides configuration options
+ * @param {UnicornOptions & OverridesOptions} options
+ *  eslint unicorn configuration options
+ * @returns {Promise<Linter.FlatConfig[]>}
+ *  eslint flat configurations with `eslint-plugin-unicorn` and overrides
+ */
+export declare function unicorn(options?: UnicornOptions & OverridesOptions<UnicornRules>): Promise<Linter.FlatConfig[]>;

package/dist/configs/unicorn.d.ts

@@ -1,4 +1,15 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions } from '../types';
-export interface UnicornOptions {}
-export declare function unicorn(options?: ((UnicornOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
+import type { OverridesOptions, UnicornRules } from '../types';
+/**
+ * eslint unicorn configuration options
+ */
+export interface UnicornOptions {
+}
+/**
+ * `eslint-plugin-unicorn` and overrides configuration options
+ * @param {UnicornOptions & OverridesOptions} options
+ *  eslint unicorn configuration options
+ * @returns {Promise<Linter.FlatConfig[]>}
+ *  eslint flat configurations with `eslint-plugin-unicorn` and overrides
+ */
+export declare function unicorn(options?: UnicornOptions & OverridesOptions<UnicornRules>): Promise<Linter.FlatConfig[]>;

package/dist/configs/vue.d.cts

@@ -1,7 +1,21 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions } from '../types';
 import type { TypeScriptOptions } from './typescript';
+import type { OverridesOptions, VueRules } from '../types';
+/**
+ * Vue configuration options
+ */
 export interface VueScriptOptions {
-	typescript?: boolean;
+    /**
+     * use TypeScript in `template` block
+     * @default false
+     */
+    typescript?: boolean;
 }
-export declare function vue(options?: ((VueScriptOptions) & (TypeScriptOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
+/**
+ * `eslint-plugin-vue` and overrides configuration options
+ * @param {VueScriptOptions & TypeScriptOptions & OverridesOptions} options
+ * eslint configuration options for Vue
+ * @returns {Promise<Linter.FlatConfig[]>}
+ * eslint flat configurations with `eslint-plugin-vue` and overrides
+ */
+export declare function vue(options?: VueScriptOptions & TypeScriptOptions & OverridesOptions<VueRules>): Promise<Linter.FlatConfig[]>;

package/dist/configs/vue.d.ts

@@ -1,7 +1,21 @@
 import type { Linter } from 'eslint';
-import type { OverridesOptions } from '../types';
 import type { TypeScriptOptions } from './typescript';
+import type { OverridesOptions, VueRules } from '../types';
+/**
+ * Vue configuration options
+ */
 export interface VueScriptOptions {
-	typescript?: boolean;
+    /**
+     * use TypeScript in `template` block
+     * @default false
+     */
+    typescript?: boolean;
 }
-export declare function vue(options?: ((VueScriptOptions) & (TypeScriptOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
+/**
+ * `eslint-plugin-vue` and overrides configuration options
+ * @param {VueScriptOptions & TypeScriptOptions & OverridesOptions} options
+ * eslint configuration options for Vue
+ * @returns {Promise<Linter.FlatConfig[]>}
+ * eslint flat configurations with `eslint-plugin-vue` and overrides
+ */
+export declare function vue(options?: VueScriptOptions & TypeScriptOptions & OverridesOptions<VueRules>): Promise<Linter.FlatConfig[]>;