@lincy/eslint-config 4.0.2 → 4.1.0

package/dist/index.js

@@ -1,7 +1,7 @@
 // src/factory.ts
-import process2 from "process";
+import process3 from "process";
 import fs from "fs";
-import { isPackageExists } from "local-pkg";
+import { isPackageExists as isPackageExists3 } from "local-pkg";
 
 // src/plugins.ts
 import { default as default2 } from "eslint-plugin-antfu";
@@ -362,6 +362,8 @@ async function javascript(options = {}) {
 }
 
 // src/utils.ts
+import process from "process";
+import { isPackageExists } from "local-pkg";
 async function combine(...configs) {
   const resolved = await Promise.all(configs);
   return resolved.flat();
@@ -382,6 +384,23 @@ async function interopDefault(m) {
   const resolved = await m;
   return resolved.default || resolved;
 }
+async function ensurePackages(packages) {
+  if (process.stdout.isTTY === false)
+    return;
+  const nonExistingPackages = packages.filter((i) => !isPackageExists(i));
+  if (nonExistingPackages.length === 0)
+    return;
+  const { default: prompts } = await import("prompts");
+  const { result } = await prompts([
+    {
+      message: `${nonExistingPackages.length === 1 ? "Package is" : "Packages are"} required for this config: ${nonExistingPackages.join(", ")}. Do you want to install them?`,
+      name: "result",
+      type: "confirm"
+    }
+  ]);
+  if (result)
+    await import("@antfu/install-pkg").then((i) => i.installPackage(nonExistingPackages, { dev: true }));
+}
 
 // src/configs/jsdoc.ts
 async function jsdoc(options = {}) {
@@ -423,6 +442,7 @@ async function jsdoc(options = {}) {
 // src/configs/jsonc.ts
 async function jsonc(options = {}) {
   const {
+    files = [GLOB_JSON, GLOB_JSON5, GLOB_JSONC],
     overrides = {},
     stylistic: stylistic2 = true
   } = options;
@@ -441,7 +461,7 @@ async function jsonc(options = {}) {
       }
     },
     {
-      files: [GLOB_JSON, GLOB_JSON5, GLOB_JSONC],
+      files,
       languageOptions: {
         parser: parserJsonc
       },
@@ -495,6 +515,7 @@ async function jsonc(options = {}) {
 async function markdown(options = {}) {
   const {
     componentExts = [],
+    files = [GLOB_MARKDOWN],
     overrides = {}
   } = options;
   return [
@@ -506,7 +527,7 @@ async function markdown(options = {}) {
       }
     },
     {
-      files: [GLOB_MARKDOWN],
+      files,
       name: "eslint:markdown:processor",
       processor: "markdown/markdown"
     },
@@ -950,7 +971,7 @@ async function stylistic(options = {}) {
           "style/jsx-first-prop-new-line": "error",
           "style/jsx-indent": ["error", indent, { checkAttributes: true, indentLogicalExpressions: true }],
           "style/jsx-indent-props": ["error", indent],
-          "style/jsx-max-props-per-line": ["error", { maximum: 1 }],
+          "style/jsx-max-props-per-line": ["error", { maximum: 4 }],
           // 在 JSX 中的单行上强制执行最多 props 数量
           "style/jsx-newline": "off",
           // 在 jsx 元素和表达式之后换行
@@ -980,13 +1001,17 @@ async function stylistic(options = {}) {
 }
 
 // src/configs/typescript.ts
-import process from "process";
-async function typescript(options) {
+import process2 from "process";
+async function typescript(options = {}) {
   const {
     componentExts = [],
     overrides = {},
     parserOptions = {}
-  } = options ?? {};
+  } = options;
+  const files = options.files ?? [
+    GLOB_SRC,
+    ...componentExts.map((ext) => `**/*.${ext}`)
+  ];
   const typeAwareRules = {
     "dot-notation": "off",
     "no-implied-eval": "off",
@@ -1026,10 +1051,7 @@ async function typescript(options) {
       }
     },
     {
-      files: [
-        GLOB_SRC,
-        ...componentExts.map((ext) => `**/*.${ext}`)
-      ],
+      files,
       languageOptions: {
         parser: parserTs,
         parserOptions: {
@@ -1037,7 +1059,7 @@ async function typescript(options) {
           sourceType: "module",
           ...tsconfigPath ? {
             project: tsconfigPath,
-            tsconfigRootDir: process.cwd()
+            tsconfigRootDir: process2.cwd()
           } : {},
           ...parserOptions
         }
@@ -1165,6 +1187,7 @@ vueVersion = vueVersion && vueVersion[0];
 vueVersion = Number.isNaN(vueVersion) ? "3" : vueVersion;
 async function vue(options = {}) {
   const {
+    files = [GLOB_VUE],
     overrides = {},
     stylistic: stylistic2 = true
   } = options;
@@ -1187,7 +1210,7 @@ async function vue(options = {}) {
       }
     },
     {
-      files: [GLOB_VUE],
+      files,
       languageOptions: {
         parser: parserVue,
         parserOptions: {
@@ -1306,6 +1329,7 @@ async function vue(options = {}) {
 // src/configs/yaml.ts
 async function yaml(options = {}) {
   const {
+    files = [GLOB_YAML],
     overrides = {},
     stylistic: stylistic2 = true
   } = options;
@@ -1324,7 +1348,7 @@ async function yaml(options = {}) {
       }
     },
     {
-      files: [GLOB_YAML],
+      files,
       languageOptions: {
         parser: parserYaml
       },
@@ -1360,6 +1384,7 @@ async function yaml(options = {}) {
 // src/configs/test.ts
 async function test(options = {}) {
   const {
+    files = GLOB_TESTS,
     isInEditor = false,
     overrides = {}
   } = options;
@@ -1386,7 +1411,7 @@ async function test(options = {}) {
       }
     },
     {
-      files: GLOB_TESTS,
+      files,
       name: "eslint:test:rules",
       rules: {
         "node/prefer-global/process": "off",
@@ -1414,31 +1439,49 @@ async function perfectionist() {
 }
 
 // src/configs/react.ts
+import { isPackageExists as isPackageExists2 } from "local-pkg";
+var ReactRefreshAllowConstantExportPackages = [
+  "vite"
+];
 async function react(options = {}) {
   const {
+    files = [GLOB_JSX, GLOB_TSX],
     jsx = true,
     overrides = {},
+    typescript: typescript2 = true,
     version = "17.0"
   } = options;
+  await ensurePackages([
+    "eslint-plugin-react",
+    "eslint-plugin-react-hooks",
+    "eslint-plugin-react-refresh"
+  ]);
   const [
     pluginReact,
-    pluginReactHooks
+    pluginReactHooks,
+    pluginReactRefresh
   ] = await Promise.all([
     // @ts-expect-error missing types
     interopDefault(import("eslint-plugin-react")),
     // @ts-expect-error missing types
-    interopDefault(import("eslint-plugin-react-hooks"))
+    interopDefault(import("eslint-plugin-react-hooks")),
+    // @ts-expect-error missing types
+    interopDefault(import("eslint-plugin-react-refresh"))
   ]);
+  const isAllowConstantExport = ReactRefreshAllowConstantExportPackages.some(
+    (i) => isPackageExists2(i)
+  );
   return [
     {
       name: "eslint:react:setup",
       plugins: {
         "react": pluginReact,
-        "react-hooks": pluginReactHooks
+        "react-hooks": pluginReactHooks,
+        "react-refresh": pluginReactRefresh
       }
     },
     {
-      files: [GLOB_JSX, GLOB_TSX],
+      files,
       languageOptions: {
         parserOptions: {
           ecmaFeatures: {
@@ -1448,100 +1491,111 @@ async function react(options = {}) {
       },
       name: "eslint:react:rules",
       rules: {
+        // react-hooks
         "react-hooks/exhaustive-deps": "warn",
         "react-hooks/rules-of-hooks": "error",
-        "react/boolean-prop-naming": 2,
-        "react/button-has-type": 2,
-        "react/default-props-match-prop-types": 2,
-        "react/destructuring-assignment": 2,
-        "react/display-name": 2,
+        // react-refresh
+        "react-refresh/only-export-components": [
+          "warn",
+          { allowConstantExport: isAllowConstantExport }
+        ],
+        // react
+        "react/boolean-prop-naming": "error",
+        "react/button-has-type": "error",
+        "react/default-props-match-prop-types": "error",
+        "react/destructuring-assignment": "error",
+        "react/display-name": "error",
         "react/forbid-component-props": "off",
         // 禁止组件上使用某些 props
-        "react/forbid-dom-props": 2,
-        "react/forbid-elements": 2,
-        "react/forbid-foreign-prop-types": 2,
-        "react/forbid-prop-types": 2,
-        "react/function-component-definition": 2,
+        "react/forbid-dom-props": "error",
+        "react/forbid-elements": "error",
+        "react/forbid-foreign-prop-types": "error",
+        "react/forbid-prop-types": "error",
+        "react/function-component-definition": "error",
         "react/hook-use-state": "off",
         // useState 钩子值和 setter 变量的解构和对称命名
-        "react/iframe-missing-sandbox": 2,
-        "react/jsx-boolean-value": 2,
+        "react/iframe-missing-sandbox": "error",
+        "react/jsx-boolean-value": "error",
         "react/jsx-filename-extension": "off",
         // 禁止可能包含 JSX 文件扩展名
-        "react/jsx-fragments": 2,
-        "react/jsx-handler-names": 2,
-        "react/jsx-key": 2,
+        "react/jsx-fragments": "error",
+        "react/jsx-handler-names": "error",
+        "react/jsx-key": "error",
         "react/jsx-max-depth": "off",
         // 强制 JSX 最大深度
         "react/jsx-no-bind": "off",
         // .bind()JSX 属性中禁止使用箭头函数
-        "react/jsx-no-comment-textnodes": 2,
-        "react/jsx-no-constructed-context-values": 2,
-        "react/jsx-no-duplicate-props": 2,
-        "react/jsx-no-leaked-render": 2,
+        "react/jsx-no-comment-textnodes": "error",
+        "react/jsx-no-constructed-context-values": "error",
+        "react/jsx-no-duplicate-props": "error",
+        "react/jsx-no-leaked-render": "error",
         "react/jsx-no-literals": "off",
         // 禁止在 JSX 中使用字符串文字
-        "react/jsx-no-script-url": 2,
-        "react/jsx-no-target-blank": 2,
-        "react/jsx-no-undef": 2,
-        "react/jsx-no-useless-fragment": 2,
-        "react/jsx-pascal-case": 2,
+        "react/jsx-no-script-url": "error",
+        "react/jsx-no-target-blank": "error",
+        "react/jsx-no-undef": "error",
+        "react/jsx-no-useless-fragment": "error",
+        "react/jsx-pascal-case": "error",
         "react/jsx-props-no-spreading": "off",
         // 强制任何 JSX 属性都不会传播
-        "react/jsx-uses-react": 2,
-        "react/jsx-uses-vars": 2,
-        "react/no-access-state-in-setstate": 2,
-        "react/no-adjacent-inline-elements": 2,
-        "react/no-array-index-key": 2,
-        "react/no-arrow-function-lifecycle": 2,
-        "react/no-children-prop": 2,
+        "react/jsx-uses-react": "error",
+        "react/jsx-uses-vars": "error",
+        "react/no-access-state-in-setstate": "error",
+        "react/no-adjacent-inline-elements": "error",
+        "react/no-array-index-key": "error",
+        "react/no-arrow-function-lifecycle": "error",
+        "react/no-children-prop": "error",
         "react/no-danger": "off",
         // 禁止使用 dangerouslySetInnerHTML
-        "react/no-danger-with-children": 2,
-        "react/no-deprecated": 2,
-        "react/no-did-mount-set-state": 2,
-        "react/no-did-update-set-state": 2,
-        "react/no-direct-mutation-state": 2,
-        "react/no-find-dom-node": 2,
-        "react/no-invalid-html-attribute": 2,
-        "react/no-is-mounted": 2,
-        "react/no-multi-comp": 2,
-        "react/no-namespace": 2,
-        "react/no-object-type-as-default-prop": 2,
-        "react/no-redundant-should-component-update": 2,
-        "react/no-render-return-value": 2,
-        "react/no-set-state": 2,
-        "react/no-string-refs": 2,
-        "react/no-this-in-sfc": 2,
-        "react/no-typos": 2,
-        "react/no-unescaped-entities": 2,
-        "react/no-unknown-property": 2,
+        "react/no-danger-with-children": "error",
+        "react/no-deprecated": "error",
+        "react/no-did-mount-set-state": "error",
+        "react/no-did-update-set-state": "error",
+        "react/no-direct-mutation-state": "error",
+        "react/no-find-dom-node": "error",
+        "react/no-invalid-html-attribute": "error",
+        "react/no-is-mounted": "error",
+        "react/no-multi-comp": "error",
+        "react/no-namespace": "error",
+        "react/no-object-type-as-default-prop": "error",
+        "react/no-redundant-should-component-update": "error",
+        "react/no-render-return-value": "error",
+        "react/no-set-state": "error",
+        "react/no-string-refs": "error",
+        "react/no-this-in-sfc": "error",
+        "react/no-typos": "error",
+        "react/no-unescaped-entities": "error",
+        "react/no-unknown-property": "error",
         "react/no-unsafe": "off",
         // 禁止使用不安全的生命周期方法
-        "react/no-unstable-nested-components": 2,
-        "react/no-unused-class-component-methods": 2,
-        "react/no-unused-prop-types": 2,
-        "react/no-unused-state": 2,
-        "react/no-will-update-set-state": 2,
-        "react/prefer-es6-class": 2,
-        "react/prefer-exact-props": 2,
-        "react/prefer-read-only-props": 2,
-        "react/prefer-stateless-function": 2,
-        "react/prop-types": 2,
+        "react/no-unstable-nested-components": "error",
+        "react/no-unused-class-component-methods": "error",
+        "react/no-unused-prop-types": "error",
+        "react/no-unused-state": "error",
+        "react/no-will-update-set-state": "error",
+        "react/prefer-es6-class": "error",
+        "react/prefer-exact-props": "error",
+        "react/prefer-read-only-props": "error",
+        "react/prefer-stateless-function": "error",
+        "react/prop-types": "error",
         "react/react-in-jsx-scope": "off",
         // 使用 JSX 时需要引入 React
         "react/require-default-props": "off",
         // 为每个非必需 prop 强制执行 defaultProps 定义
-        "react/require-optimization": 2,
-        "react/require-render-return": 2,
-        "react/self-closing-comp": 2,
-        "react/sort-comp": 2,
-        "react/sort-default-props": 2,
-        "react/sort-prop-types": 2,
-        "react/state-in-constructor": 2,
-        "react/static-property-placement": 2,
-        "react/style-prop-object": 2,
-        "react/void-dom-elements-no-children": 2,
+        "react/require-optimization": "error",
+        "react/require-render-return": "error",
+        "react/self-closing-comp": "error",
+        "react/sort-comp": "error",
+        "react/sort-default-props": "error",
+        "react/sort-prop-types": "error",
+        "react/state-in-constructor": "error",
+        "react/static-property-placement": "error",
+        "react/style-prop-object": "error",
+        "react/void-dom-elements-no-children": "error",
+        ...typescript2 ? {
+          "react/jsx-no-undef": "off",
+          "react/prop-type": "off"
+        } : {},
         ...overrides
       },
       settings: {
@@ -1553,6 +1607,39 @@ async function react(options = {}) {
   ];
 }
 
+// src/configs/unocss.ts
+async function unocss(options = {}) {
+  const {
+    attributify = true,
+    strict = false
+  } = options;
+  await ensurePackages([
+    "@unocss/eslint-plugin"
+  ]);
+  const [
+    pluginUnoCSS
+  ] = await Promise.all([
+    interopDefault(import("@unocss/eslint-plugin"))
+  ]);
+  return [
+    {
+      name: "eslint:unocss",
+      plugins: {
+        unocss: pluginUnoCSS
+      },
+      rules: {
+        "unocss/order": "off",
+        ...attributify ? {
+          "unocss/order-attributify": "warn"
+        } : {},
+        ...strict ? {
+          "unocss/blocklist": "error"
+        } : {}
+      }
+    }
+  ];
+}
+
 // src/factory.ts
 var flatConfigProps = [
   "files",
@@ -1578,11 +1665,12 @@ async function lincy(options = {}, ...userConfigs) {
   const {
     componentExts = [],
     gitignore: enableGitignore = true,
-    isInEditor = !!((process2.env.VSCODE_PID || process2.env.JETBRAINS_IDE) && !process2.env.CI),
+    isInEditor = !!((process3.env.VSCODE_PID || process3.env.JETBRAINS_IDE) && !process3.env.CI),
     overrides = {},
-    react: enableReact = ReactPackages.some((i) => isPackageExists(i)),
-    typescript: enableTypeScript = isPackageExists("typescript"),
-    vue: enableVue = VuePackages.some((i) => isPackageExists(i))
+    react: enableReact = ReactPackages.some((i) => isPackageExists3(i)),
+    typescript: enableTypeScript = isPackageExists3("typescript"),
+    unocss: enableUnoCSS = false,
+    vue: enableVue = VuePackages.some((i) => isPackageExists3(i))
   } = options;
   const stylisticOptions = options.stylistic === false ? false : typeof options.stylistic === "object" ? options.stylistic : {};
   if (stylisticOptions) {
@@ -1635,12 +1723,14 @@ async function lincy(options = {}, ...userConfigs) {
   }
   if (options.test ?? true) {
     configs.push(test({
+      ...typeof options.test !== "boolean" ? options.test : {},
       isInEditor,
       overrides: overrides.test
     }));
   }
   if (enableVue) {
     configs.push(vue({
+      ...typeof options.vue !== "boolean" ? options.vue : {},
       overrides: overrides.vue,
       stylistic: stylisticOptions,
       typescript: !!enableTypeScript
@@ -1648,13 +1738,20 @@ async function lincy(options = {}, ...userConfigs) {
   }
   if (enableReact) {
     configs.push(react({
+      ...typeof enableReact !== "boolean" ? enableReact : {},
       overrides: overrides.react,
-      ...typeof enableReact !== "boolean" ? enableReact : {}
+      typescript: !!enableTypeScript
     }));
   }
+  if (enableUnoCSS) {
+    configs.push(unocss(
+      typeof enableUnoCSS === "boolean" ? {} : enableUnoCSS
+    ));
+  }
   if (options.jsonc ?? true) {
     configs.push(
       jsonc({
+        ...typeof options.jsonc !== "boolean" ? options.jsonc : {},
         overrides: overrides.jsonc,
         stylistic: stylisticOptions
       }),
@@ -1664,12 +1761,14 @@ async function lincy(options = {}, ...userConfigs) {
   }
   if (options.yaml ?? true) {
     configs.push(yaml({
+      ...typeof options.yaml !== "boolean" ? options.yaml : {},
       overrides: overrides.yaml,
       stylistic: stylisticOptions
     }));
   }
   if (options.markdown ?? true) {
     configs.push(markdown({
+      ...typeof options.markdown !== "boolean" ? options.markdown : {},
       componentExts,
       overrides: overrides.markdown
     }));
@@ -1715,6 +1814,7 @@ export {
   combine,
   comments,
   src_default as default,
+  ensurePackages,
   ignores,
   imports,
   interopDefault,
@@ -1734,6 +1834,7 @@ export {
   toArray,
   typescript,
   unicorn,
+  unocss,
   vue,
   yaml
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@lincy/eslint-config",
   "type": "module",
-  "version": "4.0.2",
+  "version": "4.1.0",
   "packageManager": "pnpm@8.7.6",
   "description": "LinCenYing's ESLint config",
   "author": "LinCenYing <lincenying@gmail.com> (https://github.com/lincenying/)",
@@ -36,15 +36,34 @@
     "prepare": "sh simple-git-hooks.sh"
   },
   "peerDependencies": {
-    "eslint": ">=8.0.0"
+    "@unocss/eslint-plugin": ">=0.50.0",
+    "eslint": ">=8.40.0",
+    "eslint-plugin-react": "^7.33.2",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-react-refresh": "^0.4.4"
+  },
+  "peerDependenciesMeta": {
+    "@unocss/eslint-plugin": {
+      "optional": true
+    },
+    "eslint-plugin-react": {
+      "optional": true
+    },
+    "eslint-plugin-react-hooks": {
+      "optional": true
+    },
+    "eslint-plugin-react-refresh": {
+      "optional": true
+    }
   },
   "dependencies": {
     "@antfu/eslint-define-config": "1.23.0-2",
-    "@stylistic/eslint-plugin": "1.4.0",
-    "@typescript-eslint/eslint-plugin": "^6.11.0",
-    "@typescript-eslint/parser": "^6.11.0",
+    "@antfu/install-pkg": "^0.3.0",
+    "@stylistic/eslint-plugin": "1.4.1",
+    "@typescript-eslint/eslint-plugin": "^6.12.0",
+    "@typescript-eslint/parser": "^6.12.0",
     "eslint-config-flat-gitignore": "^0.1.1",
-    "eslint-plugin-antfu": "^1.0.10",
+    "eslint-plugin-antfu": "^1.0.11",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-i": "^2.29.0",
     "eslint-plugin-jsdoc": "^46.9.0",
@@ -52,9 +71,7 @@
     "eslint-plugin-markdown": "^3.0.1",
     "eslint-plugin-n": "^16.3.1",
     "eslint-plugin-no-only-tests": "^3.1.0",
-    "eslint-plugin-perfectionist": "^2.4.0",
-    "eslint-plugin-react": "^7.33.2",
-    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-perfectionist": "^2.4.2",
     "eslint-plugin-unicorn": "^49.0.0",
     "eslint-plugin-unused-imports": "^3.0.0",
     "eslint-plugin-vitest": "^0.3.10",
@@ -63,29 +80,35 @@
     "globals": "^13.23.0",
     "jsonc-eslint-parser": "^2.4.0",
     "local-pkg": "^0.5.0",
+    "prompts": "^2.4.2",
     "vue-eslint-parser": "^9.3.2",
     "yaml-eslint-parser": "^1.2.2"
   },
   "devDependencies": {
-    "@antfu/ni": "^0.21.9",
+    "@antfu/ni": "^0.21.10",
     "@eslint-types/jsdoc": "46.9.0",
-    "@eslint-types/typescript-eslint": "^6.11.0",
+    "@eslint-types/typescript-eslint": "^6.12.0",
     "@eslint-types/unicorn": "^49.0.0",
     "@lincy/eslint-config": "workspace:*",
-    "@stylistic/eslint-plugin-migrate": "^1.4.0",
+    "@stylistic/eslint-plugin-migrate": "^1.4.1",
     "@types/eslint": "^8.44.7",
-    "@types/node": "^20.9.2",
+    "@types/node": "^20.10.0",
+    "@types/prompts": "^2.4.9",
+    "@unocss/eslint-plugin": "^0.57.7",
     "bumpp": "^9.2.0",
     "eslint": "^8.54.0",
     "eslint-flat-config-viewer": "^0.1.3",
+    "eslint-plugin-react": "^7.33.2",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-react-refresh": "^0.4.4",
     "esno": "^4.0.0",
     "lint-staged": "^15.1.0",
     "rimraf": "^5.0.5",
     "simple-git-hooks": "^2.9.0",
     "simple-open-url": "^3.0.1",
     "sucrase": "^3.34.0",
-    "tsup": "^8.0.0",
-    "typescript": "^5.2.2",
+    "tsup": "^8.0.1",
+    "typescript": "^5.3.2",
     "unbuild": "^2.0.0",
     "vitest": "^0.34.6"
   },