@coderwyd/eslint-config 1.1.0-beta.2 → 1.1.0-beta.3

package/dist/index.d.cts

@@ -1,21 +1,27 @@
-import { FlatESLintConfigItem } from 'eslint-define-config';
 import { FlatGitignoreOptions } from 'eslint-config-flat-gitignore';
 import { ParserOptions } from '@typescript-eslint/parser';
-export { default as parserTs } from '@typescript-eslint/parser';
+import * as parser from '@typescript-eslint/parser';
+export { parser as parserTs };
+import { Linter, ESLint } from 'eslint';
+import { LanguageOptions, LinterOptions } from 'eslint-define-config';
 export { default as pluginAntfu } from 'eslint-plugin-antfu';
 export { default as pluginComments } from 'eslint-plugin-eslint-comments';
-export { default as pluginImport } from 'eslint-plugin-i';
+import * as eslintPluginI from 'eslint-plugin-i';
+export { eslintPluginI as pluginImport };
 export { default as pluginJsdoc } from 'eslint-plugin-jsdoc';
-export { default as pluginJsonc } from 'eslint-plugin-jsonc';
+import * as eslintPluginJsonc from 'eslint-plugin-jsonc';
+export { eslintPluginJsonc as pluginJsonc };
 export { default as pluginMarkdown } from 'eslint-plugin-markdown';
 export { default as pluginNode } from 'eslint-plugin-n';
 export { default as pluginStylistic } from '@stylistic/eslint-plugin';
 export { default as pluginTs } from '@typescript-eslint/eslint-plugin';
 export { default as pluginUnicorn } from 'eslint-plugin-unicorn';
 export { default as pluginUnusedImports } from 'eslint-plugin-unused-imports';
-export { default as pluginVue } from 'eslint-plugin-vue';
-export { default as pluginYaml } from 'eslint-plugin-yml';
+import * as eslintPluginYml from 'eslint-plugin-yml';
+export { eslintPluginYml as pluginYaml };
 export { default as pluginNoOnlyTests } from 'eslint-plugin-no-only-tests';
+export { default as pluginVitest } from 'eslint-plugin-vitest';
+export { default as pluginVue } from 'eslint-plugin-vue';
 export { default as pluginReact } from 'eslint-plugin-react';
 export { default as pluginReactHooks } from 'eslint-plugin-react-hooks';
 export { default as pluginAstro } from 'eslint-plugin-astro';
@@ -24,6 +30,63 @@ export { default as parserYaml } from 'yaml-eslint-parser';
 export { default as parserJsonc } from 'jsonc-eslint-parser';
 export { default as parserAstro } from 'astro-eslint-parser';
 
