// Inspired by https://github.com/vitest-dev/eslint-plugin-vitest/blob/7fb864c28f91a92891c7a4fa025ca9d2a9780d49/src/utils/parse-plugin-settings.ts

import { JSONSchema4 } from "@typescript-eslint/utils/json-schema";
import type { SharedConfigurationSettings } from "@typescript-eslint/utils/ts-eslint";

/**
 * Typing of the shared settings of the `eslint-plugin-tailwindcss`
 */
export type PluginSettings = {
  // attributes which should be parsed
  attributes?: Array<string>; // No support for `Set<string>`
  // Must be an absolute path, not a relative path
  cssConfigPath: string;
  // functions are use for both callees and template literals
  functions?: Array<string>; // No support for `Set<string>`
  // functions in which we check the keys instead of the values (used for `clsx`, etc.)
  parseKeyFunctions?: Array<string>; // No support for `Set<string>`
  // keys to ignore in object expressions
  ignoredKeys?: Array<string>; // No support for `Set<string>`
  // Max size of the Set or Map objects used for caching
  cacheMaxSize?: number;
  // Max age of the cache in milliseconds
  cacheMaxAge?: number;
};

/**
 * The default values for the shared settings.
 */
export const DEFAULT_SETTINGS: PluginSettings = {
  attributes: [
    // Regular HTML + VDirectiveKey
    "class",
    // React
    "className",
    // Angular
    "ngClass",
    // Tailwind CSS directive
    "@apply",
  ],
  cssConfigPath: "src/style.css",
  functions: [
    // @see https://www.npmjs.com/package/classnames
    "classnames",
    "classNames",
    // @see https://www.npmjs.com/package/clsx
    "clsx",
    // @see https://github.com/shadcn-ui/ui
    "cn",
    // @see https://www.npmjs.com/package/@netlify/classnames-template-literals
    "ctl",
    // @see https://www.npmjs.com/package/class-variance-authority
    "cva",
    // @see https://www.npmjs.com/package/tailwind-variants
    "tv",
    // Template Literals or custom function
    "tw",
    // @see https://www.npmjs.com/package/tailwind-merge
    "twMerge",
    // @see https://www.npmjs.com/package/tailwind-join
    // N.B. This package is deprecated
    "twJoin",
  ],
  parseKeyFunctions: [
    // @see https://www.npmjs.com/package/classnames
    "classnames",
    "classNames",
    // @see https://www.npmjs.com/package/clsx
    "clsx",
  ],
  // keys to ignore in object expressions (used by `cva`, `tv`, etc.)
  ignoredKeys: ["defaultVariants", "compoundVariants", "compoundSlots"],
  // Max size of the Set or Map objects used for caching
  cacheMaxSize: 250_000,
  // Max age of the cache in milliseconds
  cacheMaxAge: 10 * 60 * 1000, // 10 minutes
};

/**
 * The JSON schema for the shared settings to be reused in many of the rule's configuration.
 */
export const sharedSettingsSchema: Record<keyof PluginSettings, JSONSchema4> = {
  attributes: {
    description: "List of attribute names to validate classnames",
    type: "array",
    items: { type: "string", minLength: 0 },
    uniqueItems: true,
    default: DEFAULT_SETTINGS.attributes,
  },
  cssConfigPath: {
    description: "Path to the Tailwind CSS configuration file (*.css)",
    type: "string",
    default: DEFAULT_SETTINGS.cssConfigPath,
  },
  functions: {
    description:
      "List of function names to validate classnames, also used for template literals",
    type: "array",
    items: { type: "string", minLength: 0 },
    uniqueItems: true,
    default: DEFAULT_SETTINGS.functions,
  },
  parseKeyFunctions: {
    description:
      "Within the list of functions, which should we check the keys instead of the values (used for `clsx`, etc.)",
    type: "array",
    items: { type: "string", minLength: 0 },
    uniqueItems: true,
    default: DEFAULT_SETTINGS.parseKeyFunctions,
  },
  ignoredKeys: {
    description:
      "List of keys to ignore in object expressions (used by `cva`, `tv`, etc.)",
    type: "array",
    items: { type: "string", minLength: 0 },
    uniqueItems: true,
    default: DEFAULT_SETTINGS.ignoredKeys,
  },
  cacheMaxSize: {
    description: "Max size of the Set or Map objects used for caching",
    type: "number",
    minimum: 10_000,
    default: DEFAULT_SETTINGS.cacheMaxSize,
  },
  cacheMaxAge: {
    description: "Max age of the cache in milliseconds",
    type: "number",
    minimum: 30_000,
    default: DEFAULT_SETTINGS.cacheMaxAge,
  },
};

/**
 * @description Parses the global eslint settings and merge it with the defaults.
 * @param settings The shared settings from the ESLint configuration.
 * @returns The merged plugin settings.
 * @example
 * const settings = parsePluginSettings({
 *   tailwindcss: {
 *     cssConfigPath: "/path/to/tailwind.css",
 *   },
 * });
 */
export function parsePluginSettings(
  settings: SharedConfigurationSettings,
): PluginSettings {
  const tailwindcssSettings = (
    typeof settings.tailwindcss !== "object" || settings.tailwindcss === null
      ? {}
      : settings.tailwindcss
  ) as PluginSettings;
  return {
    ...DEFAULT_SETTINGS,
    ...tailwindcssSettings,
  };
}