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

package/dist/index.d.ts

@@ -1,91 +1,40 @@
 import { FlatGitignoreOptions } from 'eslint-config-flat-gitignore';
 import { ParserOptions } 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';
-import * as eslintPluginI from 'eslint-plugin-i';
-export { eslintPluginI as pluginImport };
-export { default as pluginJsdoc } from 'eslint-plugin-jsdoc';
-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';
-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';
-export { default as parserVue } from 'vue-eslint-parser';
-export { default as parserYaml } from 'yaml-eslint-parser';
-export { default as parserJsonc } from 'jsonc-eslint-parser';
-export { default as parserAstro } from 'astro-eslint-parser';
+import { Linter } from 'eslint';
+import { RuleConfig, MergeIntersection, RenamePrefix, VitestRules, YmlRules, NRules, Prefix, ReactHooksRules, ReactRules, ImportRules, EslintRules, JsoncRules, VueRules, EslintCommentsRules, FlatESLintConfigItem } from '@antfu/eslint-define-config';
+import { RuleOptions as RuleOptions$1 } from '@eslint-types/jsdoc/types';
+import { RuleOptions } from '@eslint-types/typescript-eslint/types';
+import { RuleOptions as RuleOptions$2 } from '@eslint-types/unicorn/types';
+import { Rules as Rules$1 } from 'eslint-plugin-antfu';
+import { UnprefixedRuleOptions, StylisticCustomizeOptions } from '@stylistic/eslint-plugin';
 
