添加Tailwind自定义类后ESLint报‘className非Tailwind类’错误求助

问题描述 #

在tailwind.config.js中添加自定义颜色（如primary系列、bodyBg）等扩展类后，ESLint持续报错“className is not a TailwindCSS class”，但按预期自定义类应被识别为合法Tailwind类。

相关配置文件 #

eslintrc.js #

// eslint-disable-next-line @typescript-eslint/no-var-requires
const fs = require("fs")

module.exports = {
  extends: [
    "next",
    "prettier",
    "react-app",
    "react-app/jest",
    "plugin:storybook/recommended",
    "plugin:tailwindcss/recommended",
  ],
  parserOptions: {
    babelOptions: {
      presets: [require.resolve("next/babel")],
    },
  },
  rules: {
    "testing-library/prefer-screen-queries": "off",
    "@next/next/no-html-link-for-pages": "off",
    "@typescript-eslint/no-unused-vars": [
      "warn",
      {
        argsIgnorePattern: "^_",
        varsIgnorePattern: "^_",
      },
    ],
    "sort-imports": [
      "error",
      {
        ignoreCase: true,
        ignoreDeclarationSort: true,
      },
    ],
    "tailwindcss/classnames-order": "off",
    "import/order": [
      1,
      {
        groups: ["external", "builtin", "internal", "sibling", "parent", "index"],
        pathGroups: [
          ...getDirectoriesToSort().map((singleDir) => ({
            pattern: `${singleDir}/**`,
            group: "internal",
          })),
          {
            pattern: "env",
            group: "internal",
          },
          {
            pattern: "theme",
            group: "internal",
          },
          {
            pattern: "public/**",
            group: "internal",
            position: "after",
          },
        ],
        pathGroupsExcludedImportTypes: ["internal"],
        alphabetize: {
          order: "asc",
          caseInsensitive: true,
        },
      },
    ],
  },
}

function getDirectoriesToSort() {
  const ignoredSortingDirectories = [".git", ".next", ".vscode", "node_modules"]
  return getDirectories(process.cwd()).filter((f) => !ignoredSortingDirectories.includes(f))
}

function getDirectories(path) {
  return fs.readdirSync(path).filter(function (file) {
    return fs.statSync(path + "/" + file).isDirectory()
  })
}

tailwind.config.js #

/* eslint-disable @typescript-eslint/no-var-requires */
const defaultTheme = require("tailwindcss/defaultTheme")

/** @type {import('tailwindcss').Config} */
module.exports = {
  darkMode: "class",
  content: [
    "./index.html",
    "./src/**/*.{js,ts,jsx,tsx}",
    "./app/**/*.{js,ts,jsx,tsx,mdx}",
    "./pages/**/*.{js,ts,jsx,tsx,mdx}",
    "./components/**/*.{js,ts,jsx,tsx,mdx}",
    "./src/**/*.{js,ts,jsx,tsx,mdx}",
  ],
  theme: {
    extend: {
      colors: {
        primary: {
          50: "#eff6ff",
          100: "#dbeafe",
          200: "#bfdbfe",
          300: "#93c5fd",
          400: "#60a5fa",
          500: "#3b82f6",
          600: "#2563eb",
          700: "#1d4ed8",
          800: "#1e40af",
          900: "#1e3a8a",
        },
        bodyBg: "#252525",
      },
      fontFamily: {
        body: [
          "Inter",
          "ui-sans-serif",
          "system-ui",
          "-apple-system",
          "system-ui",
          "Segoe UI",
          "Roboto",
          "Helvetica Neue",
          "Arial",
          "Noto Sans",
          "sans-serif",
          "Apple Color Emoji",
          "Segoe UI Emoji",
          "Segoe UI Symbol",
          "Noto Color Emoji",
        ],
        sans: [
          "Inter",
          "ui-sans-serif",
          "system-ui",
          "-apple-system",
          "system-ui",
          "Segoe UI",
          "Roboto",
          "Helvetica Neue",
          "Arial",
          "Noto Sans",
          "sans-serif",
          "Apple Color Emoji",
          "Segoe UI Emoji",
          "Segoe UI Symbol",
          "Noto Color Emoji",
        ],
      },
      borderWidth: {
        DEFAULT: "1px",
        0: "0",
        2: "2px",
        3: "3px",
        4: "4px",
        6: "6px",
        8: "8px",
      },
      minHeight: {
        ...defaultTheme.height,
      },
      minWidth: {
        ...defaultTheme.width,
      },
    },
  },
  plugins: [],
  future: {
    hoverOnlyWhenSupported: true,
  },
}

解决步骤 #

1. 显式指定Tailwind配置路径
   在ESLint配置中添加settings字段，明确告诉tailwindcss插件配置文件位置，避免自动查找失败：

   module.exports = {
     // ...其他配置
     settings: {
       tailwindcss: {
         config: "./tailwind.config.js" // 按实际项目路径调整
       }
     }
   }
   

2. 检查自定义类的使用格式
   自定义颜色需要配合Tailwind前缀使用：比如bodyBg要写成bg-bodyBg，primary系列要写成bg-primary-500、text-primary-600这类格式，确保类名符合Tailwind的规则。

3. 清除ESLint缓存
   执行命令清除旧缓存，避免缓存导致的识别异常：

   npx eslint --cache-clear
   

4. 优化Tailwind的content路径
   移除重复的src路径，确保所有使用自定义类的文件都被包含：

   content: [
     "./index.html",
     "./src/**/*.{js,ts,jsx,tsx,mdx}",
     "./app/**/*.{js,ts,jsx,tsx,mdx}",
     "./pages/**/*.{js,ts,jsx,tsx,mdx}",
     "./components/**/*.{js,ts,jsx,tsx,mdx}",
   ]
   

5. 调整ESLint扩展顺序
   将plugin:tailwindcss/recommended移到extends数组的最后，避免其他配置覆盖它的规则：

   extends: [
     "next",
     "prettier",
     "react-app",
     "react-app/jest",
     "plugin:storybook/recommended",
     "plugin:tailwindcss/recommended", // 放在最后
   ],
   

6. 更新依赖版本
   确保eslint-plugin-tailwindcss、tailwindcss和ESLint版本兼容，执行命令更新到最新稳定版：

   npm update eslint-plugin-tailwindcss tailwindcss eslint
   

内容的提问来源于stack exchange，提问作者Rom-888