@lincy/eslint-config 4.0.2 → 4.1.0

package/dist/index.cjs

@@ -54,6 +54,7 @@ __export(src_exports, {
   combine: () => combine,
   comments: () => comments,
   default: () => src_default,
+  ensurePackages: () => ensurePackages,
   ignores: () => ignores,
   imports: () => imports,
   interopDefault: () => interopDefault,
@@ -73,15 +74,16 @@ __export(src_exports, {
   toArray: () => toArray,
   typescript: () => typescript,
   unicorn: () => unicorn,
+  unocss: () => unocss,
   vue: () => vue,
   yaml: () => yaml
 });
 module.exports = __toCommonJS(src_exports);
 
 // src/factory.ts
-var import_node_process2 = __toESM(require("process"), 1);
+var import_node_process3 = __toESM(require("process"), 1);
 var import_node_fs = __toESM(require("fs"), 1);
-var import_local_pkg2 = require("local-pkg");
+var import_local_pkg4 = require("local-pkg");
 
 // src/plugins.ts
 var import_eslint_plugin_antfu = __toESM(require("eslint-plugin-antfu"), 1);
@@ -442,6 +444,8 @@ async function javascript(options = {}) {
 }
 
 // src/utils.ts
+var import_node_process = __toESM(require("process"), 1);
+var import_local_pkg = require("local-pkg");
 async function combine(...configs) {
   const resolved = await Promise.all(configs);
   return resolved.flat();
@@ -462,6 +466,23 @@ async function interopDefault(m) {
   const resolved = await m;
   return resolved.default || resolved;
 }
+async function ensurePackages(packages) {
+  if (import_node_process.default.stdout.isTTY === false)
+    return;
+  const nonExistingPackages = packages.filter((i) => !(0, import_local_pkg.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 = {}) {
@@ -503,6 +524,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;
@@ -521,7 +543,7 @@ async function jsonc(options = {}) {
       }
     },
     {
-      files: [GLOB_JSON, GLOB_JSON5, GLOB_JSONC],
+      files,
       languageOptions: {
         parser: parserJsonc
       },
@@ -575,6 +597,7 @@ async function jsonc(options = {}) {
 async function markdown(options = {}) {
   const {
     componentExts = [],
+    files = [GLOB_MARKDOWN],
     overrides = {}
   } = options;
   return [
@@ -586,7 +609,7 @@ async function markdown(options = {}) {
       }
     },
     {
-      files: [GLOB_MARKDOWN],
+      files,
       name: "eslint:markdown:processor",
       processor: "markdown/markdown"
     },
@@ -1030,7 +1053,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 元素和表达式之后换行
@@ -1060,13 +1083,17 @@ async function stylistic(options = {}) {
 }
 
 // src/configs/typescript.ts
-var import_node_process = __toESM(require("process"), 1);
-async function typescript(options) {
+var import_node_process2 = __toESM(require("process"), 1);
+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",
@@ -1106,10 +1133,7 @@ async function typescript(options) {
       }
     },
     {
-      files: [
-        GLOB_SRC,
-        ...componentExts.map((ext) => `**/*.${ext}`)
-      ],
+      files,
       languageOptions: {
         parser: parserTs,
         parserOptions: {
@@ -1117,7 +1141,7 @@ async function typescript(options) {
           sourceType: "module",
           ...tsconfigPath ? {
             project: tsconfigPath,
-            tsconfigRootDir: import_node_process.default.cwd()
+            tsconfigRootDir: import_node_process2.default.cwd()
           } : {},
           ...parserOptions
         }
@@ -1238,13 +1262,14 @@ async function unicorn() {
 }
 
 // src/configs/vue.ts
-var import_local_pkg = require("local-pkg");
-var pkg = (0, import_local_pkg.getPackageInfoSync)("vue");
+var import_local_pkg2 = require("local-pkg");
+var pkg = (0, import_local_pkg2.getPackageInfoSync)("vue");
 var vueVersion = pkg && pkg.version;
 vueVersion = vueVersion && vueVersion[0];
 vueVersion = Number.isNaN(vueVersion) ? "3" : vueVersion;
 async function vue(options = {}) {
   const {
+    files = [GLOB_VUE],
     overrides = {},
     stylistic: stylistic2 = true
   } = options;
@@ -1267,7 +1292,7 @@ async function vue(options = {}) {
       }
     },
     {
-      files: [GLOB_VUE],
+      files,
       languageOptions: {
         parser: parserVue,
         parserOptions: {
@@ -1386,6 +1411,7 @@ async function vue(options = {}) {
 // src/configs/yaml.ts
 async function yaml(options = {}) {
   const {
+    files = [GLOB_YAML],
     overrides = {},
     stylistic: stylistic2 = true
   } = options;
@@ -1404,7 +1430,7 @@ async function yaml(options = {}) {
       }
     },
     {
-      files: [GLOB_YAML],
+      files,
       languageOptions: {
         parser: parserYaml
       },
@@ -1440,6 +1466,7 @@ async function yaml(options = {}) {
 // src/configs/test.ts
 async function test(options = {}) {
   const {
+    files = GLOB_TESTS,
     isInEditor = false,
     overrides = {}
   } = options;
@@ -1466,7 +1493,7 @@ async function test(options = {}) {
       }
     },
     {
-      files: GLOB_TESTS,
+      files,
       name: "eslint:test:rules",
       rules: {
         "node/prefer-global/process": "off",
@@ -1494,31 +1521,49 @@ async function perfectionist() {
 }
 
 // src/configs/react.ts
+var import_local_pkg3 = require("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) => (0, import_local_pkg3.isPackageExists)(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: {
@@ -1528,100 +1573,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: {
@@ -1633,6 +1689,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",
@@ -1658,11 +1747,12 @@ async function lincy(options = {}, ...userConfigs) {
   const {
     componentExts = [],
     gitignore: enableGitignore = true,
-    isInEditor = !!((import_node_process2.default.env.VSCODE_PID || import_node_process2.default.env.JETBRAINS_IDE) && !import_node_process2.default.env.CI),
+    isInEditor = !!((import_node_process3.default.env.VSCODE_PID || import_node_process3.default.env.JETBRAINS_IDE) && !import_node_process3.default.env.CI),
     overrides = {},
-    react: enableReact = ReactPackages.some((i) => (0, import_local_pkg2.isPackageExists)(i)),
-    typescript: enableTypeScript = (0, import_local_pkg2.isPackageExists)("typescript"),
-    vue: enableVue = VuePackages.some((i) => (0, import_local_pkg2.isPackageExists)(i))
+    react: enableReact = ReactPackages.some((i) => (0, import_local_pkg4.isPackageExists)(i)),
+    typescript: enableTypeScript = (0, import_local_pkg4.isPackageExists)("typescript"),
+    unocss: enableUnoCSS = false,
+    vue: enableVue = VuePackages.some((i) => (0, import_local_pkg4.isPackageExists)(i))
   } = options;
   const stylisticOptions = options.stylistic === false ? false : typeof options.stylistic === "object" ? options.stylistic : {};
   if (stylisticOptions) {
@@ -1715,12 +1805,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
@@ -1728,13 +1820,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
       }),
@@ -1744,12 +1843,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
     }));
@@ -1795,6 +1896,7 @@ var src_default = lincy;
   GLOB_YAML,
   combine,
   comments,
+  ensurePackages,
   ignores,
   imports,
   interopDefault,
@@ -1814,6 +1916,7 @@ var src_default = lincy;
   toArray,
   typescript,
   unicorn,
+  unocss,
   vue,
   yaml
 });