@pengzhanbo/eslint-config 1.2.1 → 1.2.2

package/dist/index.cjs

@@ -78,6 +78,7 @@ __export(src_exports, {
   sortPackageJson: () => sortPackageJson,
   sortTsconfig: () => sortTsconfig,
   stylistic: () => stylistic,
+  tailwindcss: () => tailwindcss,
   test: () => test,
   toArray: () => toArray,
   typescript: () => typescript,
@@ -1236,8 +1237,8 @@ async function unocss(options = {}) {
   } = options;
   const unInstalled = unocssPackages.filter((i) => !(0, import_local_pkg.isPackageExists)(i));
   if (unInstalled.length > 0) {
-    const installed = unInstalled.join(", ");
-    console.warn(`${installed} is not installed, please install it first.`);
+    console.warn(`${unInstalled.join(", ")} is not installed, please install it first.
+ Run \`npm install -D ${unInstalled.join(" ")}\``);
     return [];
   }
   const [
@@ -1264,6 +1265,55 @@ async function unocss(options = {}) {
   ];
 }
 
+// src/configs/tailwindcss.ts
+var import_local_pkg2 = require("local-pkg");
+var tailwindPackages = ["eslint-plugin-tailwindcss"];
+async function tailwindcss(options = {}) {
+  const { whitelist, cssFiles: cssFilesFilter, customClassNames = true } = options;
+  const unInstalled = tailwindPackages.filter((i) => !(0, import_local_pkg2.isPackageExists)(i));
+  if (unInstalled.length > 0) {
+    console.warn(`${unInstalled.join(", ")} is not installed, please install it first.
+ Run \`npm install -D ${unInstalled.join(" ")}\``);
+    return [];
+  }
+  const [
+    pluginTailwindcss
+  ] = await Promise.all([
+    interopDefault(import("eslint-plugin-tailwindcss"))
+  ]);
+  const cssFiles = cssFilesFilter ? [.../* @__PURE__ */ new Set([
+    "**/*.css",
+    "!**/node_modules",
+    "!**/.*",
+    "!**/dist",
+    "!**/build",
+    ...cssFilesFilter
+  ])] : void 0;
+  return [
+    {
+      name: "config:tailwindcss:setup",
+      plugins: {
+        tailwindcss: pluginTailwindcss
+      },
+      settings: {
+        tailwindcss: {
+          cssFiles,
+          whitelist
+        }
+      }
+    },
+    {
+      name: "config:tailwindcss:rules",
+      rules: {
+        ...pluginTailwindcss.configs.recommended.rules,
+        ...customClassNames ? {
+          "tailwindcss/no-custom-classname": "off"
+        } : {}
+      }
+    }
+  ];
+}
+
 // src/preset.ts
 var defaultPreset = (options) => {
   const {
@@ -1337,20 +1387,22 @@ var defaultPreset = (options) => {
       stylistic: stylisticOptions
     }));
   }
+  if (options.unocss)
+    configs.push(unocss(options.unocss === true ? {} : options.unocss));
+  if (options.tailwindcss)
+    configs.push(tailwindcss(options.tailwindcss === true ? {} : options.tailwindcss));
   if (options.markdown) {
     configs.push(markdown({
       componentExts,
       overrides: overrides.markdown
     }));
   }
-  if (options.unocss)
-    configs.push(unocss(options.unocss === true ? {} : options.unocss));
   return configs;
 };
 
 // src/resolvedOptions.ts
 var import_node_process2 = __toESM(require("process"), 1);
