@jsse/eslint-config 0.1.2 → 0.1.4

package/dist/index.d.cts

@@ -5,27 +5,28 @@ export { parser as parserTs };
 import { FlatGitignoreOptions } from 'eslint-config-flat-gitignore';
 export { default as pluginStylistic } from '@stylistic/eslint-plugin';
 export { default as pluginTs } from '@typescript-eslint/eslint-plugin';
+export { default as pluginAntfu } from 'eslint-plugin-antfu';
 export { default as pluginEslintComments } from 'eslint-plugin-eslint-comments';
 import * as eslintPluginI from 'eslint-plugin-i';
 export { eslintPluginI as pluginImport };
 export { default as pluginJsdoc } from 'eslint-plugin-jsdoc';
 import * as eslintPluginJsonc from 'eslint-plugin-jsonc';
 export { eslintPluginJsonc as pluginJsonc };
+export { default as pluginMarkdown } from 'eslint-plugin-markdown';
 export { default as pluginN } from 'eslint-plugin-n';
 export { default as pluginNoOnlyTests } from 'eslint-plugin-no-only-tests';
+export { default as pluginPerfectionist } from 'eslint-plugin-perfectionist';
 export { default as pluginReact } from 'eslint-plugin-react';
 export { default as pluginReactHooks } from 'eslint-plugin-react-hooks';
 import * as eslintPluginReactRefresh from 'eslint-plugin-react-refresh';
 export { eslintPluginReactRefresh as pluginReactRefresh };
 import * as eslintPluginSortKeys from 'eslint-plugin-sort-keys';
 export { eslintPluginSortKeys as pluginSortKeys };
+export { default as pluginTailwind } from 'eslint-plugin-tailwindcss';
 export { default as pluginUnicorn } from 'eslint-plugin-unicorn';
 export { default as pluginUnusedImports } from 'eslint-plugin-unused-imports';
-export { default as pluginTailwind } from 'eslint-plugin-tailwindcss';
 export { default as pluginVitest } from 'eslint-plugin-vitest';
 export { default as parserJsonc } from 'jsonc-eslint-parser';
