@tailwind-ts/eslint-plugin 0.1.0 → 0.3.0

package/lib/index.cjs

@@ -1,370 +0,0 @@
-'use strict';
-
-const utils = require('@typescript-eslint/utils');
-const node_fs = require('node:fs');
-const node_path = require('node:path');
-const node_url = require('node:url');
-const synckit = require('synckit');
-
-var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
-const name = "@tailwind-ts/eslint-plugin";
-const version = "0.1.0";
-const packageJson = {
-	name: name,
-	version: version};
-
-function isStringLiteral(node) {
-  return node.type === "Literal" && typeof node.value === "string";
-}
-function collectFromExpression(node, ignoredKeys, functionNames, literals) {
-  if (!node || node.type === "SpreadElement") {
-    return;
-  }
-  if (isStringLiteral(node)) {
-    literals.push({ value: node.value, node });
-    return;
-  }
-  if (node.type === "TemplateLiteral" && node.expressions.length === 0) {
-    const value = node.quasis.map((quasi) => quasi.value.cooked ?? "").join("");
-    literals.push({ value, node });
-    return;
-  }
-  if (node.type === "LogicalExpression") {
-    collectFromExpression(node.left, ignoredKeys, functionNames, literals);
-    collectFromExpression(node.right, ignoredKeys, functionNames, literals);
-    return;
-  }
-  if (node.type === "ConditionalExpression") {
-    collectFromExpression(node.consequent, ignoredKeys, functionNames, literals);
-    collectFromExpression(node.alternate, ignoredKeys, functionNames, literals);
-    return;
-  }
-  if (node.type === "ArrayExpression") {
-    for (const element of node.elements) {
-      collectFromExpression(element, ignoredKeys, functionNames, literals);
-    }
-    return;
-  }
-  if (node.type === "ObjectExpression") {
-    for (const property of node.properties) {
-      if (property.type === "Property") {
-        if (property.key.type === "Identifier") {
-          if (ignoredKeys.has(property.key.name)) {
-            continue;
-          }
-        }
-        collectFromExpression(
-          property.value,
-          ignoredKeys,
-          functionNames,
-          literals
-        );
-      }
-    }
-    return;
-  }
-  if (node.type === "CallExpression" && node.callee.type === "Identifier") {
-    if (functionNames.has(node.callee.name)) {
-      for (const argument of node.arguments) {
-        collectFromExpression(
-          argument,
-          ignoredKeys,
-          functionNames,
-          literals
-        );
-      }
-    }
-  }
-}
-function extractClassLiteralsFromJsxAttribute(attribute, options) {
-  const literals = [];
-  const ignoredKeys = new Set(options.ignoredKeys);
-  const functionNames = new Set(options.functions);
-  if (!attribute.value) {
-    return literals;
-  }
-  if (attribute.value.type === "Literal" && typeof attribute.value.value === "string") {
-    literals.push({ value: attribute.value.value, node: attribute.value });
-    return literals;
-  }
-  if (attribute.value.type === "JSXExpressionContainer") {
-    collectFromExpression(
-      attribute.value.expression,
-      ignoredKeys,
-      functionNames,
-      literals
-    );
-  }
-  return literals;
-}
-function extractClassLiteralsFromCallExpression(callExpression, options) {
-  if (callExpression.callee.type !== "Identifier") {
-    return [];
-  }
-  const functionNames = new Set(options.functions);
-  if (!functionNames.has(callExpression.callee.name)) {
-    return [];
-  }
-  const literals = [];
-  const ignoredKeys = new Set(options.ignoredKeys);
-  for (const argument of callExpression.arguments) {
-    collectFromExpression(
-      argument,
-      ignoredKeys,
-      functionNames,
-      literals
-    );
-  }
-  return literals;
-}
-
-const DEFAULT_ATTRIBUTES = ["class", "className"];
-const DEFAULT_FUNCTIONS = [
-  "cn",
-  "clsx",
-  "cva",
-  "twMerge",
-  "twJoin"
-];
-const DEFAULT_IGNORED_KEYS = [
-  "defaultVariants",
-  "compoundVariants",
-  "compoundSlots"
-];
-function toRegExp(pattern) {
-  return new RegExp(pattern);
-}
-function parsePluginSettings(settings) {
-  if (!settings?.cssConfigPath) {
-    throw new Error(
-      "eslint-plugin-tailwind-ts: settings.tailwindTs.cssConfigPath is required (path to your Tailwind v4 CSS entry file)."
-    );
-  }
-  const whitelist = (settings.whitelist ?? []).map(toRegExp);
-  return {
-    cssConfigPath: settings.cssConfigPath,
-    attributes: settings.attributes ?? [...DEFAULT_ATTRIBUTES],
-    functions: settings.functions ?? [...DEFAULT_FUNCTIONS],
-    whitelist,
-    ignoredKeys: settings.ignoredKeys ?? [...DEFAULT_IGNORED_KEYS]
-  };
-}
-function isWhitelisted(className, whitelist) {
-  return whitelist.some((pattern) => pattern.test(className));
-}
-function splitClassTokens(classString) {
-  return classString.trim().split(/\s+/).filter(Boolean);
-}
-
-const CACHE_TTL_MS = 10 * 60 * 1e3;
-const resultCache = /* @__PURE__ */ new Map();
-const compilerMtimeCache = /* @__PURE__ */ new Map();
-function resolveWorkerPath() {
-  const dir = node_path.dirname(node_url.fileURLToPath((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('index.cjs', document.baseURI).href))));
-  const candidates = [
-    node_path.join(dir, "../worker/validate.mjs"),
-    node_path.join(dir, "../../worker/validate.mjs")
-  ];
-  for (const candidate of candidates) {
-    if (node_fs.existsSync(candidate)) {
-      return candidate;
-    }
-  }
-  throw new Error("eslint-plugin-tailwind-ts: validation worker not found");
-}
-const runValidate = synckit.createSyncFn(resolveWorkerPath());
-function resolveCssConfigPath(cssConfigPath, cwd) {
-  return node_path.isAbsolute(cssConfigPath) ? cssConfigPath : node_path.resolve(cwd, cssConfigPath);
-}
-function getCssMtime(cssConfigPath) {
-  return node_fs.statSync(cssConfigPath).mtimeMs;
-}
-function isCompilerCacheValid(cssConfigPath) {
-  const cached = compilerMtimeCache.get(cssConfigPath);
-  if (!cached) {
-    return false;
-  }
-  try {
-    return cached.mtimeMs === getCssMtime(cssConfigPath);
-  } catch {
-    return false;
-  }
-}
-function touchCompilerCache(cssConfigPath) {
-  compilerMtimeCache.set(cssConfigPath, {
-    mtimeMs: getCssMtime(cssConfigPath)
-  });
-}
-function invalidateResultCacheForConfig(cssConfigPath) {
-  for (const key of resultCache.keys()) {
-    if (key.startsWith(`${cssConfigPath}::`)) {
-      resultCache.delete(key);
-    }
-  }
-}
-function validateTailwindClass(request) {
-  const resolvedCssPath = resolveCssConfigPath(
-    request.cssConfigPath,
-    request.cwd
-  );
-  if (!isCompilerCacheValid(resolvedCssPath)) {
-    invalidateResultCacheForConfig(resolvedCssPath);
-    touchCompilerCache(resolvedCssPath);
-  }
-  const cacheKey = `${resolvedCssPath}::${request.className}`;
-  const cached = resultCache.get(cacheKey);
-  if (cached && cached.expiresAt > Date.now()) {
-    return { valid: cached.valid };
-  }
-  const response = runValidate({
-    cssConfigPath: resolvedCssPath,
-    className: request.className,
-    cwd: request.cwd
-  });
-  resultCache.set(cacheKey, {
-    valid: response.valid,
-    expiresAt: Date.now() + CACHE_TTL_MS
-  });
-  return response;
-}
-
-const RULE_NAME = "no-invalid-classname";
-const noInvalidClassname = utils.ESLintUtils.RuleCreator.withoutDocs({
-  meta: {
-    type: "problem",
-    docs: {
-      description: "Disallow invalid or typo Tailwind CSS class names in JSX and utility functions."
-    },
-    schema: [
-      {
-        type: "object",
-        additionalProperties: false,
-        properties: {
-          whitelist: {
-            type: "array",
-            items: { type: "string" }
-          }
-        }
-      }
-    ],
-    messages: {
-      invalidClass: 'Class "{{ className }}" is not a valid Tailwind CSS class.'
-    }
-  },
-  defaultOptions: [{}],
-  create(context) {
-    const pluginSettings = context.settings.tailwindTs;
-    let resolvedSettings;
-    try {
-      resolvedSettings = parsePluginSettings(pluginSettings);
-    } catch (error) {
-      const message = error instanceof Error ? error.message : "Invalid plugin settings.";
-      context.report({
-        loc: { line: 1, column: 0 },
-        message
-      });
-      return {};
-    }
-    const ruleWhitelist = (context.options[0]?.whitelist ?? []).map(
-      (pattern) => new RegExp(pattern)
-    );
-    const whitelist = [...resolvedSettings.whitelist, ...ruleWhitelist];
-    const attributeNames = new Set(resolvedSettings.attributes);
-    const cwd = context.cwd ?? process.cwd();
-    function reportInvalidClasses(literals) {
-      for (const literal of literals) {
-        for (const className of splitClassTokens(literal.value)) {
-          if (isWhitelisted(className, whitelist)) {
-            continue;
-          }
-          const result = validateTailwindClass({
-            cssConfigPath: resolvedSettings.cssConfigPath,
-            className,
-            cwd
-          });
-          if (!result.valid) {
-            context.report({
-              node: literal.node,
-              messageId: "invalidClass",
-              data: { className }
-            });
-          }
-        }
-      }
-    }
-    return {
-      JSXAttribute(node) {
-        if (node.name.type !== "JSXIdentifier" || !attributeNames.has(node.name.name)) {
-          return;
-        }
-        reportInvalidClasses(
-          extractClassLiteralsFromJsxAttribute(node, {
-            functions: resolvedSettings.functions,
-            ignoredKeys: resolvedSettings.ignoredKeys
-          })
-        );
-      },
-      CallExpression(node) {
-        reportInvalidClasses(
-          extractClassLiteralsFromCallExpression(node, {
-            functions: resolvedSettings.functions,
-            ignoredKeys: resolvedSettings.ignoredKeys
-          })
-        );
-      }
-    };
-  }
-});
-
-const createConfig = (rules) => {
-  const result = {};
-  for (const [ruleName, value] of Object.entries(rules)) {
-    result[`tailwind-ts/${ruleName}`] = value;
-  }
-  return result;
-};
-const plugin = {
-  meta: {
-    name: packageJson.name,
-    version: packageJson.version
-  },
-  configs: {
-    get recommended() {
-      return sharedConfigs.recommended;
-    }
-  },
-  rules: {
-    [RULE_NAME]: noInvalidClassname
-  }
-};
-const recommendedRules = {
-  [RULE_NAME]: "error"
-};
-const configBase = {
-  name: "tailwind-ts/base",
-  plugins: {
-    "tailwind-ts": plugin
-  },
-  settings: {
-    tailwindTs: {}
-  },
-  files: ["**/*.ts", "**/*.tsx", "**/*.js", "**/*.jsx"],
-  languageOptions: {
-    parserOptions: {
-      ecmaVersion: "latest",
-      sourceType: "module",
-      ecmaFeatures: {
-        jsx: true
-      }
-    }
-  }
-};
-const sharedConfigs = {
-  recommended: {
-    ...configBase,
-    name: "tailwind-ts/recommended",
-    rules: createConfig(recommendedRules)
-  }
-};
-
-module.exports = plugin;

