@debbl/eslint-config 3.10.2 → 3.12.0

package/README.md

@@ -32,22 +32,22 @@ pnpm i eslint @debbl/eslint-config -D
 - prettier
 
 ```js
-import { defineConfig } from "@debbl/eslint-config";
+import { defineConfig } from '@debbl/eslint-config'
 
-export default defineConfig();
+export default defineConfig()
 ```
 
 ## Config `Prettier`, will override default rules
 
 ```js
-import { defineConfig } from "@debbl/eslint-config";
+import { defineConfig } from '@debbl/eslint-config'
 
 export default defineConfig({
   typescript: true,
   prettier: {
     semi: false,
   },
-});
+})
 ```
 
 ## Full OptionConfig

package/dist/index.d.ts

@@ -1,50 +1,63 @@
-import { ParserOptions } from '@typescript-eslint/parser';
-import { Linter } from 'eslint';
-import { FlatGitignoreOptions } from 'eslint-config-flat-gitignore';
-import { RequiredOptions } from 'prettier';
+import { ParserOptions } from "@typescript-eslint/parser";
+import { FlatGitignoreOptions } from "eslint-config-flat-gitignore";
+import { Linter } from "eslint";
+import { RequiredOptions } from "prettier";
 
+//#region src/configs/comments.d.ts
 declare function comments(): Promise<ConfigItem[]>;
-
+//#endregion
+//#region src/configs/ignores.d.ts
 type IgnoresConfig = (options: {
-    enableGitignore?: boolean | Omit<FlatGitignoreOptions, "name">;
-    files?: ((files: string[]) => string[]) | string[];
+  enableGitignore?: boolean | Omit<FlatGitignoreOptions, 'name'>;
+  files?: ((files: string[]) => string[]) | string[];
 }) => ReturnType<ConfigFn>;
 declare const ignores: IgnoresConfig;
-
+//#endregion
+//#region src/configs/imports.d.ts
 declare function imports(): Promise<ConfigItem[]>;
-
+//#endregion
+//#region src/configs/javascript.d.ts
 type JavascriptConfig = ConfigFn;
 declare const javascript: JavascriptConfig;
-
+//#endregion
+//#region src/configs/jsdoc.d.ts
 declare function jsdoc(): Promise<ConfigItem[]>;
-
+//#endregion
+//#region src/configs/jsonc.d.ts
 type JsoncConfig = ConfigFn;
 declare const jsonc: JsoncConfig;
-
+//#endregion
+//#region src/configs/markdown.d.ts
 type MarkdownConfig = (options: {
-    componentExts?: string[];
-    /**
-     * @deprecated remove this option
-     */
-    mdx?: boolean;
+  componentExts?: string[];
+  /**
+   * @deprecated remove this option
+   */
+  mdx?: boolean;
 } & OptionsOverrides) => ReturnType<ConfigFn>;
 declare const markdown: MarkdownConfig;
-
+//#endregion
+//#region src/configs/node.d.ts
 declare function node(): Promise<ConfigItem[]>;
-
+//#endregion
+//#region src/configs/perfectionist.d.ts
 /**
  * Perfectionist plugin for props and items sorting.
  *
  * @see https://github.com/azat-io/eslint-plugin-perfectionist
  */
 declare function perfectionist(): Promise<ConfigItem[]>;
-
+//#endregion
+//#region src/configs/prettier.d.ts
 type PrettierRequiredOptions = Partial<RequiredOptions>;
