@so1ve/eslint-config 2.0.0 → 3.0.0

package/dist/index.d.ts

@@ -1,40 +1,8 @@
 import so1vePlugin from '@so1ve/eslint-plugin';
-export { default as pluginSo1ve } from '@so1ve/eslint-plugin';
 import { ParserOptions } from '@typescript-eslint/utils/ts-eslint';
 import { FlatGitignoreOptions } from 'eslint-config-flat-gitignore';
 import { Rules, FlatESLintConfigItem } from 'eslint-define-config';
-export { default as pluginComments } from '@eslint-community/eslint-plugin-eslint-comments';
-export { default as pluginHtml } from '@html-eslint/eslint-plugin';
-export { default as parserHtml } from '@html-eslint/parser';
-export { default as pluginSortImports } from '@so1ve/eslint-plugin-sort-imports';
-export { default as pluginStylistic } from '@stylistic/eslint-plugin';
-export { default as parserMdx } from 'eslint-mdx';
-export { default as pluginArrayFunc } from 'eslint-plugin-array-func';
-export { default as pluginEtc } from 'eslint-plugin-etc';
-export { default as pluginHtmlJsSupport } from 'eslint-plugin-html';
-export { default as pluginImport } from 'eslint-plugin-i';
-export { default as pluginJestFormatting } from 'eslint-plugin-jest-formatting';
-export { default as pluginJsonSchemaValidator } from 'eslint-plugin-json-schema-validator';
-export { default as pluginJsonc } from 'eslint-plugin-jsonc';
-export { default as pluginMdx } from 'eslint-plugin-mdx';
-export { default as pluginNode } from 'eslint-plugin-n';
-import * as eslintPluginNoAwaitInPromise from 'eslint-plugin-no-await-in-promise';
-export { eslintPluginNoAwaitInPromise as pluginNoAwaitInPromise };
-export { default as pluginNoOnlyTests } from 'eslint-plugin-no-only-tests';
-export { default as pluginOnlyError } from 'eslint-plugin-only-error';
-export { default as pluginPromise } from 'eslint-plugin-promise';
-export { default as pluginRegexp } from 'eslint-plugin-regexp';
-export { default as pluginSolid } from 'eslint-plugin-solid';
-export { default as pluginToml } from 'eslint-plugin-toml';
-export { default as pluginUnicorn } from 'eslint-plugin-unicorn';
-export { default as pluginUnusedImports } from 'eslint-plugin-unused-imports';
-export { default as pluginVitest } from 'eslint-plugin-vitest';
-export { default as pluginVue } from 'eslint-plugin-vue';
-export { default as pluginYaml } from 'eslint-plugin-yml';
-export { default as parserJsonc } from 'jsonc-eslint-parser';
-export { default as parserToml } from 'toml-eslint-parser';
-export { default as parserVue } from 'vue-eslint-parser';
-export { default as parserYaml } from 'yaml-eslint-parser';
+import { FlatConfigComposer } from 'eslint-flat-config-utils';
 
 interface OptionsComponentExts {
     /**
@@ -68,6 +36,10 @@ interface Options extends OptionsComponentExts {
      * Core rules. Can't be disabled.
      */
     javascript?: OptionsOverrides;
+    /**
+     * Enable HTML support.
+     */
+    html?: boolean;
     /**
      * Enable TypeScript support.
      *
@@ -153,25 +125,27 @@ type MergeIntersection<T extends Record<any, any>> = {
 };
 type RenamedRules = MergeIntersection<Rules & RenamePrefix<Rules, "@typescript-eslint/", "ts/"> & RenamePrefix<Rules, "yml/", "yaml/"> & RenamePrefix<Rules, "n/", "node/"> & Prefix<Partial<(typeof so1vePlugin)["rules"]>, "so1ve/">>;
 type ConfigItem = Omit<FlatESLintConfigItem, "plugins" | "rules"> & {
+    name?: string;
     plugins?: Record<string, any>;
     rules?: RenamedRules | Record<string, any>;
 };
+type Awaitable<T> = T | Promise<T>;
 
 declare const comments: () => ConfigItem[];
 
-declare const formatting: (options: Options) => ConfigItem[];
+declare function formatting(options: Options): Promise<ConfigItem[]>;
 
-declare const html: () => ConfigItem[];
+declare function html(): Promise<ConfigItem[]>;
 
 declare const ignores: () => ConfigItem[];
 
 declare const imports: (options?: Options) => ConfigItem[];
 
-declare const javascript: ({ overrides, }?: OptionsOverrides) => ConfigItem[];
+declare function javascript({ overrides }?: OptionsOverrides): Promise<ConfigItem[]>;
 
-declare const jsonc: () => ConfigItem[];
+declare function jsonc(): Promise<ConfigItem[]>;
 
-declare const mdx: ({ componentExts, overrides, }?: OptionsComponentExts & OptionsOverrides) => ConfigItem[];
+declare function mdx({ componentExts, overrides, }?: OptionsComponentExts & OptionsOverrides): Promise<ConfigItem[]>;
 
 declare const node: () => ConfigItem[];
 
@@ -179,26 +153,34 @@ declare const onlyError: () => ConfigItem[];
 
 declare const promise: () => ConfigItem[];
 
-declare const solid: ({ overrides, typescript, }?: OptionsHasTypeScript & OptionsOverrides) => ConfigItem[];
+declare function solid({ overrides, typescript, }?: OptionsHasTypeScript & OptionsOverrides): Promise<ConfigItem[]>;
 
 declare const sortImports: () => ConfigItem[];
 
-declare const test: ({ overrides }?: OptionsOverrides) => ConfigItem[];
+declare function test({ overrides }?: OptionsOverrides): Promise<ConfigItem[]>;
 
-declare const toml: ({ overrides }?: OptionsOverrides) => ConfigItem[];
+declare function toml({ overrides }?: OptionsOverrides): Promise<ConfigItem[]>;
 
-declare function typescript({ componentExts, parserOptions, overrides, }?: OptionsTypeScriptParserOptions & OptionsComponentExts & OptionsOverrides): ConfigItem[];
+declare function typescript({ componentExts, parserOptions, overrides, }?: OptionsTypeScriptParserOptions & OptionsComponentExts & OptionsOverrides): Promise<ConfigItem[]>;
 
 declare const unicorn: () => ConfigItem[];
 
-declare const vue: ({ overrides, typescript, }?: OptionsHasTypeScript & OptionsOverrides) => ConfigItem[];
+declare function vue({ overrides, typescript, }?: OptionsHasTypeScript & OptionsOverrides): Promise<ConfigItem[]>;
 
-declare const yaml: ({ overrides }?: OptionsOverrides) => ConfigItem[];
+declare function yaml({ overrides }?: OptionsOverrides): Promise<ConfigItem[]>;
 
+declare const defaultPluginRenaming: {
+    "@stylistic": string;
+    "@typescript-eslint": string;
+    "@html-eslint": string;
+    "import-x": string;
+    n: string;
+    yml: string;
+};
 /**
  * Construct an array of ESLint flat config items.
  */
-declare function so1ve(options?: Options & ConfigItem, ...userConfigs: (ConfigItem | ConfigItem[])[]): ConfigItem[];
+declare function so1ve(options?: Options & ConfigItem, ...userConfigs: (ConfigItem | ConfigItem[])[]): FlatConfigComposer<any, any>;
 type ResolvedOptions<T> = T extends boolean ? never : NonNullable<T>;
 declare const resolveSubOptions: <K extends keyof Options>(options: Options & ConfigItem, key: K) => ResolvedOptions<Options[K]>;
 declare function getOverrides<K extends keyof Options>(options: Options, key: K): any;
@@ -230,11 +212,31 @@ declare const GLOB_TESTS: string[];
 declare const GLOB_ALL_SRC: string[];
 declare const GLOB_EXCLUDE: string[];
 
-declare const renameRules: (rules: Record<string, any>, from: string, to: string) => {
+/**
+ * Rename plugin prefixes in a rule object. Accepts a map of prefixes to rename.
+ *
+ * @example
+ *
+ * ```ts
+ * import { renameRules } from "@antfu/eslint-config";
+ *
+ * export default [
+ * 	{
+ * 		rules: renameRules(
+ * 			{
+ * 				"@typescript-eslint/indent": "error",
+ * 			},
+ * 			{ "@typescript-eslint": "ts" },
+ * 		),
+ * 	},
+ * ];
+ * ```
+ */
+declare const renameRules: (rules: Record<string, any>, map: Record<string, string>) => {
     [k: string]: any;
 };
-declare function recordRulesStateConfigs(configs: ConfigItem[]): ConfigItem[];
-declare function recordRulesState(rules: ConfigItem["rules"]): ConfigItem["rules"];
-declare function warnUnnecessaryOffRules(): void;
+declare function interopDefault<T>(m: Awaitable<T>): Promise<T extends {
+    default: infer U;
+} ? U : T>;
 
-export { type ConfigItem, GLOB_ALL_SRC, GLOB_CSS, GLOB_DTS, GLOB_ESLINTRC, GLOB_EXCLUDE, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_PACKAGEJSON, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_TESTS, GLOB_TOML, GLOB_TS, GLOB_TSCONFIG, GLOB_TSX, GLOB_VUE, GLOB_YAML, type Options, type OptionsComponentExts, type OptionsHasTypeScript, type OptionsOverrides, type OptionsTypeScriptParserOptions, type RenamedRules, type ResolvedOptions, comments, formatting, getOverrides, html, ignores, imports, javascript, jsonc, mdx, node, onlyError, promise, recordRulesState, recordRulesStateConfigs, renameRules, resolveSubOptions, so1ve, solid, sortImports, test, toml, typescript, unicorn, vue, warnUnnecessaryOffRules, yaml };
+export { type Awaitable, type ConfigItem, GLOB_ALL_SRC, GLOB_CSS, GLOB_DTS, GLOB_ESLINTRC, GLOB_EXCLUDE, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_PACKAGEJSON, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_TESTS, GLOB_TOML, GLOB_TS, GLOB_TSCONFIG, GLOB_TSX, GLOB_VUE, GLOB_YAML, type Options, type OptionsComponentExts, type OptionsHasTypeScript, type OptionsOverrides, type OptionsTypeScriptParserOptions, type RenamedRules, type ResolvedOptions, comments, defaultPluginRenaming, formatting, getOverrides, html, ignores, imports, interopDefault, javascript, jsonc, mdx, node, onlyError, promise, renameRules, resolveSubOptions, so1ve, solid, sortImports, test, toml, typescript, unicorn, vue, yaml };