package/lib/index.d.cts

@@ -1,33 +0,0 @@
-import * as _typescript_eslint_utils_ts_eslint from '@typescript-eslint/utils/ts-eslint';
-import { FlatConfig } from '@typescript-eslint/utils/ts-eslint';
-
-interface PluginSettings {
-    /** Required. Path to Tailwind v4 CSS entry, e.g. "./src/styles/tailwind.css" */
-    cssConfigPath: string;
-    /** Attributes/props that may contain Tailwind CSS classes */
-    attributes?: string[];
-    /** Functions whose arguments will be parsed for class strings */
-    functions?: string[];
-    /** Whitelist regex patterns for non-Tailwind classes */
-    whitelist?: string[];
-    /** Keys to ignore in object expressions */
-    ignoredKeys?: string[];
-}
-
-declare const plugin: {
-    meta: {
-        name: string;
-        version: string;
-    };
-    configs: {
-        readonly recommended: FlatConfig.Config | FlatConfig.ConfigArray;
-    };
-    rules: {
-        "no-invalid-classname": _typescript_eslint_utils_ts_eslint.RuleModule<"invalidClass", [({
-            whitelist?: string[];
-        } | undefined)?], unknown, _typescript_eslint_utils_ts_eslint.RuleListener>;
-    };
-};
-
-export = plugin;
-export type { PluginSettings };