-type PrettierConfig = ({ options, }: PrettierRequiredOptions & {
-    tailwindcss?: boolean;
+type PrettierConfig = ({
+  options
+}: PrettierRequiredOptions & {
+  tailwindcss?: boolean;
 }) => Promise<ConfigItem[]>;
 declare const prettier: PrettierConfig;
-
+//#endregion
+//#region src/configs/sort.d.ts
 /**
  * Sort package.json
  *
@@ -57,166 +70,176 @@ declare function sortPackageJson(): Promise<ConfigItem[]>;
  * Requires `jsonc` config
  */
 declare function sortTsconfig(): Promise<ConfigItem[]>;
-
+//#endregion
+//#region src/configs/test.d.ts
 type TestConfig = ConfigFn;
 declare const test: TestConfig;
-
+//#endregion
+//#region src/configs/toml.d.ts
 type TomlConfig = ConfigFn;
 declare const toml: TomlConfig;
-
+//#endregion
+//#region src/configs/typescript.d.ts
 type TypeScriptConfig = (options?: OptionsComponentExts & OptionsTypeScriptWithTypes & OptionsTypeScriptParserOptions & OptionsOverrides & {
-    enableSolid?: boolean;
+  enableSolid?: boolean;
 }) => ReturnType<ConfigFn>;
 declare const typescript: TypeScriptConfig;
-
+//#endregion
+//#region src/configs/unicorn.d.ts
 declare function unicorn(): Promise<ConfigItem[]>;
-
+//#endregion
+//#region src/configs/vue.d.ts
 type VueConfig = (options: OptionsHasTypeScript & OptionsOverrides) => ReturnType<ConfigFn>;
 declare const vue: VueConfig;
-
+//#endregion
+//#region src/configs/yml.d.ts
 type YmlConfig = (options: OptionsOverrides) => ReturnType<ConfigFn>;
 declare const yml: YmlConfig;
-
+//#endregion
+//#region src/configs/react.d.ts
 type ReactConfig = (options: {
-    next?: boolean;
-    compiler?: boolean;
+  next?: boolean;
+  compiler?: boolean;
 } & OptionsOverrides) => ReturnType<ConfigFn>;
-
+//#endregion
+//#region src/types.d.ts
 type Awaitable<T> = T | Promise<T>;
 type GetConfigOption<T extends (...args: any) => any> = Parameters<T>[0];
 interface ConfigItem extends Linter.Config {
-    /**
-     * 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>;
+  /**
+   * 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>;
 }
 interface OptionsOverrides {
-    overrides?: ConfigItem["rules"];
+  overrides?: ConfigItem['rules'];
 }
 type ConfigFn = (options: OptionsOverrides) => Awaitable<ConfigItem[]>;
 interface OptionsComponentExts {
-    /**
-     * Additional extensions for components.
-     *
-     * @example ['vue']
-     * @default []
-     */
-    componentExts?: string[];
+  /**
+   * Additional extensions for components.
+   *
+   * @example ['vue']
+   * @default []
+   */
+  componentExts?: string[];
 }
 interface OptionsTypeScriptParserOptions {
-    /**
-     * Additional parser options for TypeScript.
-     */
-    parserOptions?: Partial<ParserOptions>;
+  /**
+   * Additional parser options for TypeScript.
+   */
+  parserOptions?: Partial<ParserOptions>;
 }
 interface OptionsTypeScriptWithTypes {
-    /**
-     * When this options is provided, type aware rules will be enabled.
-     * @see https://typescript-eslint.io/linting/typed-linting/
-     */
-    tsconfigPath?: string;
+  /**
+   * When this options is provided, type aware rules will be enabled.
+   * @see https://typescript-eslint.io/linting/typed-linting/
+   */
+  tsconfigPath?: string;
 }
 interface OptionsHasTypeScript {
-    typescript?: boolean;
+  typescript?: boolean;
 }
 interface OptionsConfig extends OptionsComponentExts {
-    /**
-     * Enable gitignore support.
-     * Passing an object to configure the options.
-     * @default true
-     */
-    gitignore?: boolean | FlatGitignoreOptions;
-    /**
-     * Enable gitignore support.
-     * Passing an object to configure the options.
-     * @default true
-     */
-    ignores?: boolean | GetConfigOption<IgnoresConfig>;
-    /**
-     * Enable JavaScript support.
-     * Passing an object to configure the options.
-     * @default true
-     */
-    javascript?: GetConfigOption<JavascriptConfig>;
-    /**
-     * Enable TypeScript support.
-     *
-     * Passing an object to enable TypeScript Language Server support.
-     *
-     * @default false
-     */
-    typescript?: boolean | GetConfigOption<TypeScriptConfig>;
-    /**
-     * Enable test support.
-     *
-     * @default true
-     */
-    test?: boolean | GetConfigOption<TestConfig>;
-    /**
-     * Enable Vue support.
-     *
-     * @default false
-     */
-    vue?: boolean | GetConfigOption<VueConfig>;
-    /**
-     * Enable React support, Passing an object to enable Next.js support.
-     *
-     * @default false
-     */
-    react?: boolean | GetConfigOption<ReactConfig>;
-    /**
-     * Enable solid support, Passing an object to enable Next.js support.
-     *
-     * @default false
-     */
-    solid?: boolean;
-    /**
-     * Enable JSONC support.
-     *
-     * @default true
-     */
-    jsonc?: boolean | GetConfigOption<JsoncConfig>;
-    /**
-     * Enable YML support.
-     *
-     * @default true
-     */
-    yml?: boolean | GetConfigOption<YmlConfig>;
-    /**
-     * Enable TOML support.
-     * @default true
-     */
-    toml?: boolean | GetConfigOption<TomlConfig>;
-    /**
-     * Enable Markdown support.
-     *
-     * @default true
-     */
-    markdown?: boolean | GetConfigOption<MarkdownConfig>;
-    /**
-     * Enable prettier rules.
-     *
-     * @default true
-     */
-    prettier?: boolean | Omit<GetConfigOption<PrettierConfig>, "tailwindcss">;
-    /**
-     * Enable Tailwind CSS support.
-     *
-     * if set to "prettier", it will use `prettier-plugin-tailwindcss`
-     * @see https://github.com/tailwindlabs/prettier-plugin-tailwindcss
-     *
-     * @default false
-     */
-    tailwindcss?: boolean | "prettier";
+  /**
+   * Enable gitignore support.
+   * Passing an object to configure the options.
+   * @default true
+   */
+  gitignore?: boolean | FlatGitignoreOptions;
+  /**
+   * Enable gitignore support.
+   * Passing an object to configure the options.
+   * @default true
+   */
+  ignores?: boolean | GetConfigOption<IgnoresConfig>;
+  /**
+   * Enable JavaScript support.
+   * Passing an object to configure the options.
+   * @default true
+   */
+  javascript?: GetConfigOption<JavascriptConfig>;
+  /**
+   * Enable TypeScript support.
+   *
+   * Passing an object to enable TypeScript Language Server support.
+   *
+   * @default false
+   */
+  typescript?: boolean | GetConfigOption<TypeScriptConfig>;
+  /**
+   * Enable test support.
+   *
+   * @default true
+   */
+  test?: boolean | GetConfigOption<TestConfig>;
+  /**
+   * Enable Vue support.
+   *
+   * @default false
+   */
+  vue?: boolean | GetConfigOption<VueConfig>;
+  /**
+   * Enable React support, Passing an object to enable Next.js support.
+   *
+   * @default false
+   */
+  react?: boolean | GetConfigOption<ReactConfig>;
+  /**
+   * Enable solid support, Passing an object to enable Next.js support.
+   *
+   * @default false
+   */
+  solid?: boolean;
+  /**
+   * Enable JSONC support.
+   *
+   * @default true
+   */
+  jsonc?: boolean | GetConfigOption<JsoncConfig>;
+  /**
+   * Enable YML support.
+   *
+   * @default true
+   */
+  yml?: boolean | GetConfigOption<YmlConfig>;
+  /**
+   * Enable TOML support.
+   * @default true
+   */
+  toml?: boolean | GetConfigOption<TomlConfig>;
+  /**
+   * Enable Markdown support.
+   *
+   * @default true
+   */
+  markdown?: boolean | GetConfigOption<MarkdownConfig>;
+  /**
+   * Enable prettier rules.
+   *
+   * @default true
+   */
+  prettier?: boolean | Omit<GetConfigOption<PrettierConfig>, 'tailwindcss'>;
+  /**
+   * Enable Tailwind CSS support.
+   *
+   * if set to "prettier", it will use `prettier-plugin-tailwindcss`
+   * @see https://github.com/tailwindlabs/prettier-plugin-tailwindcss
+   *
+   * @default false
+   */
+  tailwindcss?: boolean | 'prettier';
 }
-
+//#endregion
+//#region src/factory.d.ts
 /**
  * Construct an array of ESLint flat config items.
  */
 declare function defineConfig(options?: OptionsConfig, ...userConfigs: ConfigItem[]): Promise<ConfigItem[]>;
-
+//#endregion
+//#region src/globs.d.ts
 declare const GLOB_SRC_EXT = "?([cm])[jt]s?(x)";
 declare const GLOB_SRC = "**/*.?([cm])[jt]s?(x)";
 declare const GLOB_JS = "**/*.?([cm])js";
@@ -242,39 +265,40 @@ declare const GLOB_HTML = "**/*.htm?(l)";
 declare const GLOB_TESTS: string[];
 declare const GLOB_ALL_SRC: string[];
 declare const GLOB_EXCLUDE: string[];
-
+//#endregion
+//#region src/utils.d.ts
 declare const parserPlain: {
-    meta: {
-        name: string;
+  meta: {
+    name: string;
+  };
+  parseForESLint: (code: string) => {
+    ast: {
+      body: never[];
+      comments: never[];
+      loc: {
+        end: number;
+        start: number;
+      };
+      range: number[];
+      tokens: never[];
+      type: string;
     };
-    parseForESLint: (code: string) => {
-        ast: {
-            body: never[];
-            comments: never[];
-            loc: {
-                end: number;
-                start: number;
-            };
-            range: number[];
-            tokens: never[];
-            type: string;
-        };
-        scopeManager: null;
-        services: {
-            isPlain: boolean;
-        };
-        visitorKeys: {
-            Program: never[];
-        };
+    scopeManager: null;
+    services: {
+      isPlain: boolean;
     };
+    visitorKeys: {
+      Program: never[];
+    };
+  };
 };
 /**
  * Combine array and non-array configs into a single array.
  */
 declare function combine(...configs: Awaitable<ConfigItem | ConfigItem[]>[]): Promise<ConfigItem[]>;
 declare function interopDefault<T>(m: Awaitable<T>): Promise<T extends {
-    default: infer U;
+  default: infer U;
 } ? U : T>;
 declare function getConfigOptions<T>(options: T): {};
-
-export { type Awaitable, type ConfigFn, type ConfigItem, GLOB_ALL_SRC, GLOB_ASTRO_TS, GLOB_CSS, GLOB_EXCLUDE, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_MDX, GLOB_POSTCSS, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_TESTS, GLOB_TOML, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_YAML, type GetConfigOption, type IgnoresConfig, type JavascriptConfig, type JsoncConfig, type MarkdownConfig, type OptionsComponentExts, type OptionsConfig, type OptionsHasTypeScript, type OptionsOverrides, type OptionsTypeScriptParserOptions, type OptionsTypeScriptWithTypes, type PrettierConfig, type PrettierRequiredOptions, type TestConfig, type TomlConfig, type TypeScriptConfig, type VueConfig, type YmlConfig, combine, comments, defineConfig as default, defineConfig, getConfigOptions, ignores, imports, interopDefault, javascript, jsdoc, jsonc, markdown, node, parserPlain, perfectionist, prettier, sortPackageJson, sortTsconfig, test, toml, typescript, unicorn, vue, yml };
+//#endregion
+export { Awaitable, ConfigFn, ConfigItem, GLOB_ALL_SRC, GLOB_ASTRO_TS, GLOB_CSS, GLOB_EXCLUDE, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_MDX, GLOB_POSTCSS, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_TESTS, GLOB_TOML, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_YAML, GetConfigOption, IgnoresConfig, JavascriptConfig, JsoncConfig, MarkdownConfig, OptionsComponentExts, OptionsConfig, OptionsHasTypeScript, OptionsOverrides, OptionsTypeScriptParserOptions, OptionsTypeScriptWithTypes, PrettierConfig, PrettierRequiredOptions, TestConfig, TomlConfig, TypeScriptConfig, VueConfig, YmlConfig, combine, comments, defineConfig as default, defineConfig, getConfigOptions, ignores, imports, interopDefault, javascript, jsdoc, jsonc, markdown, node, parserPlain, perfectionist, prettier, sortPackageJson, sortTsconfig, test, toml, typescript, unicorn, vue, yml };