-var import_local_pkg2 = require("local-pkg");
+var import_local_pkg3 = require("local-pkg");
 var VuePackages = [
   "vue",
   "nuxt",
@@ -1364,23 +1416,25 @@ function resolveOptions(options = {}) {
     gitignore = true,
     isInEditor = !!((import_node_process2.default.env.VSCODE_PID || import_node_process2.default.env.JETBRAINS_IDE) && !import_node_process2.default.env.CI),
     overrides = {},
-    typescript: typescript2 = (0, import_local_pkg2.isPackageExists)("typescript"),
+    typescript: typescript2 = (0, import_local_pkg3.isPackageExists)("typescript"),
     jsx = true,
     test: test2 = true,
     jsonc: jsonc2 = true,
     yaml: yaml2 = true,
     markdown: markdown2 = true,
-    unocss: enableUnocss = false
+    unocss: enableUnocss = false,
+    tailwindcss: enableTailwindcss = false
   } = options;
   const stylistic2 = options.stylistic === false ? false : typeof options.stylistic === "object" ? options.stylistic : {};
   if (stylistic2 && !("jsx" in stylistic2))
     stylistic2.jsx = options.jsx ?? true;
-  const unocss2 = enableUnocss === false ? false : typeof options.unocss === "object" ? options.unocss : {};
-  if (VuePackages.some((i) => (0, import_local_pkg2.isPackageExists)(i)))
+  const unocss2 = enableUnocss === false ? false : typeof enableUnocss === "object" ? enableUnocss : {};
+  const tailwindcss2 = enableTailwindcss === false ? false : typeof enableTailwindcss === "object" ? enableTailwindcss : {};
+  if (VuePackages.some((i) => (0, import_local_pkg3.isPackageExists)(i)))
     componentExts.push("vue");
-  if ((0, import_local_pkg2.isPackageExists)("astro"))
+  if ((0, import_local_pkg3.isPackageExists)("astro"))
     componentExts.push("astro");
-  if ((0, import_local_pkg2.isPackageExists)("svelte"))
+  if ((0, import_local_pkg3.isPackageExists)("svelte"))
     componentExts.push("svelte");
   return {
     ...options,
@@ -1396,7 +1450,8 @@ function resolveOptions(options = {}) {
     jsonc: jsonc2,
     yaml: yaml2,
     markdown: markdown2,
-    unocss: unocss2
+    unocss: unocss2,
+    tailwindcss: tailwindcss2
   };
 }
 
@@ -1491,6 +1546,7 @@ var src_default = eslintFlatConfig;
   sortPackageJson,
   sortTsconfig,
   stylistic,
+  tailwindcss,
   test,
   toArray,
   typescript,

package/dist/index.d.cts

@@ -92,6 +92,26 @@ interface OptionsUnoCSS {
      */
     strict?: boolean;
 }
+interface OptionsTailwindCSS {
+    /**
+     * Read CSS files
+     */
+    cssFiles?: string[];
+    /**
+     * List of whitelisted classes. when `no-custom-classname` is enabled,
+     * only allow classnames from Tailwind CSS and the values from the whitelist option.
+     * @default []
+     */
+    whitelist?: string[];
+    /**
+     * Enable custom class names.
+     *
+     * If it is false, only allow classnames from Tailwind CSS and the values
+     * from the `whitelist` option
+     * @default true
+     */
+    customClassNames?: boolean;
+}
 type PresetItem = (options: Required<Omit<OptionsConfig, 'preset'>> & {
     stylistic: false | StylisticConfig;
 }) => Awaitable<FlatConfigItem[]>[];
@@ -168,6 +188,13 @@ interface OptionsConfig extends OptionsComponentExts {
      * @default false
      */
     unocss?: boolean | OptionsUnoCSS;
+    /**
+     * Enable TailwindCSS rules.
+     *
+     * Requires installing:
+     * - `eslint-plugin-tailwindcss`
+     */
+    tailwindcss?: boolean | OptionsTailwindCSS;
     /**
      * Control to disable some rules in editors.
      * @default auto-detect based on the process.env
@@ -279,6 +306,8 @@ declare function perfectionist(): Promise<FlatConfigItem[]>;
 
 declare function unocss(options?: OptionsUnoCSS): Promise<FlatConfigItem[]>;
 
+declare function tailwindcss(options?: OptionsTailwindCSS): Promise<FlatConfigItem[]>;
+
 declare const defaultPreset: PresetItem;
 
-export { type Awaitable, type FlatConfigItem, GLOB_ALL_SRC, GLOB_ASTRO, GLOB_CSS, GLOB_EXCLUDE, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_SVELTE, GLOB_TESTS, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_YAML, type OptionsComponentExts, type OptionsConfig, type OptionsFiles, type OptionsHasTypeScript, type OptionsIsInEditor, type OptionsOverrides, type OptionsStylistic, type OptionsTypeScriptParserOptions, type OptionsTypeScriptWithTypes, type OptionsUnoCSS, type PresetItem, type Rules, type StylisticConfig, type UserConfigItem, type WrapRuleConfig, combine, comments, createConfig, eslintFlatConfig as default, defaultPreset, ignores, imports, interopDefault, javascript, jsdoc, jsonc, markdown, node, perfectionist, renameRules, sortPackageJson, sortTsconfig, stylistic, test, toArray, typescript, unicorn, unocss, yaml };
+export { type Awaitable, type FlatConfigItem, GLOB_ALL_SRC, GLOB_ASTRO, GLOB_CSS, GLOB_EXCLUDE, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_SVELTE, GLOB_TESTS, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_YAML, type OptionsComponentExts, type OptionsConfig, type OptionsFiles, type OptionsHasTypeScript, type OptionsIsInEditor, type OptionsOverrides, type OptionsStylistic, type OptionsTailwindCSS, type OptionsTypeScriptParserOptions, type OptionsTypeScriptWithTypes, type OptionsUnoCSS, type PresetItem, type Rules, type StylisticConfig, type UserConfigItem, type WrapRuleConfig, combine, comments, createConfig, eslintFlatConfig as default, defaultPreset, ignores, imports, interopDefault, javascript, jsdoc, jsonc, markdown, node, perfectionist, renameRules, sortPackageJson, sortTsconfig, stylistic, tailwindcss, test, toArray, typescript, unicorn, unocss, yaml };

package/dist/index.d.ts

@@ -92,6 +92,26 @@ interface OptionsUnoCSS {
      */
     strict?: boolean;
 }
+interface OptionsTailwindCSS {
+    /**
+     * Read CSS files
+     */
+    cssFiles?: string[];
+    /**
+     * List of whitelisted classes. when `no-custom-classname` is enabled,
+     * only allow classnames from Tailwind CSS and the values from the whitelist option.
+     * @default []
+     */
+    whitelist?: string[];
+    /**
+     * Enable custom class names.
+     *
+     * If it is false, only allow classnames from Tailwind CSS and the values
+     * from the `whitelist` option
+     * @default true
+     */
+    customClassNames?: boolean;
+}
 type PresetItem = (options: Required<Omit<OptionsConfig, 'preset'>> & {
     stylistic: false | StylisticConfig;
 }) => Awaitable<FlatConfigItem[]>[];
@@ -168,6 +188,13 @@ interface OptionsConfig extends OptionsComponentExts {
      * @default false
      */
     unocss?: boolean | OptionsUnoCSS;
+    /**
+     * Enable TailwindCSS rules.
+     *
+     * Requires installing:
+     * - `eslint-plugin-tailwindcss`
+     */
+    tailwindcss?: boolean | OptionsTailwindCSS;
     /**
      * Control to disable some rules in editors.
      * @default auto-detect based on the process.env
@@ -279,6 +306,8 @@ declare function perfectionist(): Promise<FlatConfigItem[]>;
 
 declare function unocss(options?: OptionsUnoCSS): Promise<FlatConfigItem[]>;
 
+declare function tailwindcss(options?: OptionsTailwindCSS): Promise<FlatConfigItem[]>;
+
 declare const defaultPreset: PresetItem;
 
-export { type Awaitable, type FlatConfigItem, GLOB_ALL_SRC, GLOB_ASTRO, GLOB_CSS, GLOB_EXCLUDE, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_SVELTE, GLOB_TESTS, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_YAML, type OptionsComponentExts, type OptionsConfig, type OptionsFiles, type OptionsHasTypeScript, type OptionsIsInEditor, type OptionsOverrides, type OptionsStylistic, type OptionsTypeScriptParserOptions, type OptionsTypeScriptWithTypes, type OptionsUnoCSS, type PresetItem, type Rules, type StylisticConfig, type UserConfigItem, type WrapRuleConfig, combine, comments, createConfig, eslintFlatConfig as default, defaultPreset, ignores, imports, interopDefault, javascript, jsdoc, jsonc, markdown, node, perfectionist, renameRules, sortPackageJson, sortTsconfig, stylistic, test, toArray, typescript, unicorn, unocss, yaml };
+export { type Awaitable, type FlatConfigItem, GLOB_ALL_SRC, GLOB_ASTRO, GLOB_CSS, GLOB_EXCLUDE, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_SVELTE, GLOB_TESTS, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_YAML, type OptionsComponentExts, type OptionsConfig, type OptionsFiles, type OptionsHasTypeScript, type OptionsIsInEditor, type OptionsOverrides, type OptionsStylistic, type OptionsTailwindCSS, type OptionsTypeScriptParserOptions, type OptionsTypeScriptWithTypes, type OptionsUnoCSS, type PresetItem, type Rules, type StylisticConfig, type UserConfigItem, type WrapRuleConfig, combine, comments, createConfig, eslintFlatConfig as default, defaultPreset, ignores, imports, interopDefault, javascript, jsdoc, jsonc, markdown, node, perfectionist, renameRules, sortPackageJson, sortTsconfig, stylistic, tailwindcss, test, toArray, typescript, unicorn, unocss, yaml };

package/dist/index.js

@@ -1147,8 +1147,8 @@ async function unocss(options = {}) {
   } = options;
   const unInstalled = unocssPackages.filter((i) => !isPackageExists(i));
   if (unInstalled.length > 0) {
-    const installed = unInstalled.join(", ");
-    console.warn(`${installed} is not installed, please install it first.`);
+    console.warn(`${unInstalled.join(", ")} is not installed, please install it first.
+ Run \`npm install -D ${unInstalled.join(" ")}\``);
     return [];
   }
   const [
@@ -1175,6 +1175,55 @@ async function unocss(options = {}) {
   ];
 }
 
+// src/configs/tailwindcss.ts
+import { isPackageExists as isPackageExists2 } from "local-pkg";
+var tailwindPackages = ["eslint-plugin-tailwindcss"];
+async function tailwindcss(options = {}) {
+  const { whitelist, cssFiles: cssFilesFilter, customClassNames = true } = options;
+  const unInstalled = tailwindPackages.filter((i) => !isPackageExists2(i));
+  if (unInstalled.length > 0) {
+    console.warn(`${unInstalled.join(", ")} is not installed, please install it first.
+ Run \`npm install -D ${unInstalled.join(" ")}\``);
+    return [];
+  }
+  const [
+    pluginTailwindcss
+  ] = await Promise.all([
+    interopDefault(import("eslint-plugin-tailwindcss"))
+  ]);
+  const cssFiles = cssFilesFilter ? [.../* @__PURE__ */ new Set([
+    "**/*.css",
+    "!**/node_modules",
+    "!**/.*",
+    "!**/dist",
+    "!**/build",
+    ...cssFilesFilter
+  ])] : void 0;
+  return [
+    {
+      name: "config:tailwindcss:setup",
+      plugins: {
+        tailwindcss: pluginTailwindcss
+      },
+      settings: {
+        tailwindcss: {
+          cssFiles,
+          whitelist
+        }
+      }
+    },
+    {
+      name: "config:tailwindcss:rules",
+      rules: {
+        ...pluginTailwindcss.configs.recommended.rules,
+        ...customClassNames ? {
+          "tailwindcss/no-custom-classname": "off"
+        } : {}
+      }
+    }
+  ];
+}
+
 // src/preset.ts
 var defaultPreset = (options) => {
   const {
@@ -1248,20 +1297,22 @@ var defaultPreset = (options) => {
       stylistic: stylisticOptions
     }));
   }
