@luxass/eslint-config 4.0.0-beta.8 → 4.0.0

package/dist/types-spTEGSaV.d.ts

@@ -0,0 +1,632 @@
+import { FlatGitignoreOptions } from 'eslint-config-flat-gitignore';
+import { FlatESLintConfigItem, MergeIntersection, RenamePrefix, VitestRules, YmlRules, NRules, Prefix, ReactHooksRules, ReactRules, ImportRules, EslintRules, JsoncRules, VueRules, EslintCommentsRules, RuleConfig } 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 { StylisticCustomizeOptions, UnprefixedRuleOptions } from '@stylistic/eslint-plugin';
+import { Linter } from 'eslint';
+import { ParserOptions } from '@typescript-eslint/parser';
+import { Options } from 'eslint-processor-vue-blocks';
+
+type StylisticConfig = Pick<StylisticCustomizeOptions, "jsx" | "indent" | "quotes" | "semi">;
+declare const StylisticConfigDefaults: StylisticConfig;
+interface StylisticOptions {
+    /**
+     * Enable stylistic rules.
+     *
+     * @default true
+     */
+    stylistic?: boolean | StylisticConfig;
+    /**
+     * Overrides for the config.
+     */
+    overrides?: FlatConfigItem["rules"];
+}
+declare function stylistic(options?: StylisticOptions): Promise<FlatConfigItem[]>;
+
+interface JavaScriptOptions {
+    /**
+     * Whether the config is for an editor.
+     * @default false
+     */
+    editor?: boolean;
+    /**
+     * Overrides for the config.
+     */
+    overrides?: FlatConfigItem["rules"];
+}
+declare function javascript(options?: JavaScriptOptions): Promise<FlatConfigItem[]>;
+
+interface JSONOptions {
+    /**
+     * Override rules.
+     */
+    overrides?: FlatConfigItem["rules"];
+    /**
+     * Enable stylistic rules.
+     *
+     * @default true
+     */
+    stylistic?: boolean | StylisticConfig;
+    /**
+     * Glob patterns for JSON files.
+     *
+     * @default [GLOB_JSON, GLOB_JSON5, GLOB_JSONC]
+     * @see https://github.com/luxass/eslint-config/blob/ba9952eeb0737ff96444b1aa814e2a35b3cf2c74/src/globs.ts#L30
+     */
+    files?: string[];
+}
+declare function jsonc(options?: JSONOptions): Promise<FlatConfigItem[]>;
+
+interface TypeScriptOptions {
+    /**
+     * Additional extensions for components.
+     *
+     * @example ["vue"]
+     * @default []
+     */
+    exts?: string[];
+    /**
+     * Additional parser options for TypeScript.
+     */
+    parserOptions?: Partial<ParserOptions>;
+    /**
+     * When this options is provided, type aware rules will be enabled.
+     * @see https://typescript-eslint.io/linting/typed-linting/
+     */
+    tsconfigPath?: string | string[];
+    /**
+     * Glob patterns for TypeScript files.
+     *
+     * @default GLOB_SRC
+     * @see https://github.com/luxass/eslint-config/blob/ba9952eeb0737ff96444b1aa814e2a35b3cf2c74/src/globs.ts#L30
+     */
+    files?: string[];
+    /**
+     * Glob patterns for files that should be type aware.
+     * @default ['**\/*.{ts,tsx}']
+     */
+    typeAwareFileS?: string[];
+    /**
+     * Overrides for the config.
+     */
+    overrides?: FlatConfigItem["rules"];
+}
+declare function typescript(options?: TypeScriptOptions): Promise<FlatConfigItem[]>;
+
+interface VueOptions {
+    /**
+     * Override rules.
+     */
+    overrides?: FlatConfigItem["rules"];
+    /**
+     * Enable stylistic rules.
+     *
+     * @default true
+     */
+    stylistic?: boolean | StylisticConfig;
+    /**
+     * Enable TypeScript support.
+     *
+     * @default false
+     */
+    typescript?: boolean;
+    /**
+     * Create virtual files for Vue SFC blocks to enable linting.
+     *
+     * @see https://github.com/antfu/eslint-processor-vue-blocks
+     * @default true
+     */
+    sfcBlocks?: boolean | Options;
+    /**
+     * Enable Vue A11y support.
+     *
+     * @default true
+     */
+    a11y?: boolean;
+    /**
+     * Glob patterns for Vue files.
+     *
+     * @default GLOB_VUE
+     * @see https://github.com/luxass/eslint-config/blob/ba9952eeb0737ff96444b1aa814e2a35b3cf2c74/src/globs.ts#L30
+     */
+    files?: string[];
+}
+declare function vue(options?: VueOptions): Promise<FlatConfigItem[]>;
+
+interface YAMLOptions {
+    /**
+     * Override rules.
+     */
+    overrides?: FlatConfigItem["rules"];
+    /**
+     * Enable stylistic rules.
+     *
+     * @default true
+     */
+    stylistic?: boolean | StylisticConfig;
+    /**
+     * Glob patterns for YAML files.
+     *
+     * @default GLOB_YAML
+     * @see https://github.com/luxass/eslint-config/blob/ba9952eeb0737ff96444b1aa814e2a35b3cf2c74/src/globs.ts#L30
+     */
+    files?: string[];
+}
+declare function yaml(options?: YAMLOptions): Promise<FlatConfigItem[]>;
+
+interface TestOptions {
+    /**
+     * Disable some rules when eslint is run in an editor.
+     *
+     * @default false
+     */
+    editor?: boolean;
+    /**
+     * Glob patterns for test files.
+     *
+     * @default GLOB_TESTS
+     * @see https://github.com/luxass/eslint-config/blob/ba9952eeb0737ff96444b1aa814e2a35b3cf2c74/src/globs.ts#L30
+     */
+    files?: string[];
+    /**
+     * Override rules for for test files.
+     */
+    overrides?: FlatConfigItem["rules"];
+}
+declare function test(options?: TestOptions): Promise<FlatConfigItem[]>;
+
+interface UnoCSSOptions {
+    /**
+     * Enable strict mode.
+     *
+     * @default false
+     */
+    strict?: boolean;
+    /**
+     * Enable attributify mode.
+     *
+     * @default true
+     */
+    attributify?: boolean;
+    /**
+     * Glob patterns for files that includes unocss classes.
+     *
+     * @default GLOB_SRC
+     * @see https://github.com/luxass/eslint-config/blob/ba9952eeb0737ff96444b1aa814e2a35b3cf2c74/src/globs.ts#L30
+     */
+    files?: string[];
+    /**
+     * Override rules for for files with unocss classes.
+     */
+    overrides?: FlatConfigItem["rules"];
+}
+declare function unocss(options?: UnoCSSOptions): Promise<FlatConfigItem[]>;
+
+interface NextJSOptions {
+    /**
+     * Tell the plugin where the root directory is.
+     * @see https://nextjs.org/docs/app/building-your-application/configuring/eslint#rootdir
+     *
+     * @default true
+     */
+    rootDir?: boolean | string;
+    /**
+     * Override rules.
+     */
+    overrides?: FlatConfigItem["rules"];
+    /**
+     * Glob patterns for Next.js files.
+     *
+     * @default [GLOB_SRC]
+     * @see https://github.com/luxass/eslint-config/blob/ba9952eeb0737ff96444b1aa814e2a35b3cf2c74/src/globs.ts#L30
+     */
+    files?: string[];
+}
+declare function nextjs(options?: NextJSOptions): Promise<FlatConfigItem[]>;
+
+interface ReactOptions {
+    /**
+     * Override rules.
+     */
+    overrides?: FlatConfigItem["rules"];
+    /**
+     * Enable TypeScript support.
+     *
+     * @default false
+     */
+    typescript?: boolean;
+    /**
+     * Enable React A11y support.
+     *
+     * @default true
+     */
+    a11y?: boolean;
+    /**
+     * Glob patterns for JSX & TSX files.
+     *
+     * @default [GLOB_JSX, GLOB_TSX]
+     * @see https://github.com/luxass/eslint-config/blob/ba9952eeb0737ff96444b1aa814e2a35b3cf2c74/src/globs.ts#L30
+     */
+    files?: string[];
+}
+declare function react(options?: ReactOptions): Promise<FlatConfigItem[]>;
+
+interface AstroOptions {
+    /**
+     * Override rules.
+     */
+    overrides?: FlatConfigItem["rules"];
+    /**
+     * Enable TypeScript support.
+     *
+     * @default true
+     */
+    typescript?: boolean;
+    /**
+     * Enable React A11y support.
+     *
+     * @default false
+     */
+    a11y?: boolean;
+    /**
+     * Glob patterns for Astro files.
+     *
+     * @default [GLOB_ASTRO]
+     * @see https://github.com/luxass/eslint-config/blob/main/src/globs.ts#L27
+     */
+    files?: string[];
+}
+declare function astro(options: AstroOptions): Promise<FlatConfigItem[]>;
+
+interface TailwindCSSOptions {
+    /**
+     * Glob patterns for files that includes tailwind classes.
+     *
+     * @default [GLOB_SRC]
+     * @see https://github.com/luxass/eslint-config/blob/ba9952eeb0737ff96444b1aa814e2a35b3cf2c74/src/globs.ts#L30
+     */
+    files?: string[];
+    /**
+     * Override rules for for files with tailwind classes.
+     */
+    overrides?: FlatConfigItem["rules"];
+}
+declare function tailwindcss(options?: TailwindCSSOptions): Promise<FlatConfigItem[]>;
+
+/**
+ * Vendor types from Prettier so we don't rely on the dependency.
+ */
+type VendoredPrettierOptions = Partial<VendoredPrettierOptionsRequired>;
+interface VendoredPrettierOptionsRequired {
+    /**
+     * Specify the line length that the printer will wrap on.
+     * @default 120
+     */
+    printWidth: number;
+    /**
+     * Specify the number of spaces per indentation-level.
+     */
+    tabWidth: number;
+    /**
+     * Indent lines with tabs instead of spaces
+     */
+    useTabs?: boolean;
+    /**
+     * Print semicolons at the ends of statements.
+     */
+    semi: boolean;
+    /**
+     * Use single quotes instead of double quotes.
+     */
+    singleQuote: boolean;
+    /**
+     * Use single quotes in JSX.
+     */
+    jsxSingleQuote: boolean;
+    /**
+     * Print trailing commas wherever possible.
+     */
+    trailingComma: "none" | "es5" | "all";
+    /**
+     * Print spaces between brackets in object literals.
+     */
+    bracketSpacing: boolean;
+    /**
+     * 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).
+     */
+    bracketSameLine: boolean;
+    /**
+     * 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;
+    /**
+     * Format only a segment of a file.
+     */
+    rangeStart: number;
+    /**
+     * Format only a segment of a file.
+     * @default Number.POSITIVE_INFINITY
+     */
+    rangeEnd: 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"
+     */
+    proseWrap: "always" | "never" | "preserve";
+    /**
+     * Include parentheses around a sole arrow function parameter.
+     * @default "always"
+     */
+    arrowParens: "avoid" | "always";
+    /**
+     * Provide ability to support new languages to prettier.
+     */
+    plugins: Array<string | any>;
+    /**
+     * How to handle whitespaces in HTML.
+     * @default "css"
+     */
+    htmlWhitespaceSensitivity: "css" | "strict" | "ignore";
+    /**
+     * Which end of line characters to apply.
+     * @default "lf"
+     */
+    endOfLine: "auto" | "lf" | "crlf" | "cr";
+    /**
+     * Change when properties in objects are quoted.
+     * @default "as-needed"
+     */
+    quoteProps: "as-needed" | "consistent" | "preserve";
+    /**
+     * 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;
+}
+
+interface FormattersOptions {
+    /**
+     * Enable formatting support for CSS, Less, Sass, and SCSS.
+     *
+     * Currently only support Prettier.
+     */
+    css?: "prettier" | boolean;
+    /**
+     * Enable formatting support for HTML.
+     *
+     * Currently only support Prettier.
+     */
+    html?: "prettier" | boolean;
+    /**
+     * Enable formatting support for Markdown.
+     *
+     * Support both Prettier and dprint.
+     *
+     * When set to `true`, it will use Prettier.
+     */
+    markdown?: "prettier" | "dprint" | boolean;
+    /**
+     * Enable formatting support for GraphQL.
+     */
+    graphql?: "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;
+}
+declare function formatters(options?: FormattersOptions | true, stylistic?: StylisticConfig): Promise<FlatConfigItem[]>;
+
+interface NoOnlyTestsOptions {
+    blocks?: string[];
+    focus?: string[];
+}
+
+interface TOMLOptions {
+    /**
+     * Override rules.
+     */
+    overrides?: FlatConfigItem["rules"];
+    /**
+     * Enable stylistic rules.
+     *
+     * @default true
+     */
+    stylistic?: boolean | StylisticConfig;
+    /**
+     * Glob patterns for TOML files.
+     *
+     * @default [GLOB_TOML]
+     * @see https://github.com/luxass/eslint-config/blob/ba9952eeb0737ff96444b1aa814e2a35b3cf2c74/src/globs.ts#L30
+     */
+    files?: string[];
+}
+declare function toml(options?: TOMLOptions): Promise<FlatConfigItem[]>;
+
+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<[NoOnlyTestsOptions]>;
+}>>;
+type FlatConfigItem = Omit<FlatESLintConfigItem<Rules, false>, "plugins"> & {
+    /**
+     * Custom name of each config item
+     */
+    name?: string;
+    /**
+     * 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, any>;
+};
+type UserConfigItem = FlatConfigItem | Linter.FlatConfig;
+interface ConfigOptions {
+    /**
+     * Enable gitignore support.
+     *
+     * Passing an object to configure the options.
+     *
+     * @see https://github.com/antfu/eslint-config-flat-gitignore
+     * @default true
+     */
+    gitignore?: FlatGitignoreOptions | boolean;
+    /**
+     * Control to disable some rules in editors.
+     * @default auto-detect based on the process.env
+     */
+    editor?: boolean;
+    /**
+     * JavaScript options
+     *
+     * NOTE: Can't be disabled.
+     */
+    javascript?: JavaScriptOptions;
+    /**
+     * Enable JSONC support.
+     *
+     * @default true
+     */
+    jsonc?: boolean | JSONOptions;
+    /**
+     * Enable JSX related rules.
+     *
+     * Currently only stylistic rules are included.
+     *
+     * @default true
+     */
+    jsx?: boolean;
+    /**
+     * Enable linting for **code snippets** in Markdown.
+     *
+     * For formatting Markdown content, enable also `formatters.markdown`.
+     *
+     * @default true
+     */
+    markdown?: boolean;
+    /**
+     * Enable NextJS support.
+     *
+     * Requires installing:
+     * - `@next/eslint-plugin-next`
+     *
+     * @default false
+     *
+     * Note: By enabling this, the `react` option will be enabled automatically.
+     */
+    nextjs?: boolean | NextJSOptions;
+    /**
+     * Enable react rules.
+     *
+     * Requires installing:
+     * - `eslint-plugin-react`
+     * - `eslint-plugin-react-hooks`
+     * - `eslint-plugin-react-refresh`
+     *
+     * @default false
+     */
+    react?: boolean | ReactOptions;
+    /**
+     * Use external formatters to format files.
+     *
+     * Requires installing:
+     * - `eslint-plugin-format`
+     *
+     * When set to `true`, it will enable all formatters.
+     *
+     * @default false
+     */
+    formatters?: boolean | FormattersOptions;
+    /**
+     * Enable stylistic rules.
+     *
+     * @default true
+     */
+    stylistic?: boolean | StylisticConfig;
+    /**
+     * Enable test support.
+     *
+     * @default true
+     */
+    test?: boolean | TestOptions;
+    /**
+     * Enable TypeScript support.
+     *
+     * Passing an object to enable TypeScript Language Server support.
+     *
+     * @default auto-detect based on the dependencies
+     */
+    typescript?: boolean | TypeScriptOptions;
+    /**
+     * Enable UnoCSS support.
+     *
+     * Requires installing:
+     * - `@unocss/eslint-plugin`
+     *
+     * @default false
+     */
+    unocss?: boolean | UnoCSSOptions;
+    /**
+     * Enable TailwindCSS support.
+     *
+     * Requires installing:
+     * - `eslint-plugin-tailwindcss`
+     *
+     * @default false
+     */
+    tailwindcss?: boolean | TailwindCSSOptions;
+    /**
+     * Enable Vue support.
+     *
+     * @default auto-detect based on the dependencies
+     */
+    vue?: boolean | VueOptions;
+    /**
+     * Enable Astro support.
+     *
+     * @default auto-detect based on the dependencies
+     */
+    astro?: boolean | AstroOptions;
+    /**
+     * Enable YAML support.
+     *
+     * @default true
+     */
+    yaml?: boolean | YAMLOptions;
+    /**
+     * Enable TOML support.
+     *
+     * @default true
+     */
+    toml?: boolean | TOMLOptions;
+    /**
+     * Additional extensions for components.
+     *
+     * @example ["vue"]
+     * @default []
+     */
+    exts?: string[];
+}
+
+export { type AstroOptions as A, type ConfigOptions as C, type FormattersOptions as F, type JavaScriptOptions as J, type NextJSOptions as N, type ReactOptions as R, type StylisticConfig as S, type TypeScriptOptions as T, type UnoCSSOptions as U, type VueOptions as V, type YAMLOptions as Y, jsonc as a, type JSONOptions as b, type StylisticOptions as c, test as d, type TestOptions as e, astro as f, tailwindcss as g, type TailwindCSSOptions as h, formatters as i, javascript as j, type FlatConfigItem as k, type Awaitable as l, type UserConfigItem as m, nextjs as n, StylisticConfigDefaults as o, type TOMLOptions as p, toml as q, react as r, stylistic as s, typescript as t, unocss as u, vue as v, yaml as y };