-/**
- * Flat ESLint Configuration.
- *
- * @see [Configuration Files (New)](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new)
- */
-interface FlatESLintConfigItem {
+type WrapRuleConfig<T extends {
+    [key: string]: any;
+}> = {
+    [K in keyof T]: T[K] extends RuleConfig ? T[K] : RuleConfig<T[K]>;
+};
+type Awaitable<T> = T | Promise<T>;
+type Rules = WrapRuleConfig<MergeIntersection<RenamePrefix<RuleOptions, '@typescript-eslint/', 'ts/'> & RenamePrefix<VitestRules, 'vitest/', 'test/'> & RenamePrefix<YmlRules, 'yml/', 'yaml/'> & RenamePrefix<NRules, 'n/', 'node/'> & Prefix<UnprefixedRuleOptions, 'style/'> & Prefix<Rules$1, 'antfu/'> & ReactHooksRules & ReactRules & RuleOptions$1 & ImportRules & EslintRules & JsoncRules & VueRules & RuleOptions$2 & EslintCommentsRules & {
+    'test/no-only-tests': RuleConfig<[]>;
+}>>;
+type FlatConfigItem = Omit<FlatESLintConfigItem<Rules, false>, 'plugins'> & {
     /**
-     * The name of the configuration object.
+     * Custom name of each config item
      */
     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>;
+    plugins?: Record<string, any>;
+};
+type UserConfigItem = FlatConfigItem | Linter.FlatConfig;
+interface OptionsFiles {
     /**
-     * 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)
+     * Override the `files` option to provide custom globs.
      */
-    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>;
+    files?: string[];
 }
 interface OptionsComponentExts {
     /**
@@ -107,7 +56,7 @@ interface OptionsTypeScriptWithTypes {
      * When this options is provided, type aware rules will be enabled.
      * @see https://typescript-eslint.io/linting/typed-linting/
      */
-    tsconfigPath?: string;
+    tsconfigPath?: string | string[];
 }
 interface OptionsHasTypeScript {
     typescript?: boolean;
@@ -115,16 +64,26 @@ interface OptionsHasTypeScript {
 interface OptionsStylistic {
     stylistic?: boolean | StylisticConfig;
 }
-interface StylisticConfig {
-    indent?: number | 'tab';
-    quotes?: 'single' | 'double';
+interface StylisticConfig extends Pick<StylisticCustomizeOptions, 'indent' | 'quotes' | 'jsx' | 'semi'> {
 }
 interface OptionsOverrides {
-    overrides?: FlatESLintConfigItem['rules'];
+    overrides?: FlatConfigItem['rules'];
 }
 interface OptionsIsInEditor {
     isInEditor?: boolean;
 }
+interface OptionsUnoCSS {
+    /**
+     * Enable attributify support.
+     * @default true
+     */
+    attributify?: boolean;
+    /**
+     * Enable strict mode by throwing errors about blocklisted classes.
+     * @default false
+     */
+    strict?: boolean;
+}
 interface OptionsConfig extends OptionsComponentExts {
     /**
      * Enable gitignore support.
@@ -142,7 +101,15 @@ interface OptionsConfig extends OptionsComponentExts {
      *
      * @default auto-detect based on the dependencies
      */
-    typescript?: boolean | OptionsTypeScriptWithTypes;
+    typescript?: boolean | OptionsTypeScriptWithTypes | OptionsTypeScriptParserOptions;
+    /**
+     * Enable JSX related rules.
+     *
+     * Currently only stylistic rules are included.
+     *
+     * @default true
+     */
+    jsx?: boolean;
     /**
      * Enable test support.
      *
@@ -155,18 +122,6 @@ interface OptionsConfig extends OptionsComponentExts {
      * @default auto-detect based on the dependencies
      */
     vue?: boolean;
-    /**
-     * Enable React support.
-     *
-     * @default auto-detect based on the dependencies
-     */
-    react?: boolean;
-    /**
-     * Enable Astro support.
-     *
-     * @default auto-detect based on the dependencies
-     */
-    astro?: boolean;
     /**
      * Enable JSONC support.
      *
@@ -191,6 +146,26 @@ interface OptionsConfig extends OptionsComponentExts {
      * @default true
      */
     stylistic?: boolean | StylisticConfig;
+    /**
+     * Enable react rules.
+     *
+     * Requires installing:
+     * - `eslint-plugin-react`
+     * - `eslint-plugin-react-hooks`
+     * - `eslint-plugin-react-refresh`
+     *
+     * @default false
+     */
+    react?: boolean;
+    /**
+     * Enable unocss rules.
+     *
+     * Requires installing:
+     * - `@unocss/eslint-plugin`
+     *
+     * @default false
+     */
+    unocss?: boolean | OptionsUnoCSS;
     /**
      * Control to disable some rules in editors.
      * @default auto-detect based on the process.env
@@ -200,76 +175,73 @@ interface OptionsConfig extends OptionsComponentExts {
      * Provide overrides for rules for each integration.
      */
     overrides?: {
-        javascript?: FlatESLintConfigItem['rules'];
-        typescript?: FlatESLintConfigItem['rules'];
-        test?: FlatESLintConfigItem['rules'];
-        vue?: FlatESLintConfigItem['rules'];
-        react?: FlatESLintConfigItem['rules'];
-        astro?: FlatESLintConfigItem['rules'];
-        jsonc?: FlatESLintConfigItem['rules'];
-        markdown?: FlatESLintConfigItem['rules'];
-        yaml?: FlatESLintConfigItem['rules'];
+        javascript?: FlatConfigItem['rules'];
+        typescript?: FlatConfigItem['rules'];
+        test?: FlatConfigItem['rules'];
+        vue?: FlatConfigItem['rules'];
+        jsonc?: FlatConfigItem['rules'];
+        markdown?: FlatConfigItem['rules'];
+        yaml?: FlatConfigItem['rules'];
+        react?: FlatConfigItem['rules'];
     };
 }
 
 /**
  * Construct an array of ESLint flat config items.
  */
-declare function coderwyd(options?: OptionsConfig & FlatESLintConfigItem, ...userConfigs: (FlatESLintConfigItem | FlatESLintConfigItem[])[]): FlatESLintConfigItem[];
+declare function coderwyd(options?: OptionsConfig & FlatConfigItem, ...userConfigs: Awaitable<UserConfigItem | UserConfigItem[]>[]): Promise<UserConfigItem[]>;
 
-declare function comments(): FlatESLintConfigItem[];
+declare function comments(): Promise<FlatConfigItem[]>;
 
-declare function ignores(): FlatESLintConfigItem[];
+declare function ignores(): Promise<FlatConfigItem[]>;
 
-declare function imports(options?: OptionsStylistic): FlatESLintConfigItem[];
+declare function imports(options?: OptionsStylistic): Promise<FlatConfigItem[]>;
 
-declare function javascript(options?: OptionsIsInEditor & OptionsOverrides): FlatESLintConfigItem[];
+declare function javascript(options?: OptionsIsInEditor & OptionsOverrides): Promise<FlatConfigItem[]>;
 
-declare function jsdoc(options?: OptionsStylistic): FlatESLintConfigItem[];
+declare function jsdoc(options?: OptionsStylistic): Promise<FlatConfigItem[]>;
 
-declare function jsonc(options?: OptionsStylistic & OptionsOverrides): FlatESLintConfigItem[];
+declare function jsonc(options?: OptionsFiles & OptionsStylistic & OptionsOverrides): Promise<FlatConfigItem[]>;
 
-declare function markdown(options?: OptionsComponentExts & OptionsOverrides): FlatESLintConfigItem[];
+declare function markdown(options?: OptionsFiles & OptionsComponentExts & OptionsOverrides): Promise<FlatConfigItem[]>;
 
-declare function node(): FlatESLintConfigItem[];
+declare function node(): Promise<FlatConfigItem[]>;
 
 /**
  * Sort package.json
  *
  * Requires `jsonc` config
  */
-declare function sortPackageJson(): FlatESLintConfigItem[];
+declare function sortPackageJson(): Promise<FlatConfigItem[]>;
 /**
  * Sort tsconfig.json
  *
  * Requires `jsonc` config
  */
-declare function sortTsconfig(): FlatESLintConfigItem[];
+declare function sortTsconfig(): FlatConfigItem[];
 
-declare function stylistic(options?: StylisticConfig): FlatESLintConfigItem[];
+declare function stylistic(options?: StylisticConfig): Promise<FlatConfigItem[]>;
 
-declare function typescript(options?: OptionsComponentExts & OptionsOverrides & OptionsTypeScriptWithTypes & OptionsTypeScriptParserOptions): FlatESLintConfigItem[];
+declare function typescript(options?: OptionsFiles & OptionsComponentExts & OptionsOverrides & OptionsTypeScriptWithTypes & OptionsTypeScriptParserOptions): Promise<FlatConfigItem[]>;
 
-declare function unicorn(): FlatESLintConfigItem[];
+declare function unicorn(): Promise<FlatConfigItem[]>;
 
-declare function getVueVersion(): number;
-declare function vue(options?: OptionsHasTypeScript & OptionsOverrides & OptionsStylistic): FlatESLintConfigItem[];
-
-declare function yaml(options?: OptionsOverrides & OptionsStylistic): FlatESLintConfigItem[];
-
-declare function test(options?: OptionsIsInEditor & OptionsOverrides): FlatESLintConfigItem[];
+declare function vue(options?: OptionsHasTypeScript & OptionsOverrides & OptionsStylistic & OptionsFiles): Promise<FlatConfigItem[]>;
 
-declare function react(options?: OptionsHasTypeScript & OptionsOverrides & OptionsStylistic): FlatESLintConfigItem[];
+declare function yaml(options?: OptionsOverrides & OptionsStylistic & OptionsFiles): Promise<FlatConfigItem[]>;
 
-declare function astro(options?: OptionsHasTypeScript & OptionsOverrides): FlatESLintConfigItem[];
+declare function test(options?: OptionsFiles & OptionsIsInEditor & OptionsOverrides): Promise<FlatConfigItem[]>;
 
 /**
- * Combine array and non-array configs into a single array.
+ * Optional perfectionist plugin for props and items sorting.
+ *
+ * @see https://github.com/azat-io/eslint-plugin-perfectionist
  */
-declare function combine(...configs: (FlatESLintConfigItem | FlatESLintConfigItem[])[]): FlatESLintConfigItem[];
-declare function renameRules(rules: Record<string, any>, from: string, to: string): {
-    [k: string]: any;
-};
+declare function perfectionist(): Promise<FlatConfigItem[]>;
+
+declare function react(options?: OptionsHasTypeScript & OptionsOverrides & OptionsFiles): Promise<FlatConfigItem[]>;
+
+declare function unocss(options?: OptionsUnoCSS): Promise<FlatConfigItem[]>;
 
 declare const GLOB_SRC_EXT = "?([cm])[jt]s?(x)";
 declare const GLOB_SRC = "**/*.?([cm])[jt]s?(x)";
@@ -288,10 +260,23 @@ declare const GLOB_MARKDOWN = "**/*.md";
 declare const GLOB_VUE = "**/*.vue";
 declare const GLOB_YAML = "**/*.y?(a)ml";
 declare const GLOB_HTML = "**/*.htm?(l)";
-declare const GLOB_ASTRO = "**/*.astro";
 declare const GLOB_MARKDOWN_CODE = "**/*.md/**/*.?([cm])[jt]s?(x)";
 declare const GLOB_TESTS: string[];
 declare const GLOB_ALL_SRC: string[];
 declare const GLOB_EXCLUDE: string[];
 
-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 };
+/**
+ * Combine array and non-array configs into a single array.
+ */
+declare function combine(...configs: Awaitable<UserConfigItem | UserConfigItem[]>[]): Promise<UserConfigItem[]>;
+declare function renameRules(rules: Record<string, any>, from: string, to: string): {
+    [k: string]: any;
+};
+declare function getVueVersion(): number;
+declare function toArray<T>(value: T | T[]): T[];
+declare function interopDefault<T>(m: Awaitable<T>): Promise<T extends {
+    default: infer U;
+} ? U : T>;
+declare function ensurePackages(packages: string[]): Promise<void>;
+
+export { type Awaitable, type FlatConfigItem, GLOB_ALL_SRC, 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, type OptionsComponentExts, type OptionsConfig, type OptionsFiles, type OptionsHasTypeScript, type OptionsIsInEditor, type OptionsOverrides, type OptionsStylistic, type OptionsTypeScriptParserOptions, type OptionsTypeScriptWithTypes, type OptionsUnoCSS, type Rules, type StylisticConfig, type UserConfigItem, type WrapRuleConfig, coderwyd, combine, comments, coderwyd as default, ensurePackages, getVueVersion, ignores, imports, interopDefault, javascript, jsdoc, jsonc, markdown, node, perfectionist, react, renameRules, sortPackageJson, sortTsconfig, stylistic, test, toArray, typescript, unicorn, unocss, vue, yaml };