@shayanthenerd/eslint-config/dist/types/options/tailwind.d.mts

A modern, flexible ESLint configuration for enforcing best practices and maintaining a consistent coding style

import { PluginRules, RuleOptions } from "../eslintRules.mjs";
import { ConfigWithOverrides } from "../index.mjs";
//#region src/types/options/tailwind.d.ts
type ConfigRules = PluginRules<'better-tailwindcss'>;
interface BaseTailwindOptions extends ConfigWithOverrides<ConfigRules> {
  /**
   * Path to the _tailwind.config.js_ file, relative to the current working directory (**v3**).
   *
   * @see [better-tailwindcss: `tailwindConfig` option](https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/settings/settings.md#tailwindconfig)
   */
  config?: string;
  /**
   * Current working directory used to resolve TailwindCSS and related config files in monorepos.
   *
   * Resolved relative to the ESLint process's working directory. If not specified, defaults to the ESLint process's working directory.
   *
   * @default undefined
   *
   * @see [better-tailwindcss: `cwd` option](https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/settings/settings.md#cwd)
   */
  cwd?: string;
  /**
   * Path to the CSS-based Tailwind config file, relative to the current working directory (**only v4**).
   *
   * @see [better-tailwindcss: `entryPoint` option](https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/settings/settings.md#entrypoint)
   */
  entryPoint?: string;
  /**
   * Regex patterns of unregistered class names that should be ignored.
   *
   * [Component classes](https://tailwindcss.com/docs/adding-custom-styles#adding-component-classes) are detected automatically and don't need to be ignored.
   *
   * @default []
   *
   * @see [better-tailwindcss/no-unregistered-classes: `ignore` option](https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/rules/no-unknown-classes.md#ignore)
   */
  ignoredUnknownClasses?: RuleOptions<'better-tailwindcss/no-unknown-classes'>['ignore'];
  /**
   * Enforce breaking Tailwind classes into multiple lines if they exceed the line length defined by `stylistic.maxLineLength`.
   *
   * @default true
   *
   * @see [better-tailwindcss/enforce-consistent-line-wrapping](https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/rules/enforce-consistent-line-wrapping.md)
   */
  multilineSort?: boolean;
}
interface EntryPointRequired {
  entryPoint: string;
}
interface ConfigRequired {
  config: string;
}
type TailwindOptions = BaseTailwindOptions & (ConfigRequired | EntryPointRequired);
//#endregion
export type { TailwindOptions };