@coderwyd/eslint-config 1.1.0 → 2.0.0

package/dist/index.d.cts

@@ -1,23 +1,25 @@
 import { FlatGitignoreOptions } from 'eslint-config-flat-gitignore';
 import { ParserOptions } from '@typescript-eslint/parser';
+import { FlatESLintConfigItem, MergeIntersection, RenamePrefix, TypeScriptRules, VitestRules, NRules, Prefix, ReactHooksRules, ReactRules, JSDocRules, ImportRules, EslintRules, JsoncRules, VueRules, UnicornRules, EslintCommentsRules, RuleConfig } from '@antfu/eslint-define-config';
 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';
+import { Rules } from 'eslint-plugin-antfu';
+import { RequiredOptions, LiteralUnion, BuiltInParserName } from 'prettier';
 
+type PrettierCustomParser = 'astro' | 'svelte' | 'toml';
+type PrettierParser = BuiltInParserName | PrettierCustomParser;
+interface PrettierOptions extends RequiredOptions {
+    parser: LiteralUnion<PrettierParser>;
+}
+type PartialPrettierExtendedOptions = Partial<PrettierOptions>;
 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 & {
+type EslintFlatRules = WrapRuleConfig<MergeIntersection<RenamePrefix<TypeScriptRules, '@typescript-eslint/', 'ts/'> & RenamePrefix<VitestRules, 'vitest/', 'test/'> & RenamePrefix<NRules, 'n/', 'node/'> & Prefix<Rules, 'antfu/'> & ReactHooksRules & ReactRules & JSDocRules & ImportRules & EslintRules & JsoncRules & VueRules & UnicornRules & EslintCommentsRules & {
     'test/no-only-tests': RuleConfig<[]>;
 }>>;
-type FlatConfigItem = Omit<FlatESLintConfigItem<Rules, false>, 'plugins'> & {
+type FlatConfigItem = Omit<FlatESLintConfigItem<EslintFlatRules, false>, 'plugins'> & {
     /**
      * Custom name of each config item
      */
@@ -30,11 +32,42 @@ type FlatConfigItem = Omit<FlatESLintConfigItem<Rules, false>, 'plugins'> & {
     plugins?: Record<string, any>;
 };
 type UserConfigItem = FlatConfigItem | Linter.FlatConfig;
-interface OptionsFiles {
+
+type Awaitable<T> = T | Promise<T>;
+type OptionsTypescript = (OptionsTypeScriptWithTypes & OptionsOverrides) | (OptionsTypeScriptParserOptions & OptionsOverrides);
+interface OptionsFormatters {
+    /**
+     * Enable formatting support for CSS, Less, Sass, and SCSS.
+     *
+     * Currently only support Prettier.
+     */
+    css?: boolean;
+    /**
+     * Enable formatting support for HTML.
+     *
+     * Currently only support Prettier.
+     */
+    html?: boolean;
+    /**
+     * Enable formatting support for Markdown.
+     *
+     * Support both Prettier.
+     *
+     * When set to `true`, it will use Prettier.
+     */
+    markdown?: boolean;
+    /**
+     * Enable formatting support for GraphQL.
+     */
+    graphql?: boolean;
+    /**
+     * Enable formatting support for Yaml.
+     */
+    yaml?: boolean;
     /**
-     * Override the `files` option to provide custom globs.
+     * Enable formatting support for Toml.
      */
-    files?: string[];
+    toml?: boolean;
 }
 interface OptionsComponentExts {
     /**
@@ -50,6 +83,11 @@ interface OptionsTypeScriptParserOptions {
      * Additional parser options for TypeScript.
      */
     parserOptions?: Partial<ParserOptions>;
+    /**
+     * Glob patterns for files that should be type aware.
+     * @default ['**\/*.{ts,tsx}']
+     */
+    filesTypeAware?: string[];
 }
 interface OptionsTypeScriptWithTypes {
     /**
@@ -58,21 +96,10 @@ interface OptionsTypeScriptWithTypes {
      */
     tsconfigPath?: string | string[];
 }
-interface OptionsHasTypeScript {
-    typescript?: boolean;
-}
-interface OptionsStylistic {
-    stylistic?: boolean | StylisticConfig;
-}
-interface StylisticConfig extends Pick<StylisticCustomizeOptions, 'indent' | 'quotes' | 'jsx' | 'semi'> {
-}
 interface OptionsOverrides {
     overrides?: FlatConfigItem['rules'];
 }
-interface OptionsIsInEditor {
-    isInEditor?: boolean;
-}
-interface OptionsUnoCSS {
+interface OptionsUnoCSS extends OptionsOverrides {
     /**
      * Enable attributify support.
      * @default true
@@ -84,7 +111,21 @@ interface OptionsUnoCSS {
      */
     strict?: boolean;
 }
+interface OptionsVue extends OptionsOverrides {
+    /**
+     * The vue version
+     *
+     * @default 3
+     */
+    version?: 2 | 3;
+}
 interface OptionsConfig extends OptionsComponentExts {
+    /**
+     * The current working directory
+     *
+     * @default process.cwd()
+     */
+    cwd?: string;
     /**
      * Enable gitignore support.
      *
@@ -94,6 +135,10 @@ interface OptionsConfig extends OptionsComponentExts {
      * @default true
      */
     gitignore?: boolean | FlatGitignoreOptions;
+    /**
+     * Core rules. Can't be disabled.
+     */
+    javascript?: OptionsOverrides;
     /**
      * Enable TypeScript support.
      *
@@ -101,51 +146,25 @@ interface OptionsConfig extends OptionsComponentExts {
      *
      * @default auto-detect based on the dependencies
      */
-    typescript?: boolean | OptionsTypeScriptWithTypes | OptionsTypeScriptParserOptions;
-    /**
-     * Enable JSX related rules.
-     *
-     * Currently only stylistic rules are included.
-     *
-     * @default true
-     */
-    jsx?: boolean;
+    typescript?: boolean | OptionsTypescript;
     /**
      * Enable test support.
      *
      * @default true
      */
-    test?: boolean;
+    test?: boolean | OptionsOverrides;
     /**
      * Enable Vue support.
      *
      * @default auto-detect based on the dependencies
      */
-    vue?: boolean;
+    vue?: boolean | OptionsVue;
     /**
      * Enable JSONC support.
      *
      * @default true
      */
-    jsonc?: boolean;
-    /**
-     * Enable YAML support.
-     *
-     * @default true
-     */
-    yaml?: boolean;
-    /**
-     * Enable Markdown support.
-     *
-     * @default true
-     */
-    markdown?: boolean;
-    /**
-     * Enable stylistic rules.
-     *
-     * @default true
-     */
-    stylistic?: boolean | StylisticConfig;
+    jsonc?: boolean | OptionsOverrides;
     /**
      * Enable react rules.
      *
@@ -156,7 +175,16 @@ interface OptionsConfig extends OptionsComponentExts {
      *
      * @default false
      */
-    react?: boolean;
+    react?: boolean | OptionsOverrides;
+    /**
+     * Enable svelte rules.
+     *
+     * Requires installing:
+     * - `eslint-plugin-svelte`
+     *
+     * @default false
+     */
+    svelte?: boolean | OptionsOverrides;
     /**
      * Enable unocss rules.
      *
@@ -166,6 +194,46 @@ interface OptionsConfig extends OptionsComponentExts {
      * @default false
      */
     unocss?: boolean | OptionsUnoCSS;
+    /**
+     * Whether to use prettierrc
+     *
+     * If true, the rules in prettierrc will override the default rules
+     *
+     * @default true
+     */
+    usePrettierrc?: boolean;
+    /**
+     * Use external formatters to format files.
+     *
+     * Requires installing:
+     * - `eslint-plugin-prettier`
+     *
+     * @default
+     * {
+     *  "html": true,
+     *  "css": true,
+     *  "graphql": true,
+     *  "markdown": true
+     *  "yaml": true
+     *  "toml": true
+     * }
+     */
+    formatter?: OptionsFormatters;
+    /**
+     * Default prettier rules
+     *
+     * @default
+     * ```json
+     * {
+     *   "arrowParens": "avoid",
+     *   "htmlWhitespaceSensitivity": "ignore"
+     *   "printWidth": 80,
+     *   "semi": false,
+     *   "singleQuote": true,
+     * }
+     * ```
+     */
+    prettierRules?: PartialPrettierExtendedOptions;
     /**
      * Control to disable some rules in editors.
      * @default auto-detect based on the process.env
@@ -173,6 +241,8 @@ interface OptionsConfig extends OptionsComponentExts {
     isInEditor?: boolean;
     /**
      * Provide overrides for rules for each integration.
+     *
+     * @deprecated use `overrides` option in each integration key instead
      */
     overrides?: {
         javascript?: FlatConfigItem['rules'];
@@ -180,8 +250,6 @@ interface OptionsConfig extends OptionsComponentExts {
         test?: FlatConfigItem['rules'];
         vue?: FlatConfigItem['rules'];
         jsonc?: FlatConfigItem['rules'];
-        markdown?: FlatConfigItem['rules'];
-        yaml?: FlatConfigItem['rules'];
         react?: FlatConfigItem['rules'];
     };
 }
@@ -189,94 +257,6 @@ interface OptionsConfig extends OptionsComponentExts {
 /**
  * Construct an array of ESLint flat config items.
  */
-declare function coderwyd(options?: OptionsConfig & FlatConfigItem, ...userConfigs: Awaitable<UserConfigItem | UserConfigItem[]>[]): Promise<UserConfigItem[]>;
-
-declare function comments(): Promise<FlatConfigItem[]>;
-
-declare function ignores(): Promise<FlatConfigItem[]>;
-
-declare function imports(options?: OptionsStylistic): Promise<FlatConfigItem[]>;
-
-declare function javascript(options?: OptionsIsInEditor & OptionsOverrides): Promise<FlatConfigItem[]>;
-
-declare function jsdoc(options?: OptionsStylistic): Promise<FlatConfigItem[]>;
-
-declare function jsonc(options?: OptionsFiles & OptionsStylistic & OptionsOverrides): Promise<FlatConfigItem[]>;
-
-declare function markdown(options?: OptionsFiles & OptionsComponentExts & OptionsOverrides): Promise<FlatConfigItem[]>;
-
-declare function node(): Promise<FlatConfigItem[]>;
-
-/**
- * Sort package.json
- *
- * Requires `jsonc` config
- */
-declare function sortPackageJson(): Promise<FlatConfigItem[]>;
-/**
- * Sort tsconfig.json
- *
- * Requires `jsonc` config
- */
-declare function sortTsconfig(): FlatConfigItem[];
-
-declare function stylistic(options?: StylisticConfig): Promise<FlatConfigItem[]>;
-
-declare function typescript(options?: OptionsFiles & OptionsComponentExts & OptionsOverrides & OptionsTypeScriptWithTypes & OptionsTypeScriptParserOptions): Promise<FlatConfigItem[]>;
-
-declare function unicorn(): Promise<FlatConfigItem[]>;
-
-declare function vue(options?: OptionsHasTypeScript & OptionsOverrides & OptionsStylistic & OptionsFiles): Promise<FlatConfigItem[]>;
-
-declare function yaml(options?: OptionsOverrides & OptionsStylistic & OptionsFiles): Promise<FlatConfigItem[]>;
-
-declare function test(options?: OptionsFiles & OptionsIsInEditor & OptionsOverrides): Promise<FlatConfigItem[]>;
-
-/**
- * Optional perfectionist plugin for props and items sorting.
- *
- * @see https://github.com/azat-io/eslint-plugin-perfectionist
- */
-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)";
-declare const GLOB_JS = "**/*.?([cm])js";
-declare const GLOB_JSX = "**/*.?([cm])jsx";
-declare const GLOB_TS = "**/*.?([cm])ts";
-declare const GLOB_TSX = "**/*.?([cm])tsx";
-declare const GLOB_STYLE = "**/*.{c,le,sc}ss";
-declare const GLOB_CSS = "**/*.css";
-declare const GLOB_LESS = "**/*.less";
-declare const GLOB_SCSS = "**/*.scss";
-declare const GLOB_JSON = "**/*.json";
-declare const GLOB_JSON5 = "**/*.json5";
-declare const GLOB_JSONC = "**/*.jsonc";
-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_MARKDOWN_CODE = "**/*.md/**/*.?([cm])[jt]s?(x)";
-declare const GLOB_TESTS: string[];
-declare const GLOB_ALL_SRC: string[];
-declare const GLOB_EXCLUDE: string[];
-
-/**
- * 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>;
+declare function defineConfig(options?: OptionsConfig & FlatConfigItem, ...userConfigs: Awaitable<UserConfigItem | UserConfigItem[]>[]): Promise<UserConfigItem[]>;
 
-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 };
+export { defineConfig };