+/**
+ * Flat ESLint Configuration.
+ *
+ * @see [Configuration Files (New)](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new)
+ */
+interface FlatESLintConfigItem {
+    /**
+     * The name of the configuration object.
+     */
+    name?: string;
+    /**
+     * An array of glob patterns indicating the files that the configuration object should apply to. If not specified, the configuration object applies to all files.
+     *
+     * @see [Ignore Patterns](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#excluding-files-with-ignores)
+     */
+    files?: string[];
+    /**
+     * An array of glob patterns indicating the files that the configuration object should not apply to. If not specified, the configuration object applies to all files matched by files.
+     *
+     * @see [Ignore Patterns](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#excluding-files-with-ignores)
+     */
+    ignores?: string[];
+    /**
+     * An object containing settings related to how JavaScript is configured for linting.
+     *
+     * @see [Configuring language options](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#configuring-language-options)
+     */
+    languageOptions?: LanguageOptions;
+    /**
+     * An object containing settings related to the linting process.
+     */
+    linterOptions?: LinterOptions;
+    /**
+     * Either an object containing `preprocess()` and `postprocess()` methods or a string indicating the name of a processor inside of a plugin (i.e., `"pluginName/processorName"`).
+     *
+     * @see [Using processors](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#using-processors)
+     */
+    processor?: string | Linter.Processor;
+    /**
+     * 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, ESLint.Plugin>;
+    /**
+     * An object containing the configured rules. When `files` or `ignores` are specified, these rule configurations are only available to the matching files.
+     *
+     * @see [Configuring rules](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#configuring-rules)
+     */
+    rules?: Record<string, Linter.RuleLevel | Linter.RuleLevelAndOptions>;
+    /**
+     * An object containing name-value pairs of information that should be available to all rules.
+     *
+     * @see [Configuring shared settings](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#configuring-shared-settings)
+     */
+    settings?: Record<string, any>;
+}
 interface OptionsComponentExts {
     /**
      * Additional extensions for components.
@@ -50,7 +113,11 @@ interface OptionsHasTypeScript {
     typescript?: boolean;
 }
 interface OptionsStylistic {
-    stylistic?: boolean;
+    stylistic?: boolean | StylisticConfig;
+}
+interface StylisticConfig {
+    indent?: number | 'tab';
+    quotes?: 'single' | 'double';
 }
 interface OptionsOverrides {
     overrides?: FlatESLintConfigItem['rules'];
@@ -123,7 +190,7 @@ interface OptionsConfig extends OptionsComponentExts {
      *
      * @default true
      */
-    stylistic?: boolean;
+    stylistic?: boolean | StylisticConfig;
     /**
      * Control to disable some rules in editors.
      * @default auto-detect based on the process.env
@@ -179,7 +246,7 @@ declare function sortPackageJson(): FlatESLintConfigItem[];
  */
 declare function sortTsconfig(): FlatESLintConfigItem[];
 
-declare function stylistic(): FlatESLintConfigItem[];
+declare function stylistic(options?: StylisticConfig): FlatESLintConfigItem[];
 
 declare function typescript(options?: OptionsComponentExts & OptionsOverrides & OptionsTypeScriptWithTypes & OptionsTypeScriptParserOptions): FlatESLintConfigItem[];
 
@@ -192,7 +259,7 @@ declare function yaml(options?: OptionsOverrides & OptionsStylistic): FlatESLint
 
 declare function test(options?: OptionsIsInEditor & OptionsOverrides): FlatESLintConfigItem[];
 
-declare function react(options?: OptionsHasTypeScript & OptionsOverrides): FlatESLintConfigItem[];
+declare function react(options?: OptionsHasTypeScript & OptionsOverrides & OptionsStylistic): FlatESLintConfigItem[];
 
 declare function astro(options?: OptionsHasTypeScript & OptionsOverrides): FlatESLintConfigItem[];
 
@@ -227,4 +294,4 @@ declare const GLOB_TESTS: string[];
 declare const GLOB_ALL_SRC: string[];
 declare const GLOB_EXCLUDE: string[];
 
-export { GLOB_ALL_SRC, GLOB_ASTRO, GLOB_CSS, GLOB_EXCLUDE, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_TESTS, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_YAML, OptionsComponentExts, OptionsConfig, OptionsHasTypeScript, OptionsIsInEditor, OptionsOverrides, OptionsStylistic, OptionsTypeScriptParserOptions, OptionsTypeScriptWithTypes, astro, coderwyd, combine, comments, coderwyd as default, getVueVersion, ignores, imports, javascript, jsdoc, jsonc, markdown, node, react, renameRules, sortPackageJson, sortTsconfig, stylistic, test, typescript, unicorn, vue, yaml };
+export { FlatESLintConfigItem, GLOB_ALL_SRC, GLOB_ASTRO, GLOB_CSS, GLOB_EXCLUDE, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_TESTS, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_YAML, OptionsComponentExts, OptionsConfig, OptionsHasTypeScript, OptionsIsInEditor, OptionsOverrides, OptionsStylistic, OptionsTypeScriptParserOptions, OptionsTypeScriptWithTypes, StylisticConfig, astro, coderwyd, combine, comments, coderwyd as default, getVueVersion, ignores, imports, javascript, jsdoc, jsonc, markdown, node, react, renameRules, sortPackageJson, sortTsconfig, stylistic, test, typescript, unicorn, vue, yaml };

package/dist/index.d.ts

@@ -1,21 +1,27 @@
-import { FlatESLintConfigItem } from 'eslint-define-config';
 import { FlatGitignoreOptions } from 'eslint-config-flat-gitignore';
 import { ParserOptions } from '@typescript-eslint/parser';
-export { default as parserTs } from '@typescript-eslint/parser';
+import * as parser from '@typescript-eslint/parser';
+export { parser as parserTs };
+import { Linter, ESLint } from 'eslint';
+import { LanguageOptions, LinterOptions } from 'eslint-define-config';
 export { default as pluginAntfu } from 'eslint-plugin-antfu';
 export { default as pluginComments } from 'eslint-plugin-eslint-comments';
-export { default as pluginImport } from 'eslint-plugin-i';
+import * as eslintPluginI from 'eslint-plugin-i';
+export { eslintPluginI as pluginImport };
 export { default as pluginJsdoc } from 'eslint-plugin-jsdoc';
-export { default as pluginJsonc } from 'eslint-plugin-jsonc';
+import * as eslintPluginJsonc from 'eslint-plugin-jsonc';
+export { eslintPluginJsonc as pluginJsonc };
 export { default as pluginMarkdown } from 'eslint-plugin-markdown';
 export { default as pluginNode } from 'eslint-plugin-n';
 export { default as pluginStylistic } from '@stylistic/eslint-plugin';
 export { default as pluginTs } from '@typescript-eslint/eslint-plugin';
 export { default as pluginUnicorn } from 'eslint-plugin-unicorn';
 export { default as pluginUnusedImports } from 'eslint-plugin-unused-imports';
-export { default as pluginVue } from 'eslint-plugin-vue';
-export { default as pluginYaml } from 'eslint-plugin-yml';
+import * as eslintPluginYml from 'eslint-plugin-yml';
+export { eslintPluginYml as pluginYaml };
 export { default as pluginNoOnlyTests } from 'eslint-plugin-no-only-tests';
+export { default as pluginVitest } from 'eslint-plugin-vitest';
+export { default as pluginVue } from 'eslint-plugin-vue';
 export { default as pluginReact } from 'eslint-plugin-react';
 export { default as pluginReactHooks } from 'eslint-plugin-react-hooks';
 export { default as pluginAstro } from 'eslint-plugin-astro';
@@ -24,6 +30,63 @@ export { default as parserYaml } from 'yaml-eslint-parser';
 export { default as parserJsonc } from 'jsonc-eslint-parser';
 export { default as parserAstro } from 'astro-eslint-parser';
 
+/**
+ * Flat ESLint Configuration.
+ *
+ * @see [Configuration Files (New)](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new)
+ */
+interface FlatESLintConfigItem {
+    /**
+     * The name of the configuration object.
+     */
+    name?: string;
+    /**
+     * An array of glob patterns indicating the files that the configuration object should apply to. If not specified, the configuration object applies to all files.
+     *
+     * @see [Ignore Patterns](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#excluding-files-with-ignores)
+     */
+    files?: string[];
+    /**
+     * An array of glob patterns indicating the files that the configuration object should not apply to. If not specified, the configuration object applies to all files matched by files.
+     *
+     * @see [Ignore Patterns](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#excluding-files-with-ignores)
+     */
+    ignores?: string[];
+    /**
+     * An object containing settings related to how JavaScript is configured for linting.
+     *
+     * @see [Configuring language options](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#configuring-language-options)
+     */
+    languageOptions?: LanguageOptions;
+    /**
+     * An object containing settings related to the linting process.
+     */
+    linterOptions?: LinterOptions;
+    /**
+     * Either an object containing `preprocess()` and `postprocess()` methods or a string indicating the name of a processor inside of a plugin (i.e., `"pluginName/processorName"`).
+     *
+     * @see [Using processors](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#using-processors)
+     */
+    processor?: string | Linter.Processor;
+    /**
+     * 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, ESLint.Plugin>;
+    /**
+     * An object containing the configured rules. When `files` or `ignores` are specified, these rule configurations are only available to the matching files.
+     *
+     * @see [Configuring rules](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#configuring-rules)
+     */
+    rules?: Record<string, Linter.RuleLevel | Linter.RuleLevelAndOptions>;
+    /**
+     * An object containing name-value pairs of information that should be available to all rules.
+     *
+     * @see [Configuring shared settings](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#configuring-shared-settings)
+     */
+    settings?: Record<string, any>;
+}
 interface OptionsComponentExts {
     /**
      * Additional extensions for components.
@@ -50,7 +113,11 @@ interface OptionsHasTypeScript {
     typescript?: boolean;
 }
 interface OptionsStylistic {
-    stylistic?: boolean;
+    stylistic?: boolean | StylisticConfig;
+}
+interface StylisticConfig {
+    indent?: number | 'tab';
+    quotes?: 'single' | 'double';
 }
 interface OptionsOverrides {
     overrides?: FlatESLintConfigItem['rules'];
@@ -123,7 +190,7 @@ interface OptionsConfig extends OptionsComponentExts {
      *
      * @default true
      */
-    stylistic?: boolean;
+    stylistic?: boolean | StylisticConfig;
     /**
      * Control to disable some rules in editors.
      * @default auto-detect based on the process.env
@@ -179,7 +246,7 @@ declare function sortPackageJson(): FlatESLintConfigItem[];
  */
 declare function sortTsconfig(): FlatESLintConfigItem[];
 
-declare function stylistic(): FlatESLintConfigItem[];
+declare function stylistic(options?: StylisticConfig): FlatESLintConfigItem[];
 
 declare function typescript(options?: OptionsComponentExts & OptionsOverrides & OptionsTypeScriptWithTypes & OptionsTypeScriptParserOptions): FlatESLintConfigItem[];
 
@@ -192,7 +259,7 @@ declare function yaml(options?: OptionsOverrides & OptionsStylistic): FlatESLint
 
 declare function test(options?: OptionsIsInEditor & OptionsOverrides): FlatESLintConfigItem[];
 
-declare function react(options?: OptionsHasTypeScript & OptionsOverrides): FlatESLintConfigItem[];
+declare function react(options?: OptionsHasTypeScript & OptionsOverrides & OptionsStylistic): FlatESLintConfigItem[];
 
 declare function astro(options?: OptionsHasTypeScript & OptionsOverrides): FlatESLintConfigItem[];
 
@@ -227,4 +294,4 @@ declare const GLOB_TESTS: string[];
 declare const GLOB_ALL_SRC: string[];
 declare const GLOB_EXCLUDE: string[];
 
-export { GLOB_ALL_SRC, GLOB_ASTRO, GLOB_CSS, GLOB_EXCLUDE, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_TESTS, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_YAML, OptionsComponentExts, OptionsConfig, OptionsHasTypeScript, OptionsIsInEditor, OptionsOverrides, OptionsStylistic, OptionsTypeScriptParserOptions, OptionsTypeScriptWithTypes, astro, coderwyd, combine, comments, coderwyd as default, getVueVersion, ignores, imports, javascript, jsdoc, jsonc, markdown, node, react, renameRules, sortPackageJson, sortTsconfig, stylistic, test, typescript, unicorn, vue, yaml };
+export { FlatESLintConfigItem, GLOB_ALL_SRC, GLOB_ASTRO, GLOB_CSS, GLOB_EXCLUDE, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_TESTS, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_YAML, OptionsComponentExts, OptionsConfig, OptionsHasTypeScript, OptionsIsInEditor, OptionsOverrides, OptionsStylistic, OptionsTypeScriptParserOptions, OptionsTypeScriptWithTypes, StylisticConfig, astro, coderwyd, combine, comments, coderwyd as default, getVueVersion, ignores, imports, javascript, jsdoc, jsonc, markdown, node, react, renameRules, sortPackageJson, sortTsconfig, stylistic, test, typescript, unicorn, vue, yaml };