@storm-software/eslint 0.170.157 → 0.170.159

package/dist/{typegen.d.mts → index.d.cts}

@@ -1,4 +1,9 @@
 import { Linter } from "eslint";
+import { Options } from "@storm-software/eslint-plugin-banner/rules/banner";
+import { StylisticCustomizeOptions } from "@stylistic/eslint-plugin";
+import { ParserOptions } from "@typescript-eslint/parser";
+import { FlatGitignoreOptions } from "eslint-config-flat-gitignore";
+import { FlatConfigComposer } from "eslint-flat-config-utils";
 //#region src/typegen.d.ts
 interface RuleOptions {
   /**
@@ -16914,4 +16919,1025 @@ type Yoda = [] | [("always" | "never")] | [("always" | "never"), {
 // Names of all the configs
 type ConfigNames = "storm/banner" | "storm/bun/setup" | "bun/recommended/package-json" | "bun/recommended/package-json" | "storm/cspell/rules" | "storm/astro/setup" | "storm/astro/rules" | "storm/formatter/setup" | "storm/imports/rules" | "storm/graphql/setup" | "storm/graphql/rules" | "storm/graphql/relay" | "storm/javascript/setup" | "storm/javascript/rules" | "storm/jsx/rules" | "storm/jsdoc/rules" | "storm/jsonc/setup" | "storm/jsonc/rules" | "storm/markdown/setup" | "storm/markdown/rules" | "mdx/flat" | "storm/node/rules" | "storm/nx/setup" | "storm/nx/schema" | "storm/nx/dependency-check" | "storm/nx/module-boundaries" | "storm/next/rules" | "storm/prettier" | "storm/perfectionist/rules" | "storm/pnpm/setup" | "storm/pnpm/package-json" | "storm/pnpm/pnpm-workspace-yaml" | "storm/react/setup" | "storm/react/rules" | "storm/react-native/rules" | "storm/sort/package-json" | "storm/stylistic/rules" | "storm/secrets/rules" | "storm/storybook/setup" | "storm/storybook/rules" | "storm/storybook/main" | "storm/test/setup" | "storm/test/rules" | "storm/tsdoc/rules" | "storm/toml/setup" | "storm/toml/rules" | "storm/typescript/setup" | "storm/typescript/parser" | "storm/typescript/type-aware-parser" | "storm/typescript/rules" | "storm/typescript/rules-type-aware" | "storm/regexp/rules" | "storm/unicorn/rules" | "storm/unocss" | "storm/yaml/setup" | "storm/yaml/rules" | "storm/zod/rules";
 //#endregion
-export { ConfigNames, RuleOptions };
+//#region src/vendor/prettier-types.d.ts
+/**
+ * Vendor types from Prettier so we don't rely on the dependency.
+ */
+type VendoredPrettierOptions = Partial<VendoredPrettierOptionsRequired>;
+interface VendoredPrettierOptionsRequired {
+  /**
+   * Specify the line length that the printer will wrap on.
+   * @default 120
+   */
+  printWidth: number;
+  /**
+   * Specify the number of spaces per indentation-level.
+   */
+  tabWidth: number;
+  /**
+   * Indent lines with tabs instead of spaces
+   */
+  useTabs?: boolean;
+  /**
+   * Print semicolons at the ends of statements.
+   */
+  semi: boolean;
+  /**
+   * Use single quotes instead of double quotes.
+   */
+  singleQuote: boolean;
+  /**
+   * Use single quotes in JSX.
+   */
+  jsxSingleQuote: boolean;
+  /**
+   * Print trailing commas wherever possible.
+   */
+  trailingComma: "none" | "es5" | "all";
+  /**
+   * Print spaces between brackets in object literals.
+   */
+  bracketSpacing: boolean;
+  /**
+   * Put the `>` of a multi-line HTML (HTML, XML, JSX, Vue, 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;
+  /**
+   * 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;
+  /**
+   * Format only a segment of a file.
+   */
+  rangeStart: number;
+  /**
+   * Format only a segment of a file.
+   * @default Number.POSITIVE_INFINITY
+   */
+  rangeEnd: 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";
+  /**
+   * Include parentheses around a sole arrow function parameter.
+   * @default "always"
+   */
+  arrowParens: "avoid" | "always";
+  /**
+   * Provide ability to support new languages to prettier.
+   */
+  plugins: Array<string | any>;
+  /**
+   * How to handle whitespaces in HTML.
+   * @default "css"
+   */
+  htmlWhitespaceSensitivity: "css" | "strict" | "ignore";
+  /**
+   * Which end of line characters to apply.
+   * @default "lf"
+   */
+  endOfLine: "auto" | "lf" | "crlf" | "cr";
+  /**
+   * Change when properties in objects are quoted.
+   * @default "as-needed"
+   */
+  quoteProps: "as-needed" | "consistent" | "preserve";
+  /**
+   * Whether or not to indent the code inside <script> and <style> tags in Vue files.
+   * @default false
+   */
+  vueIndentScriptAndStyle: boolean;
+  /**
+   * Enforce single attribute per line in HTML, XML, Vue and JSX.
+   * @default false
+   */
+  singleAttributePerLine: boolean;
+  /**
+   * How to handle whitespaces in XML.
+   * @default "preserve"
+   */
+  xmlQuoteAttributes: "single" | "double" | "preserve";
+  /**
+   * Whether to put a space inside the brackets of self-closing XML elements.
+   * @default true
+   */
+  xmlSelfClosingSpace: boolean;
+  /**
+   * Whether to sort attributes by key in XML elements.
+   * @default false
+   */
+  xmlSortAttributesByKey: boolean;
+  /**
+   * How to handle whitespaces in XML.
+   * @default "ignore"
+   */
+  xmlWhitespaceSensitivity: "ignore" | "strict" | "preserve";
+}
+//#endregion
+//#region src/types.d.ts
+type Awaitable<T> = T | Promise<T>;
+/**
+ * Matches `@nx/enforce-module-boundaries` dependency constraint options.
+ *
+ * @see https://nx.dev/nx-api/eslint-plugin/documents/enforce-module-boundaries#dependency-constraints
+ */
+type DepConstraint = {
+  sourceTag: string;
+  onlyDependOnLibsWithTags?: string[];
+  notDependOnLibsWithTags?: string[];
+  allowedExternalImports?: string[];
+  bannedExternalImports?: string[];
+} | {
+  allSourceTags: string[];
+  onlyDependOnLibsWithTags?: string[];
+  notDependOnLibsWithTags?: string[];
+  allowedExternalImports?: string[];
+  bannedExternalImports?: string[];
+};
+type Rules = RuleOptions;
+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>;
+};
+interface OptionsFiles {
+  /**
+   * Override the `files` option to provide custom globs.
+   */
+  files?: 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;
+  /**
+   * Enable formatting support for HTML.
+   *
+   * Currently only support Prettier.
+   */
+  html?: "prettier" | boolean;
+  /**
+   * Enable formatting support for XML.
+   *
+   * Currently only support Prettier.
+   */
+  xml?: "prettier" | boolean;
+  /**
+   * Enable formatting support for SVG.
+   *
+   * Currently only support Prettier.
+   */
+  svg?: "prettier" | boolean;
+  /**
+   * Enable formatting support for Markdown.
+   *
+   * Support both Prettier and dprint.
+   *
+   * When set to `true`, it will use Prettier.
+   */
+  markdown?: "prettier" | "dprint" | boolean;
+  /**
+   * Enable formatting support for GraphQL.
+   */
+  graphql?: "prettier" | boolean;
+  /**
+   * Custom options for Prettier.
+   *
+   * By default it's controlled by our own config.
+   */
+  prettierOptions?: VendoredPrettierOptions;
+  /**
+   * Custom options for dprint.
+   *
+   * By default it's controlled by our own config.
+   */
+  dprintOptions?: boolean;
+  /**
+   * Enable formatting support for Astro.
+   *
+   * Currently only support Prettier.
+   */
+  astro?: "prettier" | boolean;
+}
+interface OptionsComponentExts {
+  /**
+   * Additional extensions for components.
+   *
+   * @example ['vue']
+   * @defaultValue []
+   */
+  componentExts?: string[];
+}
+interface OptionsUnicorn {
+  /**
+   * Include all rules recommended by `eslint-plugin-unicorn`, instead of only ones picked by Anthony.
+   *
+   * @defaultValue false
+   */
+  allRecommended?: boolean;
+}
+interface OptionsTSDoc extends OptionsOverrides {
+  /**
+   * The TSDoc ESLint rule severity.
+   *
+   * @defaultValue "error"
+   */
+  severity?: "error" | "warn" | "off";
+  /**
+   * The type of Storm Software TSDoc configuration to use.
+   *
+   * @defaultValue "recommended"
+   */
+  type?: "base" | "typedoc" | "api-extractor" | "core" | "callouts" | "recommended";
+  /**
+   * The path to a TSDoc config file.
+   */
+  configFile?: string;
+}
+interface OptionsJSDoc extends OptionsOverrides {
+  /**
+   * The JSDoc ESLint rule severity.
+   *
+   * @defaultValue "error"
+   */
+  severity?: "error" | "warn" | "off";
+  /**
+   * Enable stylistic rules for JSDoc.
+   */
+  stylistic?: boolean;
+}
+interface OptionsTypeScriptParserOptions {
+  /**
+   * When this options is provided as false, type aware rules will be **disabled**.
+   *
+   * @see https://typescript-eslint.io/linting/typed-linting/
+   */
+  tsconfigPath: false;
+  /**
+   * Additional parser options for TypeScript.
+   */
+  parserOptions?: Partial<ParserOptions>;
+  /**
+   * Glob patterns for files that should be type aware.
+   * @defaultValue ['**\/*.{ts,tsx}']
+   */
+  filesTypeAware?: string[];
+  /**
+   * Glob patterns for files that should not be type aware.
+   * @defaultValue ['**\/*.md\/**', '**\/*.astro/*.ts']
+   */
+  ignoresTypeAware?: string[];
+}
+interface OptionsTypeScriptWithTypes {
+  /**
+   * When this options is provided (or if `tsconfigPath` is found with {@link @storm-software/eslint/utils/tsconfig#getTsConfigPath | the getTsConfigPath function}), type aware rules will be enabled.
+   *
+   * @see https://typescript-eslint.io/linting/typed-linting/
+   */
+  tsconfigPath?: string;
+  /**
+   * Override type aware rules.
+   */
+  overridesTypeAware?: TypedFlatConfigItem["rules"];
+  /**
+   * A linting style for importing types. This is applied to the "ts/consistent-type-imports" rule.
+   *
+   * - `always`: always import types
+   * - `never`: never import types
+   * - `optional`: warn to import as type but allow any import
+   * - `off`: Do not check import types
+   *
+   * @remarks
+   * When set to `true`, it will use the default value of `always`. When set to `false`, it will use the default value of `never`.
+   *
+   * @defaultValue "always"
+   */
+  typeImports?: "always" | "never" | "optional" | "off" | boolean;
+}
+interface OptionsHasTypeScript {
+  typescript?: boolean;
+}
+interface OptionsStylistic {
+  stylistic?: boolean | StylisticConfig;
+}
+type StylisticConfig = Pick<StylisticCustomizeOptions, "indent" | "quotes" | "jsx" | "semi"> & {
+  lineEndings?: "unix" | "windows";
+};
+interface OptionsOverrides {
+  overrides?: TypedFlatConfigItem["rules"];
+}
+interface OptionsProjectType {
+  /**
+   * Type of the project. `lib` will enable more strict rules for libraries.
+   *
+   * @defaultValue 'app'
+   */
+  type?: "app" | "lib";
+}
+interface OptionsRegExp {
+  /**
+   * Override rulelevels
+   */
+  level?: "error" | "warn";
+}
+interface OptionsIsInEditor {
+  isInEditor?: boolean;
+}
+interface OptionsUnoCSS extends OptionsOverrides {
+  /**
+   * Enable attributify support.
+   * @defaultValue true
+   */
+  attributify?: boolean;
+  /**
+   * Enable strict mode by throwing errors about blocklisted classes.
+   * @defaultValue false
+   */
+  strict?: boolean;
+}
+interface OptionsNext extends OptionsOverrides {
+  /**
+   * Enable [core-web-vitals](https://nextjs.org/docs/app/api-reference/config/eslint#with-core-web-vitals) support.
+   *
+   * @see https://nextjs.org/docs/app/api-reference/config/eslint#with-core-web-vitals
+   *
+   * @defaultValue true
+   */
+  coreWebVitals?: boolean;
+  /**
+   * Specify the root directory of the Next.js project for scenarios where Next.js isn't installed in your root directory (such as a monorepo).
+   *
+   * @see https://nextjs.org/docs/app/api-reference/config/eslint#specifying-a-root-directory-within-a-monorepo
+   */
+  rootDir?: string;
+}
+interface OptionsGraphQL extends OptionsOverrides {
+  /**
+   * Enable schema type GraphQL ESLint rules
+   *
+   * @see https://the-guild.dev/graphql/eslint/rules
+   *
+   * @defaultValue true
+   */
+  schema?: boolean;
+  /**
+   * Enable operations type GraphQL ESLint rules
+   *
+   * @see https://the-guild.dev/graphql/eslint/rules
+   *
+   * @defaultValue true
+   */
+  operations?: boolean;
+  /**
+   * Enable [Relay](https://relay.dev/) support.
+   *
+   * @see https://github.com/relayjs/eslint-plugin-relay
+   *
+   * @defaultValue true
+   */
+  relay?: boolean;
+}
+interface OptionsStorybook extends OptionsOverrides {
+  /**
+   * A option to control the strictness of the Component Story Format (CSF) ESLint rules
+   *
+   * @see https://storybook.js.org/docs/api/csf
+   *
+   * @defaultValue "loose"
+   */
+  csf?: "none" | "loose" | "strict";
+}
+interface OptionsReact extends OptionsOverrides {
+  /**
+   * Use a strict mode for React rules, which will enable more strict rules that may cause more false positives but can catch more potential issues.
+   *
+   * @defaultValue false
+   */
+  strict?: boolean;
+}
+interface OptionsNxDependencyChecks extends OptionsOverrides {
+  /**
+   * List of build target names
+   *
+   * @defaultValue ['build-base', 'build']
+   */
+  buildTargets: string[];
+  /**
+   * Disable to skip checking for missing dependencies
+   *
+   * @defaultValue true
+   */
+  checkMissingDependencies: boolean;
+  /**
+   * Disable to skip checking for unused dependencies
+   *
+   * @defaultValue true
+   */
+  checkObsoleteDependencies: boolean;
+  /**
+   * Disable to skip checking if version specifier matches installed version
+   *
+   * @defaultValue true
+   */
+  checkVersionMismatches: boolean;
+  /**
+   * List of dependencies to ignore for checks
+   *
+   * @defaultValue []
+   */
+  ignoredDependencies: string[];
+  /**
+   * List of files to ignore when collecting dependencies. The default value will be set based on the selected executor during the generation.
+   *
+   * @defaultValue []
+   */
+  ignoredFiles: string[];
+  /**
+   * Enable to collect dependencies of children projects
+   *
+   * @defaultValue false
+   */
+  includeTransitiveDependencies: boolean;
+  /**
+   * Set workspace dependencies as relative file:// paths. Useful for monorepos that link via file:// in package.json files.
+   *
+   * @defaultValue false
+   */
+  useLocalPathsForWorkspaceDependencies: boolean;
+}
+interface OptionsNxEnforceModuleBoundaries extends OptionsOverrides {
+  /**
+   * List of imports that should be allowed without any checks
+   *
+   * @defaultValue []
+   */
+  allow: string[];
+  /**
+   * List of build target names
+   *
+   * @defaultValue ['build-base', 'build']
+   */
+  buildTargets: string[];
+  /**
+   * List of dependency constraints between projects
+   *
+   * @defaultValue true
+   */
+  depConstraints: DepConstraint[];
+  /**
+   * Enable to restrict the buildable libs from importing non-buildable libraries
+   *
+   * @defaultValue true
+   */
+  enforceBuildableLibDependency: boolean;
+  /**
+   * Disable check for self circular dependency when project imports from itself via alias path
+   *
+   * @defaultValue false
+   */
+  allowCircularSelfDependency: boolean;
+  /**
+   * List of project pairs that should be skipped from Circular dependencies checks, including the self-circular dependency check. E.g. ['feature-project-a', 'myapp']. Project name can be replaced by catch all * for more generic matches.
+   *
+   * @defaultValue []
+   */
+  ignoredCircularDependencies: Array<[string, string]>;
+  /**
+   * List of imports that should be skipped for Imports of lazy-loaded libraries forbidden checks. E.g. ['@myorg/lazy-project/component/*', '@myorg/other-project']
+   *
+   * @defaultValue []
+   */
+  checkDynamicDependenciesExceptions: string[];
+  /**
+   * Ban import of dependencies that were not specified in the root or project's package.json
+   *
+   * @defaultValue false
+   */
+  banTransitiveDependencies: boolean;
+  /**
+   * Enable to enforce the check for banned external imports in the nested packages. Check [Dependency constraints](https://nx.dev/nx-api/eslint-plugin/documents/enforce-module-boundaries#dependency-constraints) for more information
+   *
+   * @defaultValue false
+   */
+  checkNestedExternalImports: boolean;
+}
+interface OptionsNx extends OptionsOverrides {
+  /**
+   * The dependencies to not check in the `@nx/dependency-checks` rule
+   */
+  ignoredDependencies?: string[];
+  /**
+   * The files to not check in the `@nx/dependency-checks` rule
+   */
+  ignoredFiles?: string[];
+  /**
+   * Check for obsolete dependencies in the `@nx/dependency-checks` rule
+   */
+  checkObsoleteDependencies?: boolean;
+  /**
+   * Enables us to discover mismatches between dependencies specified in a project's package.json and the dependencies that your project depends on.
+   *
+   * @remarks
+   * If any values are overridden here, the `ignoredDependencies`, `ignoredFiles`, and `checkObsoleteDependencies` options will be ignored.
+   *
+   * @defaultValue false
+   */
+  depsCheck?: OptionsNxDependencyChecks | false;
+  /**
+   * The severity of the `@nx/dependency-checks` rule
+   *
+   * @defaultValue "warn"
+   */
+  depsCheckSeverity?: "off" | "warn" | "error";
+  /**
+   * Enables us to define strict rules for accessing resources between different projects in the repository. Enforcing strict boundaries helps to prevent unplanned cross-dependencies.
+   */
+  moduleBoundaries?: OptionsNxEnforceModuleBoundaries | false;
+}
+interface OptionsPnpm extends OptionsOverrides {
+  /**
+   * A list of dependencies to ignore for the `pnpm/json-enforce-catalog` rule.
+   *
+   * @defaultValue ["typescript"]
+   */
+  ignore?: string[];
+  /**
+   * Should local workspace dependencies be ignored by the `pnpm/json-enforce-catalog` rule.
+   *
+   * @defaultValue true
+   */
+  ignoreWorkspaceDeps?: boolean;
+}
+interface OptionsBun extends OptionsOverrides {
+  /**
+   * A list of dependencies to ignore for the `bun/json-enforce-catalog` rule.
+   *
+   * @defaultValue ["typescript"]
+   */
+  ignore?: string[];
+  /**
+   * Should local workspace dependencies be ignored by the `bun/json-enforce-catalog` rule.
+   *
+   * @defaultValue true
+   */
+  ignoreWorkspaceDeps?: boolean;
+}
+interface OptionsCSpell extends OptionsOverrides {
+  /**
+   * A path to a CSpell configuration file
+   *
+   * @defaultValue "./.vscode/cspell.json"
+   */
+  configFile?: string;
+}
+/**
+ * The ESLint globals property value.
+ */
+type ESLintGlobalsPropValue = boolean | "readonly" | "readable" | "writable" | "writeable";
+type OptionsBanner = OptionsOverrides & Options[0];
+interface OptionsJavascript {
+  /**
+   * An object containing a list of extra global variables to include in the configuration.
+   */
+  globals?: Record<string, ESLintGlobalsPropValue>;
+}
+interface OptionsConfig extends OptionsComponentExts, OptionsJavascript, OptionsProjectType {
+  /**
+   * Options to control the generated file header banner.
+   *
+   * @see https://github.com/storm-software/eslint-plugin-banner
+   */
+  banner?: boolean | OptionsBanner;
+  /**
+   * Enable gitignore support.
+   *
+   * Passing an object to configure the options.
+   *
+   * @see https://github.com/antfu/eslint-config-flat-gitignore
+   *
+   * @defaultValue true
+   */
+  gitignore?: boolean | FlatGitignoreOptions;
+  /**
+   * Disable some opinionated rules to Antfu's preference.
+   *
+   * @defaultValue false
+   */
+  lessOpinionated?: boolean;
+  /**
+   * Core rules. Can't be disabled.
+   */
+  javascript?: OptionsOverrides;
+  /**
+   * Enable cspell rules.
+   *
+   * Requires installing:
+   * - `@cspell/eslint-plugin`
+   *
+   * @defaultValue true
+   */
+  cspell?: boolean | OptionsCSpell;
+  /**
+   * Enable TypeScript support.
+   *
+   * Passing an object to enable TypeScript Language Server support.
+   *
+   * @defaultValue auto-detect based on the dependencies
+   */
+  typescript?: boolean | OptionsTypescript;
+  /**
+   * Enable Nx monorepo support.
+   */
+  nx?: OptionsNx;
+  /**
+   * Enable PNPM related rules.
+   *
+   * Requires installing:
+   * - `@storm-software/eslint-plugin-pnpm`
+   *
+   * @remarks
+   * If the package manager is detected to be Bun, this option will be disabled.
+   *
+   * @see https://github.com/antfu/pnpm-workspace-utils/tree/main/packages/eslint-plugin-pnpm
+   *
+   * @defaultValue true
+   */
+  pnpm?: boolean | OptionsPnpm;
+  /**
+   * Enable Bun related rules.
+   *
+   * Requires installing:
+   * - `@storm-software/eslint-plugin-bun`
+   *
+   * @remarks
+   * If the package manager is detected to be PNPM, this option will be disabled.
+   *
+   * @see https://github.com/oven-sh/bun-plugin-eslint
+   *
+   * @defaultValue false
+   */
+  bun?: boolean | OptionsBun;
+  /**
+   * Enable JSX related rules.
+   *
+   * Currently only stylistic rules are included.
+   *
+   * @defaultValue true
+   */
+  jsx?: boolean;
+  /**
+   * Options for eslint-plugin-unicorn.
+   *
+   * @defaultValue true
+   */
+  unicorn?: boolean | OptionsUnicorn;
+  /**
+   * Options for eslint-plugin-jsdoc.
+   *
+   * @defaultValue false
+   */
+  jsdoc?: boolean | OptionsJSDoc;
+  /**
+   * Options for @storm-software/eslint-plugin-tsdoc.
+   *
+   * @defaultValue true
+   */
+  tsdoc?: boolean | OptionsTSDoc;
+  /**
+   * Enable Zod support.
+   *
+   * @defaultValue false
+   */
+  zod?: boolean | OptionsOverrides;
+  /**
+   * Enable test support.
+   *
+   * @defaultValue true
+   */
+  test?: boolean | OptionsOverrides;
+  /**
+   * Enable JSONC support.
+   *
+   * @defaultValue true
+   */
+  jsonc?: boolean | OptionsOverrides;
+  /**
+   * Enable YAML support.
+   *
+   * @defaultValue true
+   */
+  yaml?: boolean | OptionsOverrides;
+  /**
+   * Enable TOML support.
+   *
+   * @defaultValue true
+   */
+  toml?: boolean | OptionsOverrides;
+  /**
+   * Enable ASTRO support.
+   *
+   * Requires installing:
+   * - `eslint-plugin-astro`
+   *
+   * Requires installing for formatting .astro:
+   * - `prettier-plugin-astro`
+   *
+   * @defaultValue false
+   */
+  astro?: boolean | OptionsOverrides;
+  /**
+   * Enable linting for **code snippets** in Markdown.
+   *
+   * For formatting Markdown content, enable also `formatters.markdown`.
+   *
+   * @defaultValue false
+   */
+  markdown?: boolean | OptionsOverrides;
+  /**
+   * Enable linting for mdx files.
+   *
+   * @defaultValue false
+   */
+  mdx?: boolean | OptionsOverrides;
+  /**
+   * Enable stylistic rules.
+   *
+   * @see https://eslint.style/
+   *
+   * @defaultValue false
+   */
+  stylistic?: boolean | (StylisticConfig & OptionsOverrides);
+  /**
+   * Enable regexp rules.
+   *
+   * @see https://ota-meshi.github.io/eslint-plugin-regexp/
+   * @defaultValue true
+   */
+  regexp?: boolean | (OptionsRegExp & OptionsOverrides);
+  /**
+   * Enable GraphQL support.
+   *
+   * @defaultValue false
+   */
+  graphql?: boolean | OptionsGraphQL;
+  /**
+   * Enable Storybook support.
+   *
+   * @defaultValue false
+   */
+  storybook?: boolean | OptionsStorybook;
+  /**
+   * Enable react rules.
+   *
+   * Requires installing:
+   * - `@eslint-react/eslint-plugin`
+   * - `eslint-plugin-react-hooks`
+   * - `eslint-plugin-react-refresh`
+   *
+   * @defaultValue false
+   */
+  react?: boolean | OptionsReact;
+  /**
+   * Enable react native rules.
+   *
+   * Requires installing:
+   * - `eslint-plugin-react-native`
+   *
+   * @defaultValue false
+   */
+  "react-native"?: boolean | OptionsOverrides;
+  /**
+   * Enable next rules.
+   *
+   * Requires installing:
+   * - `@next/eslint-plugin-next`
+   *
+   * @defaultValue false
+   */
+  next?: boolean | OptionsNext;
+  /**
+   * Enable unocss rules.
+   *
+   * Requires installing:
+   * - `@unocss/eslint-plugin`
+   *
+   * @defaultValue false
+   */
+  unocss?: boolean | OptionsUnoCSS;
+  /**
+   * Use external formatters to format files.
+   *
+   * Requires installing:
+   * - `eslint-plugin-format`
+   *
+   * When set to `true`, it will enable all formatters.
+   *
+   * @defaultValue false
+   */
+  formatters?: boolean | OptionsFormatters;
+  /**
+   * Control to disable some rules in editors.
+   * @defaultValue auto-detect based on the process.env
+   */
+  isInEditor?: boolean;
+  /**
+   * Automatically rename plugins in the config.
+   *
+   * @defaultValue true
+   */
+  autoRenamePlugins?: boolean;
+}
+type UserConfig = Awaitable<TypedFlatConfigItem | TypedFlatConfigItem[] | FlatConfigComposer<object, string> | Linter.Config[]>;
+type PresetConfig<TOptions> = TOptions & Omit<TypedFlatConfigItem, "files">;
+type PresetResult = FlatConfigComposer<TypedFlatConfigItem, ConfigNames>;
+//#endregion
+//#region src/preset.d.ts
+declare const defaultPluginRenaming: {
+  "@eslint-react": string;
+  "@eslint-react/dom": string;
+  "@eslint-react/hooks-extra": string;
+  "@eslint-react/naming-convention": string;
+  "@stylistic": string;
+  "@typescript-eslint": string;
+  "import-x": string;
+  n: string;
+  vitest: string;
+  yml: string;
+};
+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): Partial<Linter.RulesRecord & RuleOptions>;
+/**
+ * Get the ESLint configuration for a Storm workspace.
+ *
+ * @param options - The preset options.
+ * @param userConfigs - Additional ESLint configurations.
+ */
+declare function preset(options: PresetConfig<OptionsConfig>, ...userConfigs: UserConfig[]): PresetResult;
+declare const getConfig: typeof preset;
+declare const defineConfig: typeof preset;
+//#endregion
+//#region src/configs/astro.d.ts
+declare function astro(options?: OptionsOverrides & OptionsStylistic & OptionsFiles): Promise<TypedFlatConfigItem[]>;
+//#endregion
+//#region src/configs/banner.d.ts
+declare function banner(options?: Partial<OptionsBanner> & OptionsIsInEditor & OptionsOverrides): Promise<TypedFlatConfigItem[]>;
+//#endregion
+//#region src/configs/bun.d.ts
+declare function bun(options?: OptionsPnpm): Promise<TypedFlatConfigItem[]>;
+//#endregion
+//#region src/configs/cspell.d.ts
+/**
+ * Config for CSpell spell checking
+ */
+declare function cspell(options?: OptionsCSpell): Promise<TypedFlatConfigItem[]>;
+//#endregion
+//#region src/configs/disables.d.ts
+declare function disables(): Promise<TypedFlatConfigItem[]>;
+//#endregion
+//#region src/configs/formatters.d.ts
+declare function formatters(options?: OptionsFormatters | true, stylistic?: StylisticConfig): Promise<TypedFlatConfigItem[]>;
+//#endregion
+//#region src/configs/graphql.d.ts
+declare function graphql(options?: OptionsGraphQL): Promise<TypedFlatConfigItem[]>;
+//#endregion
+//#region src/configs/ignores.d.ts
+declare function ignores(userIgnores?: string[]): Promise<TypedFlatConfigItem[]>;
+//#endregion
+//#region src/configs/imports.d.ts
+declare function imports(options?: OptionsStylistic): Promise<TypedFlatConfigItem[]>;
+//#endregion
+//#region src/configs/javascript.d.ts
+declare function javascript(options?: Partial<OptionsJavascript> & OptionsIsInEditor & OptionsOverrides): Promise<TypedFlatConfigItem[]>;
+//#endregion
+//#region src/configs/jsdoc.d.ts
+declare function jsdoc(options?: OptionsJSDoc): Promise<TypedFlatConfigItem[]>;
+//#endregion
+//#region src/configs/jsonc.d.ts
+declare function jsonc(options?: OptionsFiles & OptionsStylistic & OptionsOverrides): Promise<TypedFlatConfigItem[]>;
+//#endregion
+//#region src/configs/jsx.d.ts
+declare function jsx(): Promise<TypedFlatConfigItem[]>;
+//#endregion
+//#region src/configs/markdown.d.ts
+declare function markdown(options?: OptionsFiles & OptionsComponentExts & OptionsOverrides): Promise<TypedFlatConfigItem[]>;
+//#endregion
+//#region src/configs/mdx.d.ts
+declare function mdx(options?: OptionsFiles & OptionsComponentExts & OptionsOverrides): Promise<TypedFlatConfigItem[]>;
+//#endregion
+//#region src/configs/next.d.ts
+/**
+ * Config for Next.js projects.
+ */
+declare function next(options?: OptionsNext): Promise<TypedFlatConfigItem[]>;
+//#endregion
+//#region src/configs/node.d.ts
+declare function node(): Promise<TypedFlatConfigItem[]>;
+//#endregion
+//#region src/configs/nx.d.ts
+/**
+ * Config for Nx monorepos
+ */
+declare function nx(options?: OptionsNx): Promise<TypedFlatConfigItem[]>;
+//#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<TypedFlatConfigItem[]>;
+//#endregion
+//#region src/configs/pnpm.d.ts
+declare function pnpm(options?: OptionsPnpm): Promise<TypedFlatConfigItem[]>;
+//#endregion
+//#region src/configs/prettier.d.ts
+/**
+ * Config for Prettier eslint integration
+ */
+declare function prettier(): Promise<TypedFlatConfigItem[]>;
+//#endregion
+//#region src/configs/react.d.ts
+declare function react(options?: OptionsComponentExts & Omit<OptionsTypeScriptParserOptions, "tsconfigPath"> & OptionsTypeScriptWithTypes & OptionsReact & OptionsFiles): Promise<TypedFlatConfigItem[]>;
+//#endregion
+//#region src/configs/react-native.d.ts
+/**
+ * Config for React Native projects.
+ */
+declare function reactNative(options?: OptionsOverrides): Promise<TypedFlatConfigItem[]>;
+//#endregion
+//#region src/configs/regexp.d.ts
+declare function regexp(options?: OptionsRegExp & OptionsOverrides): Promise<TypedFlatConfigItem[]>;
+//#endregion
+//#region src/configs/secrets.d.ts
+/**
+ * Config for No-Secrets ESLint plugin
+ */
+declare function secrets(options: {
+  json: boolean;
+}): Promise<TypedFlatConfigItem[]>;
+//#endregion
+//#region src/configs/sort.d.ts
+/**
+ * Sort package.json
+ *
+ * Requires `jsonc` config
+ */
+declare function sortPackageJson(): Promise<TypedFlatConfigItem[]>;
+/**
+ * Sort tsconfig.json
+ *
+ * Requires `jsonc` config
+ */
+declare function sortTsconfig(): TypedFlatConfigItem[];
+//#endregion
+//#region src/configs/storybook.d.ts
+declare function storybook(options?: OptionsStorybook): Promise<TypedFlatConfigItem[]>;
+//#endregion
+//#region src/configs/stylistic.d.ts
+declare const StylisticConfigDefaults: StylisticConfig;
+interface StylisticOptions extends StylisticConfig, OptionsOverrides {
+  lessOpinionated?: boolean;
+}
+declare function stylistic(options?: StylisticOptions): Promise<TypedFlatConfigItem[]>;
+//#endregion
+//#region src/configs/test.d.ts
+declare function test(options?: OptionsFiles & OptionsIsInEditor & OptionsOverrides): Promise<TypedFlatConfigItem[]>;
+//#endregion
+//#region src/configs/toml.d.ts
+declare function toml(options?: OptionsOverrides & OptionsStylistic & OptionsFiles): Promise<TypedFlatConfigItem[]>;
+//#endregion
+//#region src/configs/tsdoc.d.ts
+declare function tsdoc(options?: OptionsFiles & OptionsTSDoc): Promise<TypedFlatConfigItem[]>;
+//#endregion
+//#region src/configs/typescript.d.ts
+declare function typescript(options?: OptionsFiles & OptionsComponentExts & OptionsOverrides & OptionsTypeScriptWithTypes & Omit<OptionsTypeScriptParserOptions, "tsconfigPath"> & OptionsProjectType): Promise<TypedFlatConfigItem[]>;
+//#endregion
+//#region src/configs/unicorn.d.ts
+declare function unicorn(options?: OptionsUnicorn): Promise<TypedFlatConfigItem[]>;
+//#endregion
+//#region src/configs/unocss.d.ts
+declare function unocss(options?: OptionsUnoCSS): Promise<TypedFlatConfigItem[]>;
+//#endregion
+//#region src/configs/yaml.d.ts
+declare function yaml(options?: OptionsOverrides & OptionsStylistic & OptionsFiles): Promise<TypedFlatConfigItem[]>;
+//#endregion
+//#region src/configs/zod.d.ts
+/**
+ * Config for Import-Zod ESLint plugin
+ */
+declare function zod(options?: OptionsOverrides): Promise<TypedFlatConfigItem[]>;
+//#endregion
+export { type Awaitable, type ConfigNames, type ESLintGlobalsPropValue, type OptionsBanner, type OptionsBun, type OptionsCSpell, type OptionsComponentExts, type OptionsConfig, type OptionsFiles, type OptionsFormatters, type OptionsGraphQL, type OptionsHasTypeScript, type OptionsIsInEditor, type OptionsJSDoc, type OptionsJavascript, type OptionsNext, type OptionsNx, type OptionsNxDependencyChecks, type OptionsNxEnforceModuleBoundaries, type OptionsOverrides, type OptionsPnpm, type OptionsProjectType, type OptionsReact, type OptionsRegExp, type OptionsStorybook, type OptionsStylistic, type OptionsTSDoc, type OptionsTypeScriptParserOptions, type OptionsTypeScriptWithTypes, type OptionsTypescript, type OptionsUnicorn, type OptionsUnoCSS, type PresetConfig, type PresetResult, ResolvedOptions, type RuleOptions, type Rules, type StylisticConfig, StylisticConfigDefaults, StylisticOptions, type TypedFlatConfigItem, type UserConfig, astro, banner, bun, cspell, defineConfig as default, defineConfig, defaultPluginRenaming, disables, formatters, getConfig, getOverrides, graphql, ignores, imports, javascript, jsdoc, jsonc, jsx, markdown, mdx, next, node, nx, perfectionist, pnpm, preset, prettier, react, reactNative, regexp, resolveSubOptions, secrets, sortPackageJson, sortTsconfig, storybook, stylistic, test, toml, tsdoc, typescript, unicorn, unocss, yaml, zod };