package/lib/index.d.mts

@@ -1,33 +0,0 @@
-import * as _typescript_eslint_utils_ts_eslint from '@typescript-eslint/utils/ts-eslint';
-import { FlatConfig } from '@typescript-eslint/utils/ts-eslint';
-
-interface PluginSettings {
-    /** Required. Path to Tailwind v4 CSS entry, e.g. "./src/styles/tailwind.css" */
-    cssConfigPath: string;
-    /** Attributes/props that may contain Tailwind CSS classes */
-    attributes?: string[];
-    /** Functions whose arguments will be parsed for class strings */
-    functions?: string[];
-    /** Whitelist regex patterns for non-Tailwind classes */
-    whitelist?: string[];
-    /** Keys to ignore in object expressions */
-    ignoredKeys?: string[];
-}
-
-declare const plugin: {
-    meta: {
-        name: string;
-        version: string;
-    };
-    configs: {
-        readonly recommended: FlatConfig.Config | FlatConfig.ConfigArray;
-    };
-    rules: {
-        "no-invalid-classname": _typescript_eslint_utils_ts_eslint.RuleModule<"invalidClass", [({
-            whitelist?: string[];
-        } | undefined)?], unknown, _typescript_eslint_utils_ts_eslint.RuleListener>;
-    };
-};
-
-export { plugin as default };
-export type { PluginSettings };

