@storm-software/eslint 0.170.156 → 0.170.158

package/dist/types.d.mts

@@ -0,0 +1,735 @@
+import __tsdown_shims_path from 'node:path';
+import __tsdown_shims_url from 'node:url';
+import { ConfigNames, RuleOptions } from "./typegen.mjs";
+import { VendoredPrettierOptions } from "./vendor/prettier-types.mjs";
+import { FlatConfigComposer } from "eslint-flat-config-utils";
+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";
+//#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
+export { Awaitable, ConfigNames, ESLintGlobalsPropValue, OptionsBanner, OptionsBun, OptionsCSpell, OptionsComponentExts, OptionsConfig, OptionsFiles, OptionsFormatters, OptionsGraphQL, OptionsHasTypeScript, OptionsIsInEditor, OptionsJSDoc, OptionsJavascript, OptionsNext, OptionsNx, OptionsNxDependencyChecks, OptionsNxEnforceModuleBoundaries, OptionsOverrides, OptionsPnpm, OptionsProjectType, OptionsReact, OptionsRegExp, OptionsStorybook, OptionsStylistic, OptionsTSDoc, OptionsTypeScriptParserOptions, OptionsTypeScriptWithTypes, OptionsTypescript, OptionsUnicorn, OptionsUnoCSS, PresetConfig, PresetResult, RuleOptions, Rules, StylisticConfig, TypedFlatConfigItem, UserConfig };