@vinicunca/eslint-config 2.1.7 → 2.3.0

package/dist/index.d.cts

@@ -9,9 +9,10 @@ export { default as pluginVinicunca } from '@vinicunca/eslint-plugin-vinicunca';
 import { Linter } from 'eslint';
 import { FlatGitignoreOptions } from 'eslint-config-flat-gitignore';
 import { Options } from 'eslint-processor-vue-blocks';
+import { FlatConfigPipeline } from 'eslint-flat-config-utils';
 export { default as pluginComments } from 'eslint-plugin-eslint-comments';
-import * as eslintPluginI from 'eslint-plugin-i';
-export { eslintPluginI as pluginImport };
+import * as eslintPluginImportX from 'eslint-plugin-import-x';
+export { eslintPluginImportX as pluginImport };
 export { default as pluginNode } from 'eslint-plugin-n';
 export { default as pluginPerfectionist } from 'eslint-plugin-perfectionist';
 export { default as pluginUnicorn } from 'eslint-plugin-unicorn';
@@ -252,6 +253,12 @@ interface OptionsUnoCSS extends OptionsOverrides {
     strict?: boolean;
 }
 interface OptionsConfig extends OptionsComponentExts {
+    /**
+     * Automatically rename plugins in the config.
+     *
+     * @default true
+     */
+    autoRenamePlugins?: boolean;
     /**
      * Use external formatters to format files.
      *
@@ -353,7 +360,15 @@ interface OptionsConfig extends OptionsComponentExts {
     yaml?: OptionsOverrides | boolean;
 }
 
-declare function vinicuncaESLint(options?: OptionsConfig & FlatConfigItem, ...userConfigs: Array<Awaitable<Array<UserConfigItem> | UserConfigItem>>): Promise<Array<UserConfigItem>>;
+declare const defaultPluginRenaming: {
+    '@stylistic': string;
+    '@typescript-eslint': string;
+    'import-x': string;
+    n: string;
+    vitest: string;
+    yml: string;
+};
+declare function vinicuncaESLint(options?: OptionsConfig & FlatConfigItem, ...userConfigs: Array<Awaitable<Array<UserConfigItem> | UserConfigItem>>): FlatConfigPipeline<UserConfigItem>;
 
 declare function comments(): Promise<FlatConfigItem[]>;
 
@@ -378,20 +393,20 @@ declare function react(options?: OptionsHasTypeScript & OptionsOverrides & Optio
  *
  * Requires `jsonc` config
  */
-declare function sortPackageJson(): Promise<FlatConfigItem[]>;
+declare function sortPackageJson(): Promise<Array<FlatConfigItem>>;
 /**
  * Sort tsconfig.json
  *
  * Requires `jsonc` config
  */
-declare function sortTsconfig(): FlatConfigItem[];
+declare function sortTsconfig(): Array<FlatConfigItem>;
 
 declare const STYLISTIC_CONFIG_DEFAULTS: StylisticConfig;
 declare function stylistic(options?: StylisticConfig & OptionsOverrides): Promise<FlatConfigItem[]>;
 
 declare function test(options?: OptionsFiles & OptionsIsInEditor & OptionsOverrides): Promise<FlatConfigItem[]>;
 
-declare function typescript(options?: OptionsFiles & OptionsComponentExts & OptionsOverrides & OptionsTypeScriptWithTypes & OptionsTypeScriptParserOptions): Promise<FlatConfigItem[]>;
+declare function typescript(options?: OptionsFiles & OptionsComponentExts & OptionsOverrides & OptionsTypeScriptWithTypes & OptionsTypeScriptParserOptions): Promise<Array<FlatConfigItem>>;
 
 declare function unicorn(): Promise<FlatConfigItem[]>;
 
@@ -405,9 +420,42 @@ declare function yaml(options?: OptionsOverrides & OptionsStylistic & OptionsFil
  * Combine array and non-array configs into a single array.
  */
 declare function combineConfigs(...configs: Array<Awaitable<Array<UserConfigItem> | UserConfigItem>>): Promise<Array<UserConfigItem>>;
-declare function 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 '@vinicunca/eslint-config'
+ *
+ * export default [{
+ *   rules: renameRules(
+ *     {
+ *       '@typescript-eslint/indent': 'error'
+ *     },
+ *     { '@typescript-eslint': 'ts' }
+ *   )
+ * }]
+ * ```
+ */
+declare function renameRules(rules: Record<string, any>, map: Record<string, string>): {
     [k: string]: any;
 };
+/**
+ * Rename plugin names a flat configs array
+ *
+ * @example
+ * ```ts
+ * import { renamePluginInConfigs } from '@vinicunca/eslint-config'
+ * import someConfigs from './some-configs'
+ *
+ * export default renamePluginInConfigs(someConfigs, {
+ *   '@typescript-eslint': 'ts',
+ *   'import-x': 'import',
+ * })
+ * ```
+ */
+declare function renamePluginInConfigs(configs: Array<UserConfigItem>, map: Record<string, string>): Array<UserConfigItem>;
 declare function interopDefault<T>(m: Awaitable<T>): Promise<T extends {
     default: infer U;
 } ? U : T>;
@@ -462,4 +510,4 @@ declare const GLOB_TESTS: string[];
 declare const GLOB_ALL_SRC: string[];
 declare const GLOB_EXCLUDE: string[];
 
-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_TESTS, 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 Rules, STYLISTIC_CONFIG_DEFAULTS, type StylisticConfig, type UserConfigItem, type WrapRuleConfig, combineConfigs, comments, ignores, imports, interopDefault, javascript, jsdoc, jsonc, markdown, node, parserPlain, react, renameRules, sortPackageJson, sortTsconfig, stylistic, test, toArray, typescript, unicorn, unocss, vinicuncaESLint, 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_TESTS, 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 Rules, STYLISTIC_CONFIG_DEFAULTS, type StylisticConfig, type UserConfigItem, type WrapRuleConfig, combineConfigs, comments, defaultPluginRenaming, ignores, imports, interopDefault, javascript, jsdoc, jsonc, markdown, node, parserPlain, react, renamePluginInConfigs, renameRules, sortPackageJson, sortTsconfig, stylistic, test, toArray, typescript, unicorn, unocss, vinicuncaESLint, vue, yaml };

package/dist/index.d.ts

@@ -9,9 +9,10 @@ export { default as pluginVinicunca } from '@vinicunca/eslint-plugin-vinicunca';
 import { Linter } from 'eslint';
 import { FlatGitignoreOptions } from 'eslint-config-flat-gitignore';
 import { Options } from 'eslint-processor-vue-blocks';
+import { FlatConfigPipeline } from 'eslint-flat-config-utils';
 export { default as pluginComments } from 'eslint-plugin-eslint-comments';
-import * as eslintPluginI from 'eslint-plugin-i';
-export { eslintPluginI as pluginImport };
+import * as eslintPluginImportX from 'eslint-plugin-import-x';
+export { eslintPluginImportX as pluginImport };
 export { default as pluginNode } from 'eslint-plugin-n';
 export { default as pluginPerfectionist } from 'eslint-plugin-perfectionist';
 export { default as pluginUnicorn } from 'eslint-plugin-unicorn';
@@ -252,6 +253,12 @@ interface OptionsUnoCSS extends OptionsOverrides {
     strict?: boolean;
 }
 interface OptionsConfig extends OptionsComponentExts {
+    /**
+     * Automatically rename plugins in the config.
+     *
+     * @default true
+     */
+    autoRenamePlugins?: boolean;
     /**
      * Use external formatters to format files.
      *
@@ -353,7 +360,15 @@ interface OptionsConfig extends OptionsComponentExts {
     yaml?: OptionsOverrides | boolean;
 }
 
-declare function vinicuncaESLint(options?: OptionsConfig & FlatConfigItem, ...userConfigs: Array<Awaitable<Array<UserConfigItem> | UserConfigItem>>): Promise<Array<UserConfigItem>>;
+declare const defaultPluginRenaming: {
+    '@stylistic': string;
+    '@typescript-eslint': string;
+    'import-x': string;
+    n: string;
+    vitest: string;
+    yml: string;
+};
+declare function vinicuncaESLint(options?: OptionsConfig & FlatConfigItem, ...userConfigs: Array<Awaitable<Array<UserConfigItem> | UserConfigItem>>): FlatConfigPipeline<UserConfigItem>;
 
 declare function comments(): Promise<FlatConfigItem[]>;
 
@@ -378,20 +393,20 @@ declare function react(options?: OptionsHasTypeScript & OptionsOverrides & Optio
  *
  * Requires `jsonc` config
  */
-declare function sortPackageJson(): Promise<FlatConfigItem[]>;
+declare function sortPackageJson(): Promise<Array<FlatConfigItem>>;
 /**
  * Sort tsconfig.json
  *
  * Requires `jsonc` config
  */
-declare function sortTsconfig(): FlatConfigItem[];
+declare function sortTsconfig(): Array<FlatConfigItem>;
 
 declare const STYLISTIC_CONFIG_DEFAULTS: StylisticConfig;
 declare function stylistic(options?: StylisticConfig & OptionsOverrides): Promise<FlatConfigItem[]>;
 
 declare function test(options?: OptionsFiles & OptionsIsInEditor & OptionsOverrides): Promise<FlatConfigItem[]>;
 
-declare function typescript(options?: OptionsFiles & OptionsComponentExts & OptionsOverrides & OptionsTypeScriptWithTypes & OptionsTypeScriptParserOptions): Promise<FlatConfigItem[]>;
+declare function typescript(options?: OptionsFiles & OptionsComponentExts & OptionsOverrides & OptionsTypeScriptWithTypes & OptionsTypeScriptParserOptions): Promise<Array<FlatConfigItem>>;
 
 declare function unicorn(): Promise<FlatConfigItem[]>;
 
@@ -405,9 +420,42 @@ declare function yaml(options?: OptionsOverrides & OptionsStylistic & OptionsFil
  * Combine array and non-array configs into a single array.
  */
 declare function combineConfigs(...configs: Array<Awaitable<Array<UserConfigItem> | UserConfigItem>>): Promise<Array<UserConfigItem>>;
-declare function 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 '@vinicunca/eslint-config'
+ *
+ * export default [{
+ *   rules: renameRules(
+ *     {
+ *       '@typescript-eslint/indent': 'error'
+ *     },
+ *     { '@typescript-eslint': 'ts' }
+ *   )
+ * }]
+ * ```
+ */
+declare function renameRules(rules: Record<string, any>, map: Record<string, string>): {
     [k: string]: any;
 };
+/**
+ * Rename plugin names a flat configs array
+ *
+ * @example
+ * ```ts
+ * import { renamePluginInConfigs } from '@vinicunca/eslint-config'
+ * import someConfigs from './some-configs'
+ *
+ * export default renamePluginInConfigs(someConfigs, {
+ *   '@typescript-eslint': 'ts',
+ *   'import-x': 'import',
+ * })
+ * ```
+ */
+declare function renamePluginInConfigs(configs: Array<UserConfigItem>, map: Record<string, string>): Array<UserConfigItem>;
 declare function interopDefault<T>(m: Awaitable<T>): Promise<T extends {
     default: infer U;
 } ? U : T>;
@@ -462,4 +510,4 @@ declare const GLOB_TESTS: string[];
 declare const GLOB_ALL_SRC: string[];
 declare const GLOB_EXCLUDE: string[];
 
-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_TESTS, 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 Rules, STYLISTIC_CONFIG_DEFAULTS, type StylisticConfig, type UserConfigItem, type WrapRuleConfig, combineConfigs, comments, ignores, imports, interopDefault, javascript, jsdoc, jsonc, markdown, node, parserPlain, react, renameRules, sortPackageJson, sortTsconfig, stylistic, test, toArray, typescript, unicorn, unocss, vinicuncaESLint, 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_TESTS, 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 Rules, STYLISTIC_CONFIG_DEFAULTS, type StylisticConfig, type UserConfigItem, type WrapRuleConfig, combineConfigs, comments, defaultPluginRenaming, ignores, imports, interopDefault, javascript, jsdoc, jsonc, markdown, node, parserPlain, react, renamePluginInConfigs, renameRules, sortPackageJson, sortTsconfig, stylistic, test, toArray, typescript, unicorn, unocss, vinicuncaESLint, vue, yaml };