+  if (options.unocss)
+    configs.push(unocss(options.unocss === true ? {} : options.unocss));
+  if (options.tailwindcss)
+    configs.push(tailwindcss(options.tailwindcss === true ? {} : options.tailwindcss));
   if (options.markdown) {
     configs.push(markdown({
       componentExts,
       overrides: overrides.markdown
     }));
   }
-  if (options.unocss)
-    configs.push(unocss(options.unocss === true ? {} : options.unocss));
   return configs;
 };
 
 // src/resolvedOptions.ts
 import process2 from "process";
-import { isPackageExists as isPackageExists2 } from "local-pkg";
+import { isPackageExists as isPackageExists3 } from "local-pkg";
 var VuePackages = [
   "vue",
   "nuxt",
@@ -1275,23 +1326,25 @@ function resolveOptions(options = {}) {
     gitignore = true,
     isInEditor = !!((process2.env.VSCODE_PID || process2.env.JETBRAINS_IDE) && !process2.env.CI),
     overrides = {},
-    typescript: typescript2 = isPackageExists2("typescript"),
+    typescript: typescript2 = isPackageExists3("typescript"),
     jsx = true,
     test: test2 = true,
     jsonc: jsonc2 = true,
     yaml: yaml2 = true,
     markdown: markdown2 = true,
-    unocss: enableUnocss = false
+    unocss: enableUnocss = false,
+    tailwindcss: enableTailwindcss = false
   } = options;
   const stylistic2 = options.stylistic === false ? false : typeof options.stylistic === "object" ? options.stylistic : {};
   if (stylistic2 && !("jsx" in stylistic2))
     stylistic2.jsx = options.jsx ?? true;
-  const unocss2 = enableUnocss === false ? false : typeof options.unocss === "object" ? options.unocss : {};
-  if (VuePackages.some((i) => isPackageExists2(i)))
+  const unocss2 = enableUnocss === false ? false : typeof enableUnocss === "object" ? enableUnocss : {};
+  const tailwindcss2 = enableTailwindcss === false ? false : typeof enableTailwindcss === "object" ? enableTailwindcss : {};
+  if (VuePackages.some((i) => isPackageExists3(i)))
     componentExts.push("vue");
-  if (isPackageExists2("astro"))
+  if (isPackageExists3("astro"))
     componentExts.push("astro");
-  if (isPackageExists2("svelte"))
+  if (isPackageExists3("svelte"))
     componentExts.push("svelte");
   return {
     ...options,
@@ -1307,7 +1360,8 @@ function resolveOptions(options = {}) {
     jsonc: jsonc2,
     yaml: yaml2,
     markdown: markdown2,
-    unocss: unocss2
+    unocss: unocss2,
+    tailwindcss: tailwindcss2
   };
 }
 
@@ -1402,6 +1456,7 @@ export {
   sortPackageJson,
   sortTsconfig,
   stylistic,
+  tailwindcss,
   test,
   toArray,
   typescript,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pengzhanbo/eslint-config",
   "type": "module",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "author": "pengzhanbo <q942450674@outlook.com> (https://github/pengzhanbo/)",
   "license": "MIT",
   "homepage": "https://github.com/pengzhanbo/configs#readme",
@@ -33,11 +33,15 @@
   ],
   "peerDependencies": {
     "@unocss/eslint-plugin": ">=0.50.0",
-    "eslint": ">=8.40.0"
+    "eslint": ">=8.40.0",
+    "eslint-plugin-tailwindcss": ">=3.10.0"
   },
   "peerDependenciesMeta": {
     "@unocss/eslint-plugin": {
       "optional": true
+    },
+    "eslint-plugin-tailwindcss": {
+      "optional": true
     }
   },
   "dependencies": {
@@ -72,6 +76,7 @@
     "@unocss/eslint-plugin": "^0.57.7",
     "eslint": "^8.54.0",
     "eslint-flat-config-viewer": "^0.1.3",
+    "eslint-plugin-tailwindcss": "^3.13.0",
     "tsup": "^8.0.1"
   },
   "scripts": {