@jsse/eslint-config 0.9.2 → 0.9.4

package/dist/fixable-rules-map-Ct5mIeIb.d.ts

@@ -0,0 +1,487 @@
+import { A as E18eRules, C as JsoncRules, M as CommandRules, N as BuiltinRules, O as EslintReactRules, P as AntfuRules, S as MarkdownRules, T as JavascriptRules, _ as PnpmRules, a as VitestRules, c as TypescriptRules, h as ReactHooksRules, i as YmlRules, j as DeMorganRules, m as ReactRefreshRules, o as UnusedImportsRules, s as UnicornRules, t as AllRules, u as StylisticRules, w as JsdocRules, x as NRules, y as NodeTestRules } from "./rule-types-BuPkMYJJ.js";
+import { ParserOptions } from "@typescript-eslint/parser";
+import { Linter } from "eslint";
+//#region node_modules/.pnpm/eslint-config-flat-gitignore@2.3.0_eslint@10.6.0_jiti@2.7.0_/node_modules/eslint-config-flat-gitignore/dist/index.d.mts
+interface FlatGitignoreOptions {
+  /**
+   * Name of the configuration.
+   * @default 'gitignore'
+   */
+  name?: string;
+  /**
+   * Path to `.gitignore` files, or files with compatible formats like `.eslintignore`.
+   * @default ['.gitignore'] // or findUpSync('.gitignore')
+   */
+  files?: string | string[];
+  /**
+   * Path to `.gitmodules` file.
+   * @default ['.gitmodules'] // or findUpSync('.gitmodules')
+   */
+  filesGitModules?: string | string[];
+  /**
+   * Throw an error if gitignore file not found.
+   * @default true
+   */
+  strict?: boolean;
+  /**
+   * Mark the current working directory as the root directory,
+   * disable searching for `.gitignore` files in parent directories.
+   *
+   * This option is not effective when `files` is explicitly specified.
+   * @default false
+   */
+  root?: boolean;
+  /**
+   * Current working directory.
+   * Used to resolve relative paths.
+   * @default process.cwd()
+   */
+  cwd?: string;
+  /**
+   * Also include recursive `.gitignore` files under `cwd`.
+   *
+   * This option is useful for monorepos or projects that keep
+   * per-folder `.gitignore` files.
+   *
+   * Pass `{ skipDirs: ['name'] }` to skip directory names while
+   * scanning recursively. `skipDirs` matches by directory name at
+   * any depth (not by path), and is applied in addition to `.git`
+   * and `node_modules`.
+   * @default false
+   */
+  recursive?: boolean | {
+    skipDirs: string[];
+  };
+}
+//#endregion
+//#region src/types.d.ts
+type RulesRecord = Linter.RulesRecord & AllRules;
+type Config = Omit<Linter.Config<Linter.RulesRecord & AllRules>, "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>;
+};
+type TypescriptConfigRules = TypescriptRules & BuiltinRules;
+type Awaitable<T> = T | Promise<T>;
+type RuleName = keyof AllRules;
+type TypedFlatConfigItemWithId = Config & {
+  name: string;
+};
+type OptionsComponentExts = {
+  /**
+   * Additional extensions for components.
+   * @example ['vue']
+   * @default []
+   */
+  componentExts?: string[];
+};
+type EslintConfigFnAsync<T = undefined> = (options?: T) => Promise<TypedFlatConfigItemWithId[]>;
+type EslintConfigFnSync<T = undefined> = (options?: T) => TypedFlatConfigItemWithId[];
+type EslintConfigFn<T = undefined> = EslintConfigFnAsync<T> | EslintConfigFnSync<T>;
+type OptionsFiles = {
+  /**
+   * Override the `files` option to provide custom globs.
+   */
+  files?: string[];
+};
+type OptionsTypeScriptParserOptions = {
+  /**
+   * Additional parser options for TypeScript.
+   */
+  parserOptions?: Partial<ParserOptions>;
+  /**
+   * Flag to use `projectService` for type-aware linting.
+   *
+   * If `true` use fancy new `projectService` for type-aware linting.
+   * If `false` use classic `project` configuration.
+   *
+   * When omitted, this is auto-detected: `projectService` is used only
+   * when `tsconfig` is exactly `"tsconfig.json"` (or `["tsconfig.json"]`);
+   * any other `tsconfig` value falls back to classic `project` mode.
+   * @default auto-detected from `tsconfig`
+   */
+  useProjectService?: boolean;
+  /**
+   * Glob patterns for files that should be type aware.
+   * @default ['**\/*.{ts,tsx}']
+   */
+  filesTypeAware?: string[];
+  /**
+   * Glob patterns for files that should not be type aware.
+   * @default ['**\/*.md\/**']
+   */
+  ignoresTypeAware?: string[];
+};
+type TypescriptPreset = "all" | "base" | "disable-type-checked" | "eslint-recommended" | "recommended" | "recommended-type-checked" | "recommended-type-checked-only" | "strict" | "strict-type-checked" | "strict-type-checked-only" | "stylistic" | "stylistic-type-checked" | "stylistic-type-checked-only";
+type OptionsTypeScriptWithTypes = {
+  /**
+   * When this options is provided, type aware rules will be enabled.
+   * @see https://typescript-eslint.io/linting/typed-linting/
+   */
+  tsconfig?: string | string[];
+  /**
+   * Override only type-aware rules.
+   */
+  overridesTypeAware?: Config["rules"];
+  /**
+   * Override TypeScript rules.
+   */
+  overrides?: TypescriptConfigRules;
+  /**
+   * TypeScript ESLint preset or presets to use as the base ruleset.
+   *
+   * Preset names match the kebab-case TypeScript ESLint config names.
+   * @default "recommended-type-checked" when type-aware, otherwise "recommended"
+   */
+  presets?: TypescriptPreset | TypescriptPreset[];
+  /**
+   * strict vs recommended configs, cannot be used with presets
+   * @default false
+   */
+  strict?: boolean;
+  /**
+   * typeAware
+   */
+  typeAware?: boolean;
+};
+type OptionsTypescript = OptionsTypeScriptWithTypes & OptionsTypeScriptParserOptions & {
+  typedefs?: "type" | "interface";
+};
+type OptionsStylistic = {
+  stylistic?: boolean | StylisticConfig;
+};
+type StylisticConfig = {
+  indent?: number | "tab";
+  quotes?: "single" | "double";
+  jsx?: boolean;
+  overrides?: StylisticRules;
+};
+type OptionsIsInEditor = {
+  isInEditor?: boolean;
+};
+type OptionsAntfu = {
+  topLevelFunction?: "error" | "off";
+  overrides?: AntfuRules;
+};
+type OptionsCommand = {
+  overrides?: CommandRules;
+};
+type OptionsDeMorgan = {
+  overrides?: DeMorganRules;
+};
+type OptionsE18e = {
+  modernization?: boolean;
+  moduleReplacements?: boolean;
+  performanceImprovements?: boolean;
+  overrides?: E18eRules;
+};
+type OptionsJavascript = {
+  overrides?: JavascriptRules;
+};
+type OptionsJsdoc = {
+  overrides?: JsdocRules;
+};
+type OptionsJsonc = OptionsStylistic & {
+  overrides?: JsoncRules;
+};
+type OptionsMarkdown = OptionsComponentExts & {
+  overrides?: MarkdownRules;
+};
+type OptionsN = {
+  overrides?: NRules;
+};
+type OptionsNodeTest = {
+  /**
+   * Files to include for node-test rules.
+   *
+   * Defaults to `GLOB_TESTS`
+   */
+  files?: string[];
+  /**
+   * eslint-node-test preset to use as the base ruleset.
+   * @default "recommended"
+   */
+  preset?: "recommended" | "unopinionated" | "all";
+  /**
+   * Override eslint-node-test rules after applying the preset.
+   */
+  overrides?: NodeTestRules;
+};
+type OptionsPnpm = {
+  overrides?: PnpmRules;
+};
+type ReactHooksPreset = "recommended" | "recommended-latest";
+type ReactPreset = "recommended" | "recommended-type-checked" | "recommended-typescript" | "strict" | "strict-type-checked" | "strict-typescript";
+type OptionsReactConfig = {
+  /**
+   * Enable eslint-plugin-react-hooks rules or select its preset.
+   * @default "recommended"
+   */
+  hooks?: boolean | ReactHooksPreset;
+  /**
+   * Enable eslint-plugin-react-refresh rules.
+   * @default true
+   */
+  refresh?: boolean;
+  /**
+   * Use `refresh` instead.
+   * @deprecated
+   */
+  reactRefresh?: boolean;
+  overrides?: EslintReactRules & ReactHooksRules & ReactRefreshRules;
+  /**
+   * `@eslint-react/eslint-plugin` preset to use as the base ruleset.
+   *
+   * Preset names match the kebab-case `@eslint-react` config names.
+   * @default "recommended"
+   */
+  preset?: ReactPreset;
+};
+type OptionsSortTsconfig = {
+  extendTsconfigGlobs?: string[];
+};
+type OptionsUnicorn = {
+  /**
+   * Unicorn preset to use as the base ruleset.
+   * @default "recommended"
+   */
+  preset?: "recommended" | "unopinionated" | "all";
+  /**
+   * Override Unicorn rules after applying the preset and built-in rules.
+   */
+  overrides?: UnicornRules;
+};
+type OptionsUnusedImports = OptionsIsInEditor & {
+  /**
+   * Override eslint-plugin-unused-imports rules after applying built-in rules.
+   */
+  overrides?: UnusedImportsRules;
+};
+type OptionsVitest = {
+  overrides?: VitestRules;
+};
+type OptionsYaml = OptionsFiles & OptionsStylistic & {
+  overrides?: YmlRules;
+};
+type OptionsConfigs = {
+  /**
+   * Enable eslint-plugin-antfu.
+   * @default true
+   */
+  antfu?: boolean | OptionsAntfu;
+  /**
+   * Enable `eslint-plugin-command`
+   * @default true
+   */
+  command?: boolean | OptionsCommand;
+  /**
+   * Enable eslint-plugin-de-morgan.
+   * @default true
+   */
+  demorgan?: boolean | OptionsDeMorgan;
+  /**
+   * Enable @e18e/eslint-plugin.
+   * @default true
+   */
+  e18e?: boolean | OptionsE18e;
+  /**
+   * Configure JavaScript rules.
+   */
+  javascript?: OptionsJavascript;
+  /**
+   * Enable eslint-plugin-jsdoc.
+   * @default true
+   */
+  jsdoc?: boolean | OptionsJsdoc;
+  /**
+   * Enable eslint-plugin-n (Node.js rules).
+   * @default true
+   */
+  n?: boolean | OptionsN;
+  /**
+   * Enable `eslint-node-test` (Node.js built-in test runner rules).
+   * @default false
+   */
+  nodeTest?: boolean | OptionsNodeTest;
+  /**
+   * Enable eslint-plugin-pnpm.
+   * @default false
+   */
+  pnpm?: boolean | OptionsPnpm;
+  /**
+   * Enable TypeScript support.
+   *
+   * Passing an object to enable TypeScript Language Server support.
+   * @default auto-detect based on the dependencies
+   */
+  typescript?: boolean | OptionsTypescript;
+  /**
+   * Enable eslint-plugin-unicorn.
+   * @default true
+   */
+  unicorn?: boolean | OptionsUnicorn;
+  /**
+   * Enable eslint-plugin-unused-imports.
+   * @default true
+   */
+  unusedImports?: boolean | OptionsUnusedImports;
+  react?: boolean | OptionsReactConfig;
+  /**
+   * Enable regexp plugin
+   * @default true
+   */
+  regexp?: boolean;
+  /**
+   * Enable `@vitest/eslint-plugin` (Vitest rules).
+   * @default auto-detect based on the dependencies
+   */
+  vitest?: boolean | OptionsVitest;
+  /**
+   * Enable JSONC support.
+   * @default true
+   */
+  jsonc?: boolean | OptionsJsonc;
+  /**
+   * Enable YAML support.
+   * @default false
+   */
+  yaml?: boolean | OptionsYaml;
+  /**
+   * Enable Markdown support.
+   * @default false
+   */
+  markdown?: boolean | OptionsMarkdown;
+  /**
+   * Enable stylistic rules.
+   * @default true
+   */
+  stylistic?: boolean | StylisticConfig;
+};
+/**
+ * Deprecated options that are still supported
+ */
+type OptionsDeprecated = {
+  /**
+   * Enable `eslint-plugin-react-refresh` rules.
+   * @default true
+   * @deprecated use `react.refresh` instead
+   */
+  reactRefresh?: boolean;
+  /**
+   * Enable Tailwind CSS support.
+   *
+   * Passing an object to configure the options.
+   * Tailwind support is currently disabled; passing this option only logs a warning.
+   * @deprecated deprecated tw support
+   * @default false
+   */
+  tailwind?: boolean | {
+    overrides?: Record<string, unknown>;
+  };
+};
+type OptionsConfig = OptionsComponentExts & OptionsTypeScriptParserOptions & OptionsConfigs & OptionsDeprecated & {
+  /**
+   * Enable debug mode.
+   */
+  debug?: boolean;
+  /**
+   * Enable configuration diagnostics.
+   * @default true
+   */
+  diagnostics?: boolean;
+  /**
+   * Enable reporting of unused disable directives.
+   * @default true
+   */
+  reportUnusedDisableDirectives?: boolean;
+  /**
+   * Array of rules to turn off.
+   */
+  off?: RuleName[] | Set<RuleName>;
+  /**
+   * Enable fast mode.
+   *
+   * This will disable some rules to speed up linting.
+   */
+  fast?: boolean;
+  /**
+   * Enable Prettier config rules to disable conflicting ESLint rules
+   *
+   * THIS DOES NOT ENABLE PRETTIER FORMATTING. YOU DO THAT, BUT I
+   * RECOMMEND USING PRETTIER TO FORMAT AND NOT THE ESLint PRETTIER
+   * PLUGIN!.
+   */
+  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: Config[]) => Config[] | Awaitable<Config[]>;
+  /**
+   * Enable gitignore support.
+   *
+   * Passing an object to configure the options.
+   * @see https://github.com/antfu/eslint-config-flat-gitignore
+   * @default true
+   */
+  gitignore?: boolean | FlatGitignoreOptions;
+  /**
+   * Enable sorting of package.json files.
+   * @default true
+   */
+  sortPackageJson?: boolean;
+  /**
+   * Enable sorting of tsconfig.json files.
+   * @default true
+   */
+  sortTsconfig?: boolean | OptionsSortTsconfig;
+  /**
+   * Enable sorting of geojson files.
+   * @default false
+   */
+  sortGeojson?: boolean;
+  /**
+   * Enable import/export sorting via perfectionist.
+   * @default false
+   */
+  sortImports?: boolean;
+  /**
+   * The prefix for the name of the config item
+   * @default "@typescript-eslint"
+   */
+  tsPrefix?: string;
+  /**
+   * Glob patterns for ADDITIONAL tsconfig files to lint (aka sort)
+   *
+   * Has nothing to do with `@typescript-eslint/parser` or `typescript-eslint/eslint-plugin`
+   * @default ['tsconfig.json', 'tsconfig.*.json']
+   */
+  extendTsconfigLintGlobs?: string[];
+  /**
+   * Forcibly disable type aware rules
+   */
+  typeAware?: boolean;
+  /**
+   * Enable JSX related rules.
+   *
+   * Currently only stylistic rules are included.
+   * @default true
+   */
+  jsx?: boolean;
+  /**
+   * Control to disable some rules in editors.
+   * @default auto-detect based on the process.env
+   */
+  isInEditor?: boolean;
+};
+//#endregion
+//#region src/_generated/fixable-rules-map.d.ts
+declare const FIXABLE_RULES_MAP: Record<string, RuleName[]>;
+//#endregion
+export { OptionsConfig as a, RuleName as c, TypescriptPreset as d, EslintConfigFn as i, RulesRecord as l, Awaitable as n, ReactHooksPreset as o, Config as r, ReactPreset as s, FIXABLE_RULES_MAP as t, TypedFlatConfigItemWithId as u };