@biscuittin/eslint-config 0.0.6 → 0.1.0

package/dist/index.d.cts

@@ -1,350 +0,0 @@
-import { RuleOptions } from '#typegen';
-export { ConfigNames } from '#typegen';
-import { Linter } from 'eslint';
-import { FlatConfigComposer } from 'eslint-flat-config-utils';
-import { PackageJson } from '@package-json/types';
-export { default as globals } from 'globals';
-
-/**
- * Copied from antfu/eslint-config
- * Ref: https://github.com/antfu/eslint-config/blob/5d0c2a5ef25a7bc3a2d6d55c1ce157cc47b0bf55/src/types.ts#L9
- */
-type Awaitable<T> = T | Promise<T>;
-/**
- * Copied from antfu/eslint-config
- * Ref: https://github.com/antfu/eslint-config/blob/5d0c2a5ef25a7bc3a2d6d55c1ce157cc47b0bf55/src/types.ts#L11C1-L11C32
- */
-type Rules = RuleOptions;
-
-/**
- * Copied from antfu/eslint-config
- * Ref: https://github.com/antfu/eslint-config/blob/5d0c2a5ef25a7bc3a2d6d55c1ce157cc47b0bf55/src/types.ts#L15
- */
-type TypedFlatConfigItem = Omit<Linter.Config<Linter.RulesRecord & Rules>, 'plugins'> & {
-    /**
-     * 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>;
-};
-
-declare function comments(): TypedFlatConfigItem[];
-
-declare function disables(): TypedFlatConfigItem[];
-
-interface OptionsEnvironment {
-    env?: {
-        /**
-         * Enable browser global variables.
-         *
-         * @default true
-         */
-        browser?: boolean;
-        /**
-         * Custom global variables.
-         *
-         * @default undefined
-         * @see [Configuring global variables](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#configuring-global-variables)
-         */
-        customGlobals?: Record<string, Linter.GlobalConf> | undefined;
-    };
-}
-interface OptionsIsInEditor {
-    /**
-     * Set to `true` if the code is running in an editor.
-     *
-     * @default false
-     */
-    isInEditor?: boolean;
-}
-interface OptionsExtraFiles {
-    /**
-     * Extend the `files` option to provide custom globs.
-     *
-     * @default [] (none)
-     */
-    extraFiles?: string[];
-}
-interface StylisticConfig {
-    /**
-     * The maximum line length.
-     *
-     * @default 120
-     */
-    printWidth?: number;
-    /**
-     * The number of spaces to use for indentation.
-     *
-     * @default 2
-     */
-    indentWidth?: number;
-    /**
-     * Use tabs instead of spaces.
-     *
-     * @default false
-     */
-    useTabs?: boolean;
-    /**
-     * How semi-colons should be used.
-     * - `true`: Always uses semi-colons where applicable.
-     * - `false`: Uses automatic semi-colon insertion.
-     *
-     * @default false
-     */
-    semi?: boolean;
-    /**
-     * The quote style to use.
-     * - `'single'`: Prefers using double quotes except in scenarios where the
-     *  string contains more double quotes than single quotes.
-     * - `'double'`: Prefers using single quotes except in scenarios where the
-     *  string contains more single quotes than double quotes.
-     *
-     * @default 'single'
-     */
-    quotes?: 'single' | 'double';
-    /**
-     * The quote style to use for JSX attributes.
-     * - `'single'`: Prefers using double quotes except in scenarios where the
-     *  string contains more double quotes than single quotes.
-     * - `'double'`: Prefers using single quotes except in scenarios where the
-     *  string contains more single quotes than double quotes.
-     *
-     * @default 'double'
-     */
-    jsxQuotes?: 'single' | 'double';
-    /**
-     * How trailing commas should be used.
-     * - `'none'`: Trailing commas should not be used.
-     * - `'all'`: Trailing commas should always be used.
-     * - `'multiline'`: Trailing commas should only be used in multi-line scenarios.
-     *
-     * @default 'multiline'
-     */
-    trailingComma?: 'none' | 'all' | 'multiline';
-    /**
-     * The end of line character to use.
-     * - `'auto'`: For each file, uses the last newline kind found in the file.
-     * - `'lf'`: Uses the line feed character.
-     * - `'crlf'`: Uses the carriage return and line feed characters.
-     * - `'system'`: Uses the system standard (ex. crlf on Windows).
-     *
-     * @default 'lf'
-     */
-    endOfLine?: 'auto' | 'lf' | 'crlf' | 'system';
-}
-interface OptionsStylistic {
-    /**
-     * Enable stylistic rules.
-     *
-     * @default {
-     *   printWidth: 120,
-     *   indentWidth: 2,
-     *   useTabs: false,
-     *   semi: false,
-     *   quotes: 'single',
-     *   jsxQuotes: 'double',
-     *   trailingCommas: 'multiline'
-     * }
-     */
-    stylistic?: boolean | StylisticConfig;
-}
-interface OptionsJavaScript extends OptionsEnvironment {
-    /**
-     * Set JavaScript source type to module.
-     *
-     * @default true
-     */
-    module?: boolean;
-}
-interface OptionsTypeScript extends OptionsIsInEditor {
-    /**
-     * A path to your project's TSConfig.
-     * This setting or [projectService](https://typescript-eslint.io/packages/parser/#projectservice)
-     * are required to use [rules which require type information](https://typescript-eslint.io/getting-started/typed-linting).
-     * Setting this option to `true` will using [projectService](https://typescript-eslint.io/packages/parser/#projectservice).
-     *
-     * @default true
-     * @see [@typescript-eslint/parser#project](https://typescript-eslint.io/packages/parser/#project)
-     */
-    tsconfigPath?: string | string[] | true;
-    /**
-     * This option allows you to provide the root directory for relative
-     * TSConfig paths specified in the project option above. Doing so ensures
-     * running ESLint from a directory other than the root will still be able
-     * to find your TSConfig.
-     *
-     * @default process.cwd()
-     * @see [@typescript-eslint/parser#tsconfigRootDir](https://typescript-eslint.io/packages/parser/#tsconfigrootdir)
-     */
-    tsconfigRootDir?: string;
-    /**
-     * Globs of files to allow running with the default project compiler options
-     * despite not being matched by the project service. It takes in an array of
-     * string paths that will be resolved relative to the [tsconfigRootDir](https://typescript-eslint.io/packages/parser/#tsconfigrootdir).
-     *
-     * @default [] (none)
-     * @see [@typescript-eslint/parser#allowDefaultProject](https://typescript-eslint.io/packages/parser/#allowdefaultproject)
-     */
-    allowDefaultProject?: string[];
-    /**
-     * This option allows you to provide one or more additional file extensions
-     * which should be considered in the TypeScript Program compilation. The
-     * default extensions are `['.js', '.mjs', '.cjs', '.jsx', '.ts', '.mts', '.cts', '.tsx']`.
-     * Add extensions starting with `.`, followed by the file extension. E.g.
-     * for a `.vue` file use `"extraFileExtensions": [".vue"]`.
-     *
-     * @default [] (none)
-     * @see [@typescript-eslint/parser#extraFileExtensions](https://typescript-eslint.io/packages/parser/#extrafileextensions)
-     */
-    extraFileExtensions?: string[];
-    /**
-     * Enable [@eslint-react/eslint-plugin](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin) type-checking rules.
-     *
-     * @default `true` when `react` is enabled, otherwise `false`
-     */
-    reactTypeCheck?: boolean;
-}
-type OptionsJson = OptionsExtraFiles & OptionsStylistic;
-interface OptionsReact {
-    /**
-     * Enable stylistic rules.
-     *
-     * @default true
-     */
-    stylistic?: boolean;
-    /**
-     * Enable React Compiler rules.
-     *
-     * @default false
-     */
-    reactCompiler?: boolean;
-}
-interface OptionsNodeJs extends OptionsExtraFiles {
-    /**
-     * Set JavaScript source type to module.
-     *
-     * @default Auto detect by package.json `type` field
-     */
-    module?: boolean;
-}
-interface InternalOptionsFormat {
-    extraJsonFiles?: string[];
-}
-interface OptionsFormat extends StylisticConfig {
-    /**
-     * Path to the configuration file for `dprint`.
-     *
-     * @default 'dprint.json'
-     */
-    dprintConfigPath?: string;
-}
-
-declare function formatters(options?: OptionsFormat & InternalOptionsFormat): Promise<TypedFlatConfigItem[]>;
-
-declare function ignores(userIgnores?: string[]): TypedFlatConfigItem[];
-
-declare function imports(options?: OptionsTypeScript): TypedFlatConfigItem[];
-
-declare function javascript(options?: OptionsJavaScript): TypedFlatConfigItem[];
-
-declare function json(options?: OptionsJson): TypedFlatConfigItem[];
-
-declare function jsx(): TypedFlatConfigItem[];
-
-declare function nextJs(): TypedFlatConfigItem[];
-
-declare function nodeJs(options?: OptionsNodeJs): TypedFlatConfigItem[];
-
-declare function react(options?: OptionsReact): TypedFlatConfigItem[];
-
-declare function regexp(): TypedFlatConfigItem[];
-
-declare function tailwindcss(): TypedFlatConfigItem[];
-
-declare function typescript(options?: OptionsTypeScript): TypedFlatConfigItem[];
-
-declare function unicorn(): TypedFlatConfigItem[];
-
-type UserConfig = TypedFlatConfigItem | TypedFlatConfigItem[] | FlatConfigComposer<TypedFlatConfigItem, string> | Linter.Config | Linter.Config[];
-type SharedOptions<T = object> = Omit<T, 'isInEditor' | 'enable'> & {
-    enable?: boolean;
-};
-interface ESLintConfigOptions {
-    ignores?: string[];
-    format?: SharedOptions<OptionsFormat> | boolean;
-    javascript?: SharedOptions<OptionsJavaScript> | boolean;
-    typescript?: SharedOptions<OptionsTypeScript> | boolean;
-    json?: SharedOptions<OptionsExtraFiles> | boolean;
-    react?: SharedOptions<OptionsReact> | boolean;
-    node?: SharedOptions<OptionsNodeJs> | boolean;
-}
-/**
- * Construct an array of ESLint flat config items.
- *
- * @param options
- *  The options for generating the ESLint configurations.
- * @param userConfigs
- *  The user configurations to be merged with the generated configurations.
- * @returns The merged ESLint configurations.
- */
-declare function config(options?: ESLintConfigOptions, ...userConfigs: Awaitable<UserConfig>[]): Promise<TypedFlatConfigItem[]>;
-
-/**
- * Combine array and non-array configs into a single array.
- * Copied from antfu/eslint-config
- * Ref: https://github.com/antfu/eslint-config/blob/e283983d8cb72304424f67090a3e3bdccdf95c0d/src/utils.ts#L32
- */
-declare function combine(...configs: Awaitable<TypedFlatConfigItem | TypedFlatConfigItem[]>[]): Promise<TypedFlatConfigItem[]>;
-
-declare function getFlatConfigName<T extends string>(module: T): {
-    readonly base: `@biscuittin/eslint-config/${T}`;
-    readonly setup: `@biscuittin/eslint-config/${T}/setup`;
-    readonly rules: `@biscuittin/eslint-config/${T}/rules`;
-    readonly stylistic: `@biscuittin/eslint-config/${T}/stylistic`;
-    readonly commonjs: `@biscuittin/eslint-config/${T}/commonjs`;
-    readonly module: `@biscuittin/eslint-config/${T}/module`;
-    readonly script: `@biscuittin/eslint-config/${T}/script`;
-};
-
-/**
- * Copied from SukkaW/eslint-config-sukka
- * Ref: https://github.com/SukkaW/eslint-config-sukka/blob/3a04c31727e0b5bab98fda1a6440f9932fe42dd8/packages/shared/src/get-package-json.ts#L1
- */
-
-/**
- * Gets a `package.json` data.
- * The data is cached if found, then it's used after.
- *
- * @param startPath - A file path to lookup.
- * @returns A found `package.json` data or `null`.
- *      This object have additional property `filePath`.
- */
-declare function getPackageJson(startPath?: string): PackageJson | null;
-
-declare function isInEditorEnv(): boolean;
-
-declare function isInGitHooksOrLintStaged(): boolean;
-
-declare function loadLocalFile<T = unknown>(name: string | readonly string[], cwd?: string): Promise<T | null>;
-
-declare global {
-    var __ESLINT_PLUGIN_MEMO__: Record<string, unknown> | undefined;
-}
-/**
- * Every package manager has this flaw: Even if a pinned, same version of transitive dependency
- * is depended on by multiple packages, all npm/pnpm/yarn/bun will not dedupe it, some package
- * manager even doesn't have dedupe feature (yes, bun. You are literally wasting my disk space
- * for speed).
- *
- * But if there are multiple copy of the same version of transitive dependency, they will not have
- * the same referential identity, which causes ESLint to panic and throw error.
- *
- * So we have to memoize the plugins and configs to make sure they are the same referential identity.
- *
- * Copied from SukkaW/eslint-config-sukka
- * Ref: https://github.com/SukkaW/eslint-config-sukka/blob/bbca2d568d738a1d287c473804ea8ccbf00d3c86/packages/shared/src/memoize-eslint-plugin.ts#L17
- */
-declare function memo<T>(function_: NonNullable<T>, key?: string): T;
-
-export { type Awaitable, type Rules, type TypedFlatConfigItem, combine, comments, config as default, disables, formatters, getFlatConfigName, getPackageJson, ignores, imports, isInEditorEnv, isInGitHooksOrLintStaged, javascript, json, jsx, loadLocalFile, memo, nextJs, nodeJs, react, regexp, tailwindcss, typescript, unicorn };