@curev/eslint-config 0.3.5 → 0.3.7

package/dist/index.d.cts

@@ -1,13 +1,13 @@
-import { FlatGitignoreOptions } from 'eslint-config-flat-gitignore';
-import { ParserOptions } from '@typescript-eslint/parser';
-import { Options } from 'eslint-processor-vue-blocks';
-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 { Rules as Rules$1 } from '@curev/eslint-plugin';
 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 '@curev/eslint-plugin';
 import { UnprefixedRuleOptions, StylisticCustomizeOptions } from '@stylistic/eslint-plugin';
+import { ParserOptions } from '@typescript-eslint/parser';
+import { Linter } from 'eslint';
+import { FlatGitignoreOptions } from 'eslint-config-flat-gitignore';
+import { Options } from 'eslint-processor-vue-blocks';
 
 /**
  * Vendor types from Prettier so we don't rely on the dependency.
@@ -15,97 +15,97 @@ import { UnprefixedRuleOptions, StylisticCustomizeOptions } from '@stylistic/esl
 type VendoredPrettierOptions = Partial<VendoredPrettierOptionsRequired>;
 interface VendoredPrettierOptionsRequired {
     /**
-     * Specify the line length that the printer will wrap on.
-     * @default 120
+     * Include parentheses around a sole arrow function parameter.
+     * @default "always"
      */
-    printWidth: number;
+    arrowParens: "always" | "avoid";
     /**
-     * Specify the number of spaces per indentation-level.
+     * Put the `>` of a multi-line HTML (HTML, JSX, Vue, Angular) element at the end of the last line instead of being
+     * alone on the next line (does not apply to self closing elements).
      */
-    tabWidth: number;
+    bracketSameLine: boolean;
     /**
-     * Indent lines with tabs instead of spaces
+     * Print spaces between brackets in object literals.
      */
-    useTabs?: boolean;
+    bracketSpacing: boolean;
     /**
-     * Print semicolons at the ends of statements.
+     * Which end of line characters to apply.
+     * @default "lf"
      */
-    semi: boolean;
+    endOfLine: "auto" | "cr" | "crlf" | "lf";
     /**
-     * Use single quotes instead of double quotes.
+     * How to handle whitespaces in HTML.
+     * @default "css"
      */
-    singleQuote: boolean;
+    htmlWhitespaceSensitivity: "css" | "ignore" | "strict";
+    /**
+     * Put the `>` of a multi-line JSX element at the end of the last line instead of being alone on the next line.
+     * @deprecated use bracketSameLine instead
+     */
+    jsxBracketSameLine: boolean;
     /**
      * Use single quotes in JSX.
      */
     jsxSingleQuote: boolean;
     /**
-     * Print trailing commas wherever possible.
+     * Provide ability to support new languages to prettier.
      */
-    trailingComma: "none" | "es5" | "all";
+    plugins: Array<any | string>;
     /**
-     * Print spaces between brackets in object literals.
+     * Specify the line length that the printer will wrap on.
+     * @default 120
      */
-    bracketSpacing: boolean;
+    printWidth: number;
     /**
-     * Put the `>` of a multi-line HTML (HTML, JSX, Vue, Angular) element at the end of the last line instead of being
-     * alone on the next line (does not apply to self closing elements).
+     * By default, Prettier will wrap markdown text as-is since some services use a linebreak-sensitive renderer.
+     * In some cases you may want to rely on editor/viewer soft wrapping instead, so this option allows you to opt out.
+     * @default "preserve"
      */
-    bracketSameLine: boolean;
+    proseWrap: "always" | "never" | "preserve";
     /**
-     * Put the `>` of a multi-line JSX element at the end of the last line instead of being alone on the next line.
-     * @deprecated use bracketSameLine instead
+     * Change when properties in objects are quoted.
+     * @default "as-needed"
      */
-    jsxBracketSameLine: boolean;
+    quoteProps: "as-needed" | "consistent" | "preserve";
     /**
      * Format only a segment of a file.
+     * @default Number.POSITIVE_INFINITY
      */
-    rangeStart: number;
+    rangeEnd: number;
     /**
      * Format only a segment of a file.
-     * @default Number.POSITIVE_INFINITY
      */
-    rangeEnd: number;
+    rangeStart: number;
     /**
-     * By default, Prettier will wrap markdown text as-is since some services use a linebreak-sensitive renderer.
-     * In some cases you may want to rely on editor/viewer soft wrapping instead, so this option allows you to opt out.
-     * @default "preserve"
+     * Print semicolons at the ends of statements.
      */
-    proseWrap: "always" | "never" | "preserve";
+    semi: boolean;
     /**
-     * Include parentheses around a sole arrow function parameter.
-     * @default "always"
+     * Enforce single attribute per line in HTML, Vue and JSX.
+     * @default false
      */