package/lib/index.d.ts

@@ -1,33 +0,0 @@
-import * as _typescript_eslint_utils_ts_eslint from '@typescript-eslint/utils/ts-eslint';
-import { FlatConfig } from '@typescript-eslint/utils/ts-eslint';
-
-interface PluginSettings {
-    /** Required. Path to Tailwind v4 CSS entry, e.g. "./src/styles/tailwind.css" */
-    cssConfigPath: string;
-    /** Attributes/props that may contain Tailwind CSS classes */
-    attributes?: string[];
-    /** Functions whose arguments will be parsed for class strings */
-    functions?: string[];
-    /** Whitelist regex patterns for non-Tailwind classes */
-    whitelist?: string[];
-    /** Keys to ignore in object expressions */
-    ignoredKeys?: string[];
-}
-
-declare const plugin: {
-    meta: {
-        name: string;
-        version: string;
-    };
-    configs: {
-        readonly recommended: FlatConfig.Config | FlatConfig.ConfigArray;
-    };
-    rules: {
-        "no-invalid-classname": _typescript_eslint_utils_ts_eslint.RuleModule<"invalidClass", [({
-            whitelist?: string[];
-        } | undefined)?], unknown, _typescript_eslint_utils_ts_eslint.RuleListener>;
-    };
-};
-
-export = plugin;
-export type { PluginSettings };