@isentinel/eslint-config 0.3.0

package/dist/index.d.cts

@@ -0,0 +1,378 @@
+import { RuleConfig, MergeIntersection, RenamePrefix, EslintCommentsRules, EslintRules, ImportRules, JsoncRules, Prefix, ReactHooksRules, ReactRules, SonarJSRules, FlatESLintConfigItem } 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 { UnprefixedRuleOptions, StylisticCustomizeOptions } from '@stylistic/eslint-plugin';
+import { ParserOptions } from '@typescript-eslint/parser';
+import { Linter } from 'eslint';
+import { FlatGitignoreOptions } from 'eslint-config-flat-gitignore';
+import { Rules as Rules$1 } from 'eslint-plugin-antfu';
+
+/** Vendor types from Prettier so we don't rely on the dependency. */
+type VendoredPrettierOptions = Partial<VendoredPrettierOptionsRequired>;
+interface VendoredPrettierOptionsRequired {
+    /**
+     * Include parentheses around a sole arrow function parameter.
+     *
+     * @default "always"
+     */
+    arrowParens: "avoid" | "always";
+    /**
+     * Put the `>` of a multi-line HTML (HTML, JSX, 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;
+    /** Print spaces between brackets in object literals. */
+    bracketSpacing: boolean;
+    /**
+     * Which end of line characters to apply.
+     *
+     * @default "lf"
+     */
+    endOfLine: "auto" | "lf" | "crlf" | "cr";
+    /**
+     * How to handle whitespaces in HTML.
+     *
+     * @default "css"
+     */
+    htmlWhitespaceSensitivity: "css" | "strict" | "ignore";
+    /**
+     * 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;
+    /** Use single quotes in JSX. */
+    jsxSingleQuote: boolean;
+    /** Provide ability to support new languages to prettier. */
+    plugins: Array<string | any>;
+    printWidth: 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";
+    /**
+     * Change when properties in objects are quoted.
+     *
+     * @default "as-needed"
+     */
+    quoteProps: "as-needed" | "consistent" | "preserve";
+    /**
+     * Format only a segment of a file.
+     *
+     * @default Number.POSITIVE_INFINITY
+     */
+    rangeEnd: number;
+    /** Format only a segment of a file. */
+    rangeStart: number;
+    /** Print semicolons at the ends of statements. */
+    semi: boolean;
+    /**
+     * Enforce single attribute per line in HTML, and JSX.
+     *
+     * @default false
+     */
+    singleAttributePerLine: boolean;
+    /** Use single quotes instead of double quotes. */
+    singleQuote: boolean;
+    /** Specify the number of spaces per indentation-level. */
+    tabWidth: number;
+    /** Print trailing commas wherever possible. */
+    trailingComma: "none" | "es5" | "all";
+    /** Indent lines with tabs instead of spaces. */
+    useTabs?: boolean;
+}
+
+type WrapRuleConfig<T extends Record<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/"> & EslintCommentsRules & EslintRules & ImportRules & RuleOptions$1 & JsoncRules & Prefix<Rules$1, "antfu/"> & Prefix<UnprefixedRuleOptions, "style/"> & ReactHooksRules & ReactRules & RenamePrefix<SonarJSRules, "sonarjs/", "sonar/"> & RuleOptions$2>>;
+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 OptionsFiles {
+    /** Override the `files` option to provide custom globs. */
+    files?: Array<string>;
+}
+type OptionsTypescript = (OptionsTypeScriptWithTypes & OptionsOverrides) | (OptionsTypeScriptParserOptions & OptionsOverrides);
+interface OptionsFormatters {
+    /**
+     * Enable formatting support for CSS, Less, Sass, and SCSS.
+     *
+     * Currently only support Prettier.
+     */
+    css?: "prettier" | boolean;
+    /**
+     * Custom options for dprint.
+     *
+     * By default it's controlled by our own config.
+     */
+    dprintOptions?: boolean;
+    /** Enable formatting support for GraphQL. */
+    graphql?: "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;
+    /**
+     * Custom options for Prettier.
+     *
+     * By default it's controlled by our own config.
+     */
+    prettierOptions?: VendoredPrettierOptions;
+    /**
+     * Enable formatting support for TOML.
+     *
+     * Currently only support dprint.
+     */
+    toml?: "dprint" | boolean;
+}
+interface OptionsComponentExtensions {
+    /** Additional extensions for components. */
+    componentExts?: Array<string>;
+}
+interface OptionsTypeScriptParserOptions {
+    /**
+     * Glob patterns for files that should be type aware.
+     *
+     * @default \['**\/*.{ts,tsx}']
+     */
+    filesTypeAware?: Array<string>;
+    /** 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 | Array<string>;
+}
+interface OptionsHasTypeScript {
+    typescript?: boolean;
+}
+interface OptionsStylistic {
+    stylistic?: boolean | StylisticConfig;
+}
+type StylisticConfig = Pick<StylisticCustomizeOptions, "indent" | "quotes" | "jsx" | "semi">;
+interface OptionsOverrides {
+    overrides?: FlatConfigItem["rules"];
+}
+interface OptionsIsInEditor {
+    isInEditor?: boolean;
+}
+interface OptionsConfig extends OptionsComponentExtensions {
+    /**
+     * Use external formatters to format files.
+     *
+     * Requires installing:
+     *
+     * - `eslint-plugin-format`.
+     *
+     * When set to `true`, it will enable all formatters.
+     *
+     * @default false
+     */
+    formatters?: boolean | OptionsFormatters;
+    /**
+     * Enable gitignore support.
+     *
+     * Passing an object to configure the options.
+     *
+     * @default true
+     * @see https://github.com/antfu/eslint-config-flat-gitignore
+     */
+    gitignore?: boolean | FlatGitignoreOptions;
+    /**
+     * Control to disable some rules in editors.
+     *
+     * @default auto-detect based on the process.env
+     */
+    isInEditor?: boolean;
+    /**
+     * Enable JSONC support.
+     *
+     * @default true
+     */
+    jsonc?: boolean | OptionsOverrides;
+    /**
+     * 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 | OptionsOverrides;
+    /**
+     * Enable react rules.
+     *
+     * Requires installing:
+     *
+     * - `eslint-plugin-react`
+     * - `eslint-plugin-react-hooks`.
+     *
+     * @default false
+     */
+    react?: boolean | OptionsOverrides;
+    /** Enable Roblox-TS support. */
+    roblox?: boolean;
+    /**
+     * Enable stylistic rules.
+     *
+     * @default true
+     */
+    stylistic?: boolean | StylisticConfig;
+    /**
+     * Enable TypeScript support.
+     *
+     * Passing an object to enable TypeScript Language Server support.
+     *
+     * @default auto-detect based on the dependencies
+     */
+    typescript?: OptionsTypescript;
+}
+
+declare function comments(): Promise<Array<FlatConfigItem>>;
+
+declare function formatters(options?: OptionsFormatters | true, stylistic?: StylisticConfig, markdownEnabled?: boolean): Promise<Array<FlatConfigItem>>;
+
+declare function ignores(): Promise<Array<FlatConfigItem>>;
+
+declare function imports(options?: OptionsStylistic): Promise<Array<FlatConfigItem>>;
+
+declare function jsdoc(options?: OptionsStylistic): Promise<Array<FlatConfigItem>>;
+
+declare function jsonc(options?: OptionsFiles & OptionsStylistic & OptionsOverrides): Promise<Array<FlatConfigItem>>;
+
+declare function markdown(options?: OptionsFiles & OptionsComponentExtensions & OptionsOverrides, formatMarkdown?: boolean): Promise<Array<FlatConfigItem>>;
+
+/**
+ * Perfectionist plugin for props and items sorting.
+ *
+ * @returns The configuration.
+ * @see https://github.com/azat-io/eslint-plugin-perfectionist
+ */
+declare function perfectionist(): Promise<Array<FlatConfigItem>>;
+
+declare function prettier(options?: OptionsFiles & OptionsComponentExtensions & OptionsOverrides & OptionsTypeScriptWithTypes & OptionsTypeScriptParserOptions): Promise<Array<FlatConfigItem>>;
+
+declare function promise(): Promise<Array<FlatConfigItem>>;
+
+declare function react(options?: OptionsHasTypeScript & OptionsOverrides & OptionsFiles): Promise<Array<FlatConfigItem>>;
+
+declare function roblox(options?: OptionsFiles & OptionsComponentExtensions & OptionsOverrides & OptionsTypeScriptWithTypes & OptionsTypeScriptParserOptions): Promise<Array<FlatConfigItem>>;
+
+declare function shopify(): Promise<Array<FlatConfigItem>>;
+
+declare function sonarjs(): Promise<Array<FlatConfigItem>>;
+
+/**
+ * Sort package.json.
+ *
+ * Requires `jsonc` config.
+ *
+ * @returns An array of flat configuration items.
+ */
+declare function sortPackageJson(): Promise<Array<FlatConfigItem>>;
+/**
+ * Sort tsconfig.json.
+ *
+ * Requires `jsonc` config.
+ *
+ * @returns An array of flat configuration items.
+ */
+declare function sortTsconfig(): Array<FlatConfigItem>;
+
+declare const StylisticConfigDefaults: StylisticConfig;
+declare function stylistic(options?: StylisticConfig): Promise<Array<FlatConfigItem>>;
+
+declare function typescript(options?: OptionsFiles & OptionsComponentExtensions & OptionsOverrides & OptionsTypeScriptWithTypes & OptionsTypeScriptParserOptions): Promise<Array<FlatConfigItem>>;
+
+declare function unicorn(): Promise<Array<FlatConfigItem>>;
+
+/**
+ * Generates an array of user configuration items based on the provided options
+ * and user configs.
+ *
+ * @param options - The options for generating the user configuration items.
+ * @param userConfigs - Additional user configuration items.
+ * @returns A promise that resolves to an array of user configuration items.
+ */
+declare function style(options?: OptionsConfig & FlatConfigItem, ...userConfigs: Array<Awaitable<UserConfigItem | Array<UserConfigItem>>>): Promise<Array<UserConfigItem>>;
+
+declare const GLOB_SRC_EXT = "?([cm])[jt]s?(x)";
+declare const GLOB_SRC = "**/*.?([cm])[jt]s?(x)";
+declare const GLOB_JS = "**/*.?([cm])js";
+declare const GLOB_JSX = "**/*.?([cm])jsx";
+declare const GLOB_TS = "**/*.?([cm])ts";
+declare const GLOB_TSX = "**/*.?([cm])tsx";
+declare const GLOB_STYLE = "**/*.{c,le,sc}ss";
+declare const GLOB_CSS = "**/*.css";
+declare const GLOB_POSTCSS = "**/*.{p,post}css";
+declare const GLOB_LESS = "**/*.less";
+declare const GLOB_SCSS = "**/*.scss";
+declare const GLOB_JSON = "**/*.json";
+declare const GLOB_JSON5 = "**/*.json5";
+declare const GLOB_JSONC = "**/*.jsonc";
+declare const GLOB_MARKDOWN = "**/*.md";
+declare const GLOB_MARKDOWN_IN_MARKDOWN = "**/*.md/*.md";
+declare const GLOB_HTML = "**/*.htm?(l)";
+declare const GLOB_MARKDOWN_CODE = "**/*.md/**/*.?([cm])[jt]s?(x)";
+declare const GLOB_ALL_SRC: string[];
+declare const GLOB_EXCLUDE: string[];
+
+/**
+ * Combine array and non-array configs into a single array.
+ *
+ * @param configs - Array of configs or a single config.
+ * @returns Combined array of configs.
+ */
+declare function combine(...configs: Array<Awaitable<UserConfigItem | Array<UserConfigItem>>>): Promise<Array<UserConfigItem>>;
+declare function renameRules(rules: Record<string, any>, from: string, to: string): Record<string, any>;
+declare function toArray<T>(value: T | Array<T>): Array<T>;
+declare function interopDefault<T>(dynamicImport: Awaitable<T>): Promise<T extends {
+    default: infer U;
+} ? U : T>;
+declare function ensurePackages(packages: Array<string>): Promise<void>;
+type ResolvedOptions<T> = T extends boolean ? never : NonNullable<T>;
+declare function resolveSubOptions<K extends keyof OptionsConfig>(options: OptionsConfig, key: K): ResolvedOptions<OptionsConfig[K]>;
+declare function getOverrides<K extends keyof OptionsConfig>(options: OptionsConfig, key: K): any;
+
+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_TS, GLOB_TSX, type OptionsComponentExtensions, type OptionsConfig, type OptionsFiles, type OptionsFormatters, type OptionsHasTypeScript, type OptionsIsInEditor, type OptionsOverrides, type OptionsStylistic, type OptionsTypeScriptParserOptions, type OptionsTypeScriptWithTypes, type OptionsTypescript, type ResolvedOptions, type Rules, type StylisticConfig, StylisticConfigDefaults, type UserConfigItem, type WrapRuleConfig, combine, comments, style as default, ensurePackages, formatters, getOverrides, ignores, imports, interopDefault, jsdoc, jsonc, markdown, perfectionist, prettier, promise, react, renameRules, resolveSubOptions, roblox, shopify, sonarjs, sortPackageJson, sortTsconfig, style, stylistic, toArray, typescript, unicorn };