-    arrowParens: "avoid" | "always";
+    singleAttributePerLine: boolean;
     /**
-     * Provide ability to support new languages to prettier.
+     * Use single quotes instead of double quotes.
      */
-    plugins: Array<string | any>;
+    singleQuote: boolean;
     /**
-     * How to handle whitespaces in HTML.
-     * @default "css"
+     * Specify the number of spaces per indentation-level.
      */
-    htmlWhitespaceSensitivity: "css" | "strict" | "ignore";
+    tabWidth: number;
     /**
-     * Which end of line characters to apply.
-     * @default "lf"
+     * Print trailing commas wherever possible.
      */
-    endOfLine: "auto" | "lf" | "crlf" | "cr";
+    trailingComma: "all" | "es5" | "none";
     /**
-     * Change when properties in objects are quoted.
-     * @default "as-needed"
+     * Indent lines with tabs instead of spaces
      */
-    quoteProps: "as-needed" | "consistent" | "preserve";
+    useTabs?: boolean;
     /**
      * Whether or not to indent the code inside <script> and <style> tags in Vue files.
      * @default false
      */
     vueIndentScriptAndStyle: boolean;
-    /**
-     * Enforce single attribute per line in HTML, Vue and JSX.
-     * @default false
-     */
-    singleAttributePerLine: boolean;
 }
 
 type WrapRuleConfig<T extends {
@@ -113,7 +113,7 @@ type WrapRuleConfig<T extends {
 }> = {
     [K in keyof T]: T[K] extends RuleConfig ? T[K] : RuleConfig<T[K]>;
 };
-type Awaitable<T> = T | Promise<T>;
+type Awaitable<T> = Promise<T> | 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, "curev/"> & ReactHooksRules & ReactRules & RuleOptions$1 & ImportRules & EslintRules & JsoncRules & VueRules & RuleOptions$2 & EslintCommentsRules & {
     "test/no-only-tests": RuleConfig<[]>;
 }>>;
@@ -143,7 +143,7 @@ interface OptionsVue extends OptionsOverrides {
      * @see https://github.com/antfu/eslint-processor-vue-blocks
      * @default true
      */
-    sfcBlocks?: boolean | Options;
+    sfcBlocks?: Options | boolean;
     /**
      * Vue version. Apply different rules set from `eslint-plugin-vue`.
      *
@@ -151,7 +151,7 @@ interface OptionsVue extends OptionsOverrides {
      */
     vueVersion?: 2 | 3;
 }
-type OptionsTypescript = (OptionsTypeScriptWithTypes & OptionsOverrides) | (OptionsTypeScriptParserOptions & OptionsOverrides);
+type OptionsTypescript = (OptionsTypeScriptParserOptions & OptionsOverrides) | (OptionsTypeScriptWithTypes & OptionsOverrides);
 interface OptionsFormatters {
     /**
      * Enable formatting support for CSS, Less, Sass, and SCSS.
@@ -159,6 +159,16 @@ interface OptionsFormatters {
      * Currently only support Prettier.
      */
     css?: "prettier" | boolean;
+    /**
+     * Custom options for dprint.
+     *
+     * By default it's controlled by our own config.
+     */
+    dprintOptions?: boolean;
+    /**
+     * Enable formatting support for GraphQL.
+     */
+    graphql?: "prettier" | boolean;
     /**
      * Enable formatting support for HTML.
      *
@@ -172,23 +182,13 @@ interface OptionsFormatters {
      *
      * When set to `true`, it will use Prettier.
      */
-    markdown?: "prettier" | "dprint" | boolean;
-    /**
-     * Enable formatting support for GraphQL.
-     */
-    graphql?: "prettier" | boolean;
+    markdown?: "dprint" | "prettier" | boolean;
     /**
      * Custom options for Prettier.
      *
      * By default it's controlled by our own config.
      */
     prettierOptions?: VendoredPrettierOptions;
-    /**
-     * Custom options for dprint.
-     *
-     * By default it's controlled by our own config.
-     */
-    dprintOptions?: boolean;
 }
 interface OptionsComponentExts {
     /**
@@ -200,15 +200,15 @@ interface OptionsComponentExts {
     componentExts?: string[];
 }
 interface OptionsTypeScriptParserOptions {
-    /**
-     * Additional parser options for TypeScript.
-     */
-    parserOptions?: Partial<ParserOptions>;
     /**
      * Glob patterns for files that should be type aware.
      * @default ['**\/*.{ts,tsx}']
      */
     filesTypeAware?: string[];
+    /**
+     * Additional parser options for TypeScript.
+     */
+    parserOptions?: Partial<ParserOptions>;
 }
 interface OptionsTypeScriptWithTypes {
     /**
@@ -221,7 +221,7 @@ interface OptionsHasTypeScript {
     typescript?: boolean;
 }
 interface OptionsStylistic {
-    stylistic?: boolean | StylisticConfig;
+    stylistic?: StylisticConfig | boolean;
 }
 interface StylisticConfig extends StylisticCustomizeOptions {
 }
@@ -245,64 +245,48 @@ interface OptionsUnoCSS extends OptionsOverrides {
 }
 interface OptionsConfig extends OptionsComponentExts {
     /**
-     * Enable gitignore support.
-     *
-     * Passing an object to configure the options.
+     * Use external formatters to format files.
      *
-     * @see https://github.com/antfu/eslint-config-flat-gitignore
-     * @default true
-     */
-    gitignore?: boolean | FlatGitignoreOptions;
-    /**
-     * Core rules. Can't be disabled.
-     */
-    javascript?: OptionsOverrides;
-    /**
-     * Enable TypeScript support.
+     * Requires installing:
+     * - `eslint-plugin-format`
      *
-     * Passing an object to enable TypeScript Language Server support.
+     * When set to `true`, it will enable all formatters.
      *
-     * @default auto-detect based on the dependencies
+     * @default false
      */
-    typescript?: boolean | OptionsTypescript;
+    formatters?: OptionsFormatters | boolean;
     /**
-     * Enable JSX related rules.
+     * Enable gitignore support.
      *
-     * Currently only stylistic rules are included.
+     * Passing an object to configure the options.
      *
+     * @see https://github.com/antfu/eslint-config-flat-gitignore
      * @default true
      */
-    jsx?: boolean;
+    gitignore?: FlatGitignoreOptions | boolean;
     /**
-     * Enable test support.
-     *
-     * @default true
+     * Control to disable some rules in editors.
+     * @default auto-detect based on the process.env
      */
-    test?: boolean | OptionsOverrides;
+    isInEditor?: boolean;
     /**
-     * Enable Vue support.
-     *
-     * @default auto-detect based on the dependencies
+     * Core rules. Can't be disabled.
      */
-    vue?: boolean | OptionsVue;
+    javascript?: OptionsOverrides;
     /**
      * Enable JSONC support.
      *
      * @default true
      */
-    jsonc?: boolean | OptionsOverrides;
+    jsonc?: OptionsOverrides | boolean;
     /**
-     * Enable YAML support.
+     * Enable JSX related rules.
      *
-     * @default true
-     */
-    yaml?: boolean | OptionsOverrides;
-    /**
-     * Enable TOML support.
+     * Currently only stylistic rules are included.
      *
      * @default true
      */
-    toml?: boolean | OptionsOverrides;
+    jsx?: boolean;
     /**
      * Enable linting for **code snippets** in Markdown.
      *
@@ -310,13 +294,25 @@ interface OptionsConfig extends OptionsComponentExts {
      *
      * @default true
      */
-    markdown?: boolean | OptionsOverrides;
+    markdown?: OptionsOverrides | boolean;
     /**
-     * Enable stylistic rules.
+     * Provide overrides for rules for each integration.
      *
-     * @default true
+     * @deprecated use `overrides` option in each integration key instead
      */
-    stylistic?: boolean | (StylisticConfig & OptionsOverrides);
+    overrides?: {
+        javascript?: FlatConfigItem["rules"];
+        jsonc?: FlatConfigItem["rules"];
+        markdown?: FlatConfigItem["rules"];
+        react?: FlatConfigItem["rules"];
+        stylistic?: FlatConfigItem["rules"];
+        svelte?: FlatConfigItem["rules"];
+        test?: FlatConfigItem["rules"];
+        toml?: FlatConfigItem["rules"];
+        typescript?: FlatConfigItem["rules"];
+        vue?: FlatConfigItem["rules"];
+        yaml?: FlatConfigItem["rules"];
+    };
     /**
      * Enable react rules.
      *
@@ -327,7 +323,13 @@ interface OptionsConfig extends OptionsComponentExts {
      *
      * @default false
      */
-    react?: boolean | OptionsOverrides;
+    react?: OptionsOverrides | boolean;
+    /**
+     * Enable stylistic rules.
+     *
+     * @default true
+     */
+    stylistic?: (StylisticConfig & OptionsOverrides) | boolean;
     /**
      * Enable svelte rules.
      *
@@ -338,48 +340,46 @@ interface OptionsConfig extends OptionsComponentExts {
      */
     svelte?: boolean;
     /**
-     * Enable unocss rules.
+     * Enable test support.
      *
-     * Requires installing:
-     * - `@unocss/eslint-plugin`
+     * @default true
+     */
+    test?: OptionsOverrides | boolean;
+    /**
+     * Enable TOML support.
      *
-     * @default false
+     * @default true
      */
-    unocss?: boolean | OptionsUnoCSS;
+    toml?: OptionsOverrides | boolean;
     /**
-     * Use external formatters to format files.
+     * Enable TypeScript support.
      *
-     * Requires installing:
-     * - `eslint-plugin-format`
+     * Passing an object to enable TypeScript Language Server support.
      *
-     * When set to `true`, it will enable all formatters.
+     * @default auto-detect based on the dependencies
+     */
+    typescript?: OptionsTypescript | boolean;
+    /**
+     * Enable unocss rules.
+     *
+     * Requires installing:
+     * - `@unocss/eslint-plugin`
      *
      * @default false
      */
-    formatters?: boolean | OptionsFormatters;
+    unocss?: OptionsUnoCSS | boolean;
     /**
-     * Control to disable some rules in editors.
-     * @default auto-detect based on the process.env
+     * Enable Vue support.
+     *
+     * @default auto-detect based on the dependencies
      */
-    isInEditor?: boolean;
+    vue?: OptionsVue | boolean;
     /**
-     * Provide overrides for rules for each integration.
+     * Enable YAML support.
      *
-     * @deprecated use `overrides` option in each integration key instead
+     * @default true
      */
-    overrides?: {
-        stylistic?: FlatConfigItem["rules"];
-        javascript?: FlatConfigItem["rules"];
-        typescript?: FlatConfigItem["rules"];
-        test?: FlatConfigItem["rules"];
-        vue?: FlatConfigItem["rules"];
-        jsonc?: FlatConfigItem["rules"];
-        markdown?: FlatConfigItem["rules"];
-        yaml?: FlatConfigItem["rules"];
-        toml?: FlatConfigItem["rules"];
-        react?: FlatConfigItem["rules"];
-        svelte?: FlatConfigItem["rules"];
-    };
+    yaml?: OptionsOverrides | boolean;
 }
 
 /**
@@ -406,13 +406,6 @@ declare function markdown(options?: OptionsFiles & OptionsComponentExts & Option
 
 declare function node(): 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 formatters(options?: OptionsFormatters | true, stylistic?: StylisticConfig): Promise<FlatConfigItem[]>;
 
 declare function react(options?: OptionsHasTypeScript & OptionsOverrides & OptionsFiles): Promise<FlatConfigItem[]>;
@@ -513,4 +506,4 @@ declare function interopDefault<T>(m: Awaitable<T>): Promise<T extends {
 } ? 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_MARKDOWN_IN_MARKDOWN, GLOB_POSTCSS, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_SVELTE, GLOB_TESTS, GLOB_TOML, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_YAML, type OptionsComponentExts, type OptionsConfig, type OptionsFiles, type OptionsFormatters, type OptionsHasTypeScript, type OptionsIsInEditor, type OptionsOverrides, type OptionsStylistic, type OptionsTypeScriptParserOptions, type OptionsTypeScriptWithTypes, type OptionsTypescript, type OptionsUnoCSS, type OptionsVue, type ResolvedOptions, type Rules, type StylisticConfig, StylisticConfigDefaults, type UserConfigItem, type WrapRuleConfig, combine, comments, curev, curev as default, ensurePackages, formatters, getOverrides, ignores, imports, interopDefault, javascript, jsdoc, jsonc, markdown, node, parserPlain, perfectionist, react, renameRules, resolveSubOptions, sortPackageJson, sortTsconfig, stylistic, svelte, test, toArray, toml, typescript, unicorn, unocss, vue, yaml };
+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_MARKDOWN_IN_MARKDOWN, GLOB_POSTCSS, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_SVELTE, GLOB_TESTS, GLOB_TOML, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_YAML, type OptionsComponentExts, type OptionsConfig, type OptionsFiles, type OptionsFormatters, type OptionsHasTypeScript, type OptionsIsInEditor, type OptionsOverrides, type OptionsStylistic, type OptionsTypeScriptParserOptions, type OptionsTypeScriptWithTypes, type OptionsTypescript, type OptionsUnoCSS, type OptionsVue, type ResolvedOptions, type Rules, type StylisticConfig, StylisticConfigDefaults, type UserConfigItem, type WrapRuleConfig, combine, comments, curev, curev as default, ensurePackages, formatters, getOverrides, ignores, imports, interopDefault, javascript, jsdoc, jsonc, markdown, node, parserPlain, react, renameRules, resolveSubOptions, sortPackageJson, sortTsconfig, stylistic, svelte, test, toArray, toml, typescript, unicorn, unocss, vue, yaml };