@lincy/eslint-config 4.0.3 → 4.1.0

package/README.md

@@ -46,9 +46,9 @@ For example:
 }
 ```
 
-## VS Code support (auto fix)
+## VS Code support (自动修复)
 
-安装[VS Code ESLint扩展](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
+安装 [VS Code ESLint扩展](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
 
 将以下设置添加到您的“settings.json”：
 
@@ -130,47 +130,75 @@ module.exports = lincy()
 import lincy from '@lincy/eslint-config'
 
 export default lincy({
-    // 是否启用 stylistic 格式化规则
-    // 默认值: true
-    // 可选: false | { indent: number | 'tab', quotes: 'single' | 'double', jsx: boolean}
+    /**
+     * 是否启用 stylistic 格式化规则
+     * @default 默认值: true
+     * @example 可选: false | { indent?: number | 'tab'; quotes?: 'single' | 'double'; jsx?: boolean; files?: string[]}
+     */
     stylistic: true,
-    // 是否启用 typescript 规则
-    // 默认值: 检测是否安装typescript依赖,
-    // 可选: false | true | { parserOptions: {} }
+    /**
+     * 是否启用 typescript 规则
+     * @default 默认值: 检测是否安装typescript依赖,
+     * @example 可选: false | true | { parserOptions: {}; files?: string[] }
+     */
     typescript: true,
-    // 是否启用 vue 规则
-    // 默认值: 检测是否安装vue依赖,
-    // 可选: false | true
+    /**
+     * 是否启用 vue 规则
+     * @default 默认值: 检测是否安装vue依赖,
+     * @example 可选: false | true | { files?: string[] }
+     */
     vue: true,
-    // 是否启用 jsx 规则
-    // 默认值: true,
-    // 可选: false
+    /**
+     * 是否启用 jsx 规则
+     * @default 默认值: true,
+     * @example 可选: false
+     */
     jsx: true,
-    // 是否启用 react 规则
-    // 默认值: 检测是否安装react依赖,
-    // 可选: false | true | { jsx: boolean, version: string }
+    /**
+     * 是否启用 react 规则
+     * @default 默认值: 检测是否安装react依赖,
+     * @example 可选: false | true | { jsx?: boolean; version?: string; files?: string[] }
+     */
     react: true,
-    // 是否启用 jsonc 规则
-    // 默认值: true,
-    // 可选: false
+    /**
+     * 是否启用 unocss 规则
+     * @default 默认值: false,
+     * @example 可选: true | { attributify?: boolean; strict?: boolean }
+     */
+    unocss: true,
+    /**
+     * 是否启用 jsonc 规则
+     * @default 默认值: true,
+     * @example 可选: false | { files?: string[] }
+     */
     jsonc: false,
-    // 是否启用 yaml 规则
-    // 默认值: true,
-    // 可选: false
+    /**
+     * 是否启用 yaml 规则
+     * @default 默认值: true,
+     * @example 可选: false | { files?: string[] }
+     */
     yaml: false,
-    // 是否启用 .gitignore 文件
-    // 默认值: true,
-    // 可选: false | { ignores: string[] }
+    /**
+     * 是否启用 .gitignore 文件
+     * @default 默认值: true,
+     * @example 可选: false | { ignores?: string[] }
+     */
     gitignore: false,
-    // 是否启用 test 规则
-    // 默认值: true,
-    // 可选: false
+    /**
+     * 是否启用 test 规则
+     * @default 默认值: true,
+     * @example 可选: false | { files?: string[] }
+     */
     test: false,
-    // 是否启用 markdown 规则
-    // 默认值: true,
-    // 可选: false
+    /**
+     * 是否启用 markdown 规则
+     * @default 默认值: true,
+     * @example 可选: false | { files?: string[] }
+     */
     markdown: false,
-    // 覆盖规则
+    /**
+     * 覆盖规则
+     */
     overrides: {},
 
     // 工厂函数第一个参数默认为各规则的开关, 但是也可以作为追加规则使用, 当包含以下键名将会自动整合到一个规则里
@@ -185,7 +213,8 @@ export default lincy({
 })
 ```
 
-`lincy` 工厂函数还接受任意数量的自定义配置覆盖：
+`lincy` 工厂函数还接受任意数量的自定义配置覆盖
+下面示例为添加`auto-import`生成的全局方法
 
 ```js
 // eslint.config.js
@@ -200,16 +229,8 @@ const autoImport = JSON.parse(
 export default lincy(
     {
         // 配置, 参考上一个代码块
-    },
-    // 启用 unocss
-    {
-        plugins: {
-            '@unocss': plugin,
-        },
-        rules: {
-            ...plugin.configs.recommended.rules,
-            '@unocss/order': 'off',
-        },
+        // 启用 unocss
+        unocss: true
     },
     // 启用 auto-import 生成的 .eslintrc-auto-import.json
     {
@@ -251,6 +272,7 @@ import {
     stylistic,
     typescript,
     unicorn,
+    unocss,
     vue,
     yaml,
 } from '@lincy/eslint-config'
@@ -268,6 +290,7 @@ export default combine(
     stylistic(/* Options */),
     vue(),
     react(/* Options */),
+    unocss(/* Options */),
     jsonc(),
     yaml(),
     markdown(),
@@ -382,6 +405,40 @@ export default lincy({
 })
 ```
 
+### 可选配置
+
+提供了一些可选配置，默认情况下不包含它们的依赖项
+
+#### React
+
+当检测到依赖安装了`react`, 则默认开启
+
+运行“npx eslint”会提示您安装所需的依赖项，当然，您也可以手动安装它们：
+
+```bash
+pnpm i -D eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-react-refresh
+```
+
+#### UnoCSS
+
+要启用 UnoCSS 支持，需要显式打开它
+
+```js
+// eslint.config.js
+import lincy from '@lincy/eslint-config'
+
+export default lincy({
+    unocss: true,
+})
+```
+
+运行“npx eslint”会提示您安装所需的依赖项，当然，您也可以手动安装它们：
+
+```bash
+pnpm i -D @unocss/eslint-plugin
+```
+
+
 #### `perfectionist` (sorting)
 
 这个插件 [`eslint-plugin-perfectionist`](https://github.com/azat-io/eslint-plugin-perfectionist) 允许你排序对象键名，导入，自动修复等。

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,8 +1573,15 @@ async function react(options = {}) {
       },
       name: "eslint:react:rules",
       rules: {
+        // react-hooks
         "react-hooks/exhaustive-deps": "warn",
         "react-hooks/rules-of-hooks": "error",
+        // 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",
@@ -1622,6 +1674,10 @@ async function react(options = {}) {
         "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
 });