@wongxy/eslint-config 3.0.0 → 4.0.0

package/dist/index.d.ts

@@ -1,680 +0,0 @@
-import { OptionsOverrides, antfu } from "@antfu/eslint-config";
-import { Linter } from "eslint";
-
-//#region src/typegen.d.ts
-interface RuleOptions {
-  /**
-   * Enforce a consistent order for tailwind classes.
-   * @see https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/rules/enforce-consistent-class-order.md
-   */
-  'tw/enforce-consistent-class-order'?: Linter.RuleEntry<TwEnforceConsistentClassOrder>;
-  /**
-   * Enforce consistent important position for classes.
-   * @see https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/rules/enforce-consistent-important-position.md
-   */
-  'tw/enforce-consistent-important-position'?: Linter.RuleEntry<TwEnforceConsistentImportantPosition>;
-  /**
-   * Enforce consistent line wrapping for tailwind classes.
-   * @see https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/rules/multiline.md
-   */
-  'tw/enforce-consistent-line-wrapping'?: Linter.RuleEntry<TwEnforceConsistentLineWrapping>;
-  /**
-   * Enforce consistent syntax for css variables.
-   * @see https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/rules/enforce-consistent-variable-syntax.md
-   */
-  'tw/enforce-consistent-variable-syntax'?: Linter.RuleEntry<TwEnforceConsistentVariableSyntax>;
-  /**
-   * Enforce shorthand class names instead of longhand class names.
-   * @see https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/rules/enforce-shorthand-classes.md
-   */
-  'tw/enforce-shorthand-classes'?: Linter.RuleEntry<TwEnforceShorthandClasses>;
-  /**
-   * Enforce consistent line wrapping for tailwind classes.
-   * @see https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/rules/multiline.md
-   * @deprecated
-   */
-  'tw/multiline'?: Linter.RuleEntry<TwMultiline>;
-  /**
-   * Disallow classes that produce conflicting styles.
-   * @see https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/rules/no-conflicting-classes.md
-   */
-  'tw/no-conflicting-classes'?: Linter.RuleEntry<TwNoConflictingClasses>;
-  /**
-   * Disallow the use of deprecated Tailwind CSS classes.
-   * @see https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/rules/no-deprecated-classes.md
-   */
-  'tw/no-deprecated-classes'?: Linter.RuleEntry<TwNoDeprecatedClasses>;
-  /**
-   * Disallow duplicate class names in tailwind classes.
-   * @see https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/rules/no-duplicate-classes.md
-   */
-  'tw/no-duplicate-classes'?: Linter.RuleEntry<TwNoDuplicateClasses>;
-  /**
-   * Disallow restricted classes.
-   * @see https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/rules/no-restricted-classes.md
-   */
-  'tw/no-restricted-classes'?: Linter.RuleEntry<TwNoRestrictedClasses>;
-  /**
-   * Disallow unnecessary whitespace between Tailwind CSS classes.
-   * @see https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/rules/no-unnecessary-whitespace.md
-   */
-  'tw/no-unnecessary-whitespace'?: Linter.RuleEntry<TwNoUnnecessaryWhitespace>;
-  /**
-   * Disallow any css classes that are not registered in tailwindcss.
-   * @see https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/rules/no-unregistered-classes.md
-   */
-  'tw/no-unregistered-classes'?: Linter.RuleEntry<TwNoUnregisteredClasses>;
-  /**
-   * Enforce a consistent order for tailwind classes.
-   * @see https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/rules/enforce-consistent-class-order.md
-   * @deprecated
-   */
-  'tw/sort-classes'?: Linter.RuleEntry<TwSortClasses>;
-}
-
-/* ======= Declarations ======= */
-// ----- tw/enforce-consistent-class-order -----
-type TwEnforceConsistentClassOrder = [] | [{
-  callees?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-  attributes?: (string | [] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]])[];
-  variables?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-  tags?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-  entryPoint?: string;
-  tailwindConfig?: string;
-  tsconfig?: string;
-  order?: ("asc" | "desc" | "official" | "improved");
-}];
-// ----- tw/enforce-consistent-important-position -----
-type TwEnforceConsistentImportantPosition = [] | [{
-  callees?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-  attributes?: (string | [] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]])[];
-  variables?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-  tags?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-  entryPoint?: string;
-  tailwindConfig?: string;
-  tsconfig?: string;
-  position?: ("legacy" | "recommended");
-}];
-// ----- tw/enforce-consistent-line-wrapping -----
-type TwEnforceConsistentLineWrapping = [] | [{
-  callees?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-  attributes?: (string | [] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]])[];
-  variables?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-  tags?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-  entryPoint?: string;
-  tailwindConfig?: string;
-  tsconfig?: string;
-  classesPerLine?: number;
-  group?: ("emptyLine" | "never" | "newLine");
-  indent?: ("tab" | number);
-  lineBreakStyle?: ("unix" | "windows");
-  preferSingleLine?: boolean;
-  printWidth?: number;
-}];
-// ----- tw/enforce-consistent-variable-syntax -----
-type TwEnforceConsistentVariableSyntax = [] | [{
-  callees?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-  attributes?: (string | [] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]])[];
-  variables?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-  tags?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-  syntax?: ("arbitrary" | "parentheses" | "shorthand" | "variable");
-}];
-// ----- tw/enforce-shorthand-classes -----
-type TwEnforceShorthandClasses = [] | [{
-  callees?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-  attributes?: (string | [] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]])[];
-  variables?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-  tags?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-  entryPoint?: string;
-  tailwindConfig?: string;
-  tsconfig?: string;
-}];
-// ----- tw/multiline -----
-type TwMultiline = [] | [{
-  callees?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-  attributes?: (string | [] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]])[];
-  variables?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-  tags?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-  entryPoint?: string;
-  tailwindConfig?: string;
-  tsconfig?: string;
-  classesPerLine?: number;
-  group?: ("emptyLine" | "never" | "newLine");
-  indent?: ("tab" | number);
-  lineBreakStyle?: ("unix" | "windows");
-  preferSingleLine?: boolean;
-  printWidth?: number;
-}];
-// ----- tw/no-conflicting-classes -----
-type TwNoConflictingClasses = [] | [{
-  callees?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-  attributes?: (string | [] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]])[];
-  variables?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-  tags?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-  entryPoint?: string;
-  tailwindConfig?: string;
-  tsconfig?: string;
-}];
-// ----- tw/no-deprecated-classes -----
-type TwNoDeprecatedClasses = [] | [{
-  callees?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-  attributes?: (string | [] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]])[];
-  variables?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-  tags?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-  entryPoint?: string;
-  tailwindConfig?: string;
-  tsconfig?: string;
-}];
-// ----- tw/no-duplicate-classes -----
-type TwNoDuplicateClasses = [] | [{
-  callees?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-  attributes?: (string | [] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]])[];
-  variables?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-  tags?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-}];
-// ----- tw/no-restricted-classes -----
-type TwNoRestrictedClasses = [] | [{
-  callees?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-  attributes?: (string | [] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]])[];
-  variables?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-  tags?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-  restrict?: ({
-    fix?: string;
-    message?: string;
-    pattern: string;
-  } | string)[];
-}];
-// ----- tw/no-unnecessary-whitespace -----
-type TwNoUnnecessaryWhitespace = [] | [{
-  allowMultiline?: boolean;
-  callees?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-  attributes?: (string | [] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]])[];
-  variables?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-  tags?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-}];
-// ----- tw/no-unregistered-classes -----
-type TwNoUnregisteredClasses = [] | [{
-  callees?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-  attributes?: (string | [] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]])[];
-  variables?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-  tags?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-  entryPoint?: string;
-  tailwindConfig?: string;
-  tsconfig?: string;
-  detectComponentClasses?: boolean;
-  ignore?: string[];
-}];
-// ----- tw/sort-classes -----
-type TwSortClasses = [] | [{
-  callees?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-  attributes?: (string | [] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]])[];
-  variables?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-  tags?: ([] | [string] | [string, string] | [] | [string] | [string, ({
-    match?: "strings";
-  } | {
-    match?: "objectKeys";
-    pathPattern?: string;
-  } | {
-    match?: "objectValues";
-    pathPattern?: string;
-  })[]] | string)[];
-  entryPoint?: string;
-  tailwindConfig?: string;
-  tsconfig?: string;
-  order?: ("asc" | "desc" | "official" | "improved");
-}];
-// Names of all the configs
-//#endregion
-//#region src/types.d.ts
-type Options = Parameters<typeof antfu>[0] & {
-  /**
-   * Enable Tailwind rules.
-   *
-   * @default auto-detect based on the dependencies
-   */
-  tailwindcss?: boolean | OptionsTailwindCSS;
-  /**
-   * Enable React Native support.
-   *
-   * Will enable `react` support automatically.
-   *
-   * @default auto-detect based on the dependencies
-   */
-  reactnative?: boolean;
-  /**
-   * Enable react rules.
-   *
-   * @default auto-detect based on the dependencies
-   */
-  react?: boolean | OptionsOverrides;
-};
-type UserConfig = Parameters<typeof antfu>[1] & {
-  rules?: RuleOptions;
-};
-type OptionsReturn = ReturnType<typeof antfu>;
-type PickKeysByPrefix<T extends object, P extends string> = { [K in keyof T as K extends `${P}${string}` ? K : never]: T[K] };
-type RuleOptionsTailwindCSS = PickKeysByPrefix<RuleOptions, 'tw/'>;
-interface OptionsTailwindCSS {
-  overrides?: Partial<RuleOptionsTailwindCSS>;
-  settings?: {
-    entryPoint?: string;
-    tailwindConfig?: string;
-    attributes?: string[];
-    callees?: string[];
-    variables?: string[];
-    tags?: string[];
-  };
-}
-//#endregion
-//#region src/index.d.ts
-declare function wongxy(options?: Options, ...userConfigs: UserConfig[]): OptionsReturn;
-//#endregion
-export { wongxy as default };