-export { default as pluginMarkdown } from 'eslint-plugin-markdown';
-export { default as pluginPerfectionist } from 'eslint-plugin-perfectionist';
 
 type Awaitable<T> = T | Promise<T>;
 type Rules = MergeIntersection<TypeScriptRules & VitestRules & YmlRules & NRules & ImportRules & EslintRules & JsoncRules & UnicornRules & EslintCommentsRules & {
@@ -61,6 +62,8 @@ type OptionsComponentExts = {
      */
     componentExts?: string[];
 };
+type PromiseFlatConfigItem = Promise<FlatConfigItem[]>;
+type EslintConfigFn<T = undefined> = (options?: T) => PromiseFlatConfigItem;
 type OptionsFiles = {
     /**
      * Override the `files` option to provide custom globs.
@@ -118,6 +121,15 @@ type OptionsConfig = {
     off?: string[];
     fast?: boolean;
     prettier?: boolean;
+    /**
+     * The prefix for the name of the config item.
+     * @default "jsse"
+     */
+    rootId?: string;
+    /**
+     * Optional function to run before the final config is returned.
+     */
+    preReturn?: (configs: FlatConfigItem[]) => FlatConfigItem[] | Awaitable<FlatConfigItem[]>;
     /**
      * Enable gitignore support.
      *
@@ -195,28 +207,37 @@ type OptionsConfig = {
     };
 } & OptionsComponentExts;
 
-declare function comments(): FlatConfigItem[];
+declare const comments: EslintConfigFn;
 
-declare function ignores(): FlatConfigItem[];
+declare const ignores: EslintConfigFn;
 
-declare function imports(options?: OptionsStylistic): FlatConfigItem[];
+declare const imports: EslintConfigFn<OptionsStylistic>;
 
-declare function javascript(options?: OptionsIsInEditor & OptionsOverrides & {
+type JavascriptOptions = OptionsIsInEditor & OptionsOverrides & {
     reportUnusedDisableDirectives?: boolean;
-}): FlatConfigItem[];
+};
+declare const javascript: EslintConfigFn<JavascriptOptions>;
+
+declare const jsdoc: EslintConfigFn;
 
-declare function jsdoc(): FlatConfigItem[];
+type JsoncOptions = OptionsStylistic & OptionsOverrides;
+declare const jsonc: EslintConfigFn<JsoncOptions>;
 
-declare function jsonc(options?: OptionsStylistic & OptionsOverrides): FlatConfigItem[];
+declare const n: EslintConfigFn;
 
-declare function node(): FlatConfigItem[];
+/**
+ * Optional perfectionist plugin for props and items sorting.
+ *
+ * @see https://github.com/azat-io/eslint-plugin-perfectionist
+ */
+declare const perfectionist: EslintConfigFn;
 
 /**
  * Copied from https://raw.githubusercontent.com/prettier/eslint-config-prettier/main/index.js
  * Main difference is we exclude rules we don't care about.... (flow/babel/etc)
  */
 declare function eslintConfigPrettierRules(): FlatConfigItem["rules"];
-declare function prettier(): FlatConfigItem[];
+declare const prettier: EslintConfigFn;
 
 declare function reactRules(): {
     "react-hooks/exhaustive-deps": string;
@@ -346,33 +367,29 @@ declare function reactHooks(): {
         "react-hooks/rules-of-hooks": string;
     };
 }[];
-declare function react(options?: OptionsComponentExts & OptionsOverrides & OptionsTypeScriptWithTypes & OptionsTypeScriptParserOptions & OptionsReact): FlatConfigItem[];
+type ReactOptions = OptionsComponentExts & OptionsOverrides & OptionsTypeScriptWithTypes & OptionsTypeScriptParserOptions & OptionsReact;
+declare const react: EslintConfigFn<ReactOptions>;
 
 /**
  * Sort package.json
  *
  * Requires `jsonc` config
  */
-declare function sortPackageJson(): FlatConfigItem[];
+declare const sortPackageJson: EslintConfigFn;
 /**
  * Sort tsconfig.json
  *
  * Requires `jsonc` config
  */
-declare function sortTsconfig(): FlatConfigItem[];
-
-declare function test(options?: OptionsIsInEditor & OptionsOverrides): FlatConfigItem[];
+declare const sortTsconfig: EslintConfigFn;
 
-declare function typescript(options?: OptionsComponentExts & OptionsOverrides & OptionsTypeScriptWithTypes & OptionsTypeScriptParserOptions & OptionsReact & OptionsPrefix): Promise<FlatConfigItem[]>;
+type TestOptions = OptionsIsInEditor & OptionsOverrides;
+declare const test: EslintConfigFn<TestOptions>;
 
-declare function unicorn(): FlatConfigItem[];
+type TypescriptOptions = OptionsComponentExts & OptionsOverrides & OptionsTypeScriptWithTypes & OptionsTypeScriptParserOptions & OptionsReact & OptionsPrefix;
+declare const typescript: EslintConfigFn<TypescriptOptions>;
 
-/**
- * Optional perfectionist plugin for props and items sorting.
- *
- * @see https://github.com/azat-io/eslint-plugin-perfectionist
- */
-declare function perfectionist(): FlatConfigItem[];
+declare const unicorn: EslintConfigFn;
 
 /**
  * Construct an array of ESLint flat config items.
@@ -404,6 +421,10 @@ declare const GLOB_EXCLUDE: string[];
  * Combine array and non-array configs into a single array.
  */
 declare function combine(...configs: (FlatConfigItem | FlatConfigItem[])[]): FlatConfigItem[];
+/**
+ * Combine array and non-array configs into a single array.
+ */
+declare function combineAsync<T>(...configs: Awaitable<T | T[]>[]): Promise<T[]>;
 declare function renameRules<TRule = unknown>(rules: Record<string, TRule>, from: string, to: string): Record<string, TRule>;
 declare function interopDefault<T>(m: Awaitable<T>): Promise<T extends {
     default: infer U;
@@ -414,4 +435,4 @@ declare function isInEditor(): boolean;
 declare function jssestd(): Promise<FlatConfigItem[]>;
 declare function jsseReact(): Promise<FlatConfigItem[]>;
 
-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_YAML, type OptionsCommon, type OptionsComponentExts, type OptionsConfig, type OptionsFiles, type OptionsHasTypeScript, type OptionsIsInEditor, type OptionsOverrides, type OptionsPrefix, type OptionsReact, type OptionsStylistic, type OptionsTypeScriptParserOptions, type OptionsTypeScriptWithTypes, type Rules, type StylisticConfig, combine, comments, jsse as default, eslintConfigPrettierRules, ignores, imports, interopDefault, isCI, isInEditor, javascript, jsdoc, jsonc, jsse, jsseReact, jssestd, node, perfectionist, prettier, react, reactHooks, reactRules, renameRules, sortPackageJson, sortTsconfig, test, typescript, unicorn };
+export { type Awaitable, type EslintConfigFn, 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_YAML, type OptionsCommon, type OptionsComponentExts, type OptionsConfig, type OptionsFiles, type OptionsHasTypeScript, type OptionsIsInEditor, type OptionsOverrides, type OptionsPrefix, type OptionsReact, type OptionsStylistic, type OptionsTypeScriptParserOptions, type OptionsTypeScriptWithTypes, type PromiseFlatConfigItem, type Rules, type StylisticConfig, combine, combineAsync, comments, jsse as default, eslintConfigPrettierRules, ignores, imports, interopDefault, isCI, isInEditor, javascript, jsdoc, jsonc, jsse, jsseReact, jssestd, n, perfectionist, prettier, react, reactHooks, reactRules, renameRules, sortPackageJson, sortTsconfig, test, typescript, unicorn };

package/dist/index.d.ts

@@ -5,27 +5,28 @@ export { parser as parserTs };
 import { FlatGitignoreOptions } from 'eslint-config-flat-gitignore';
 export { default as pluginStylistic } from '@stylistic/eslint-plugin';
 export { default as pluginTs } from '@typescript-eslint/eslint-plugin';
+export { default as pluginAntfu } from 'eslint-plugin-antfu';
 export { default as pluginEslintComments } from 'eslint-plugin-eslint-comments';
 import * as eslintPluginI from 'eslint-plugin-i';
 export { eslintPluginI as pluginImport };
 export { default as pluginJsdoc } from 'eslint-plugin-jsdoc';
 import * as eslintPluginJsonc from 'eslint-plugin-jsonc';
 export { eslintPluginJsonc as pluginJsonc };
+export { default as pluginMarkdown } from 'eslint-plugin-markdown';
 export { default as pluginN } from 'eslint-plugin-n';
 export { default as pluginNoOnlyTests } from 'eslint-plugin-no-only-tests';
+export { default as pluginPerfectionist } from 'eslint-plugin-perfectionist';
 export { default as pluginReact } from 'eslint-plugin-react';
 export { default as pluginReactHooks } from 'eslint-plugin-react-hooks';
 import * as eslintPluginReactRefresh from 'eslint-plugin-react-refresh';
 export { eslintPluginReactRefresh as pluginReactRefresh };
 import * as eslintPluginSortKeys from 'eslint-plugin-sort-keys';
 export { eslintPluginSortKeys as pluginSortKeys };
+export { default as pluginTailwind } from 'eslint-plugin-tailwindcss';
 export { default as pluginUnicorn } from 'eslint-plugin-unicorn';
 export { default as pluginUnusedImports } from 'eslint-plugin-unused-imports';
-export { default as pluginTailwind } from 'eslint-plugin-tailwindcss';
 export { default as pluginVitest } from 'eslint-plugin-vitest';
 export { default as parserJsonc } from 'jsonc-eslint-parser';
-export { default as pluginMarkdown } from 'eslint-plugin-markdown';
-export { default as pluginPerfectionist } from 'eslint-plugin-perfectionist';
 
 type Awaitable<T> = T | Promise<T>;
 type Rules = MergeIntersection<TypeScriptRules & VitestRules & YmlRules & NRules & ImportRules & EslintRules & JsoncRules & UnicornRules & EslintCommentsRules & {
@@ -61,6 +62,8 @@ type OptionsComponentExts = {
      */
     componentExts?: string[];
 };
+type PromiseFlatConfigItem = Promise<FlatConfigItem[]>;
+type EslintConfigFn<T = undefined> = (options?: T) => PromiseFlatConfigItem;
 type OptionsFiles = {
     /**
      * Override the `files` option to provide custom globs.
@@ -118,6 +121,15 @@ type OptionsConfig = {
     off?: string[];
     fast?: boolean;
     prettier?: boolean;
+    /**
+     * The prefix for the name of the config item.
+     * @default "jsse"
+     */
+    rootId?: string;
+    /**
+     * Optional function to run before the final config is returned.
+     */
+    preReturn?: (configs: FlatConfigItem[]) => FlatConfigItem[] | Awaitable<FlatConfigItem[]>;
     /**
      * Enable gitignore support.
      *
@@ -195,28 +207,37 @@ type OptionsConfig = {
     };
 } & OptionsComponentExts;
 
-declare function comments(): FlatConfigItem[];
+declare const comments: EslintConfigFn;
 
-declare function ignores(): FlatConfigItem[];
+declare const ignores: EslintConfigFn;
 
-declare function imports(options?: OptionsStylistic): FlatConfigItem[];
+declare const imports: EslintConfigFn<OptionsStylistic>;
 
-declare function javascript(options?: OptionsIsInEditor & OptionsOverrides & {
+type JavascriptOptions = OptionsIsInEditor & OptionsOverrides & {
     reportUnusedDisableDirectives?: boolean;
-}): FlatConfigItem[];
+};
+declare const javascript: EslintConfigFn<JavascriptOptions>;
+
+declare const jsdoc: EslintConfigFn;
 
-declare function jsdoc(): FlatConfigItem[];
+type JsoncOptions = OptionsStylistic & OptionsOverrides;
+declare const jsonc: EslintConfigFn<JsoncOptions>;
 
-declare function jsonc(options?: OptionsStylistic & OptionsOverrides): FlatConfigItem[];
+declare const n: EslintConfigFn;
 
-declare function node(): FlatConfigItem[];
+/**
+ * Optional perfectionist plugin for props and items sorting.
+ *
+ * @see https://github.com/azat-io/eslint-plugin-perfectionist
+ */
+declare const perfectionist: EslintConfigFn;
 
 /**
  * Copied from https://raw.githubusercontent.com/prettier/eslint-config-prettier/main/index.js
  * Main difference is we exclude rules we don't care about.... (flow/babel/etc)
  */
 declare function eslintConfigPrettierRules(): FlatConfigItem["rules"];
-declare function prettier(): FlatConfigItem[];
+declare const prettier: EslintConfigFn;
 
 declare function reactRules(): {
     "react-hooks/exhaustive-deps": string;
@@ -346,33 +367,29 @@ declare function reactHooks(): {
         "react-hooks/rules-of-hooks": string;
     };
 }[];
-declare function react(options?: OptionsComponentExts & OptionsOverrides & OptionsTypeScriptWithTypes & OptionsTypeScriptParserOptions & OptionsReact): FlatConfigItem[];
+type ReactOptions = OptionsComponentExts & OptionsOverrides & OptionsTypeScriptWithTypes & OptionsTypeScriptParserOptions & OptionsReact;
+declare const react: EslintConfigFn<ReactOptions>;
 
 /**
  * Sort package.json
  *
  * Requires `jsonc` config
  */
-declare function sortPackageJson(): FlatConfigItem[];
+declare const sortPackageJson: EslintConfigFn;
 /**
  * Sort tsconfig.json
  *
  * Requires `jsonc` config
  */
-declare function sortTsconfig(): FlatConfigItem[];
-
-declare function test(options?: OptionsIsInEditor & OptionsOverrides): FlatConfigItem[];
+declare const sortTsconfig: EslintConfigFn;
 
-declare function typescript(options?: OptionsComponentExts & OptionsOverrides & OptionsTypeScriptWithTypes & OptionsTypeScriptParserOptions & OptionsReact & OptionsPrefix): Promise<FlatConfigItem[]>;
+type TestOptions = OptionsIsInEditor & OptionsOverrides;
+declare const test: EslintConfigFn<TestOptions>;
 
-declare function unicorn(): FlatConfigItem[];
+type TypescriptOptions = OptionsComponentExts & OptionsOverrides & OptionsTypeScriptWithTypes & OptionsTypeScriptParserOptions & OptionsReact & OptionsPrefix;
+declare const typescript: EslintConfigFn<TypescriptOptions>;
 
-/**
- * Optional perfectionist plugin for props and items sorting.
- *
- * @see https://github.com/azat-io/eslint-plugin-perfectionist
- */
-declare function perfectionist(): FlatConfigItem[];
+declare const unicorn: EslintConfigFn;
 
 /**
  * Construct an array of ESLint flat config items.
@@ -404,6 +421,10 @@ declare const GLOB_EXCLUDE: string[];
  * Combine array and non-array configs into a single array.
  */
 declare function combine(...configs: (FlatConfigItem | FlatConfigItem[])[]): FlatConfigItem[];
+/**
+ * Combine array and non-array configs into a single array.
+ */
+declare function combineAsync<T>(...configs: Awaitable<T | T[]>[]): Promise<T[]>;
 declare function renameRules<TRule = unknown>(rules: Record<string, TRule>, from: string, to: string): Record<string, TRule>;
 declare function interopDefault<T>(m: Awaitable<T>): Promise<T extends {
     default: infer U;
@@ -414,4 +435,4 @@ declare function isInEditor(): boolean;
 declare function jssestd(): Promise<FlatConfigItem[]>;
 declare function jsseReact(): Promise<FlatConfigItem[]>;
 
-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_YAML, type OptionsCommon, type OptionsComponentExts, type OptionsConfig, type OptionsFiles, type OptionsHasTypeScript, type OptionsIsInEditor, type OptionsOverrides, type OptionsPrefix, type OptionsReact, type OptionsStylistic, type OptionsTypeScriptParserOptions, type OptionsTypeScriptWithTypes, type Rules, type StylisticConfig, combine, comments, jsse as default, eslintConfigPrettierRules, ignores, imports, interopDefault, isCI, isInEditor, javascript, jsdoc, jsonc, jsse, jsseReact, jssestd, node, perfectionist, prettier, react, reactHooks, reactRules, renameRules, sortPackageJson, sortTsconfig, test, typescript, unicorn };
+export { type Awaitable, type EslintConfigFn, 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_YAML, type OptionsCommon, type OptionsComponentExts, type OptionsConfig, type OptionsFiles, type OptionsHasTypeScript, type OptionsIsInEditor, type OptionsOverrides, type OptionsPrefix, type OptionsReact, type OptionsStylistic, type OptionsTypeScriptParserOptions, type OptionsTypeScriptWithTypes, type PromiseFlatConfigItem, type Rules, type StylisticConfig, combine, combineAsync, comments, jsse as default, eslintConfigPrettierRules, ignores, imports, interopDefault, isCI, isInEditor, javascript, jsdoc, jsonc, jsse, jsseReact, jssestd, n, perfectionist, prettier, react, reactHooks, reactRules, renameRules, sortPackageJson, sortTsconfig, test, typescript, unicorn };