@lincy/eslint-config 4.3.1 → 4.5.0

package/README.md

@@ -135,7 +135,7 @@ export default lincy({
     /**
      * 是否启用 stylistic 格式化规则
      * @default 默认值: true
-     * @example 可选: false | { indent?: number | 'tab'; quotes?: 'single' | 'double'; jsx?: boolean; semi?: boolean }
+     * @example 可选: false | { indent?: number | 'tab'; quotes?: 'single' | 'double'; jsx?: boolean; semi?: boolean; lessOpinionated?: boolean; }
      */
     stylistic: true,
     /**
@@ -508,7 +508,7 @@ pnpm add eslint-plugin-format -D
 运行“npx eslint”会提示您安装所需的依赖项，当然，也可以手动安装它们：
 
 ```bash
-pnpm i -D eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-react-refresh
+pnpm i -D @eslint-react/eslint-plugin eslint-plugin-react-hooks eslint-plugin-react-refresh
 ```
 
 #### UnoCSS
@@ -540,14 +540,14 @@ pnpm i -D @unocss/eslint-plugin
 
 建议使用[configuration comments]单独选择每个文件。(https://eslint.org/docs/latest/use/configure/rules#using-configuration-comments-1).
 
-```js
+```ts
 /* eslint perfectionist/sort-objects: "error" */
 const objectWantedToSort = {
     a: 2,
     b: 1,
     c: 3,
 }
-/* eslint perfectionist/sort-objects: "off" */
+/* e slint perfectionist/sort-objects: "off" */
 ```
 
 ### 类型感知规则

package/dist/index.cjs

@@ -440,7 +440,7 @@ async function javascript(options = {}) {
         "unused-imports/no-unused-imports": isInEditor ? "off" : "error",
         "unused-imports/no-unused-vars": [
           "error",
-          { args: "after-used", argsIgnorePattern: "^_", vars: "all", varsIgnorePattern: "^_" }
+          { args: "after-used", argsIgnorePattern: "^_", ignoreRestSiblings: true, vars: "all", varsIgnorePattern: "^_" }
         ],
         "use-isnan": ["error", { enforceForIndexOf: true, enforceForSwitchCase: true }],
         "valid-typeof": ["error", { requireStringLiterals: true }],
@@ -470,8 +470,9 @@ function renameRules(rules, map) {
   return Object.fromEntries(
     Object.entries(rules).map(([key, value]) => {
       for (const [from, to] of Object.entries(map)) {
-        if (key.startsWith(`${from}/`))
+        if (key.startsWith(`${from}/`)) {
           return [to + key.slice(from.length), value];
+        }
       }
       return [key, value];
     })
@@ -480,13 +481,15 @@ function renameRules(rules, map) {
 function renamePluginInConfigs(configs, map) {
   return configs.map((i) => {
     const clone = { ...i };
-    if (clone.rules)
+    if (clone.rules) {
       clone.rules = renameRules(clone.rules, map);
+    }
     if (clone.plugins) {
       clone.plugins = Object.fromEntries(
         Object.entries(clone.plugins).map(([key, value]) => {
-          if (key in map)
+          if (key in map) {
             return [map[key], value];
+          }
           return [key, value];
         })
       );
@@ -502,11 +505,13 @@ async function interopDefault(m) {
   return resolved.default || resolved;
 }
 async function ensurePackages(packages) {
-  if (import_node_process.default.stdout.isTTY === false)
+  if (import_node_process.default.stdout.isTTY === false) {
     return;
+  }
   const nonExistingPackages = packages.filter((i) => !(0, import_local_pkg.isPackageExists)(i));
-  if (nonExistingPackages.length === 0)
+  if (nonExistingPackages.length === 0) {
     return;
+  }
   const { default: prompts } = await import("prompts");
   const { result } = await prompts([
     {
@@ -515,8 +520,9 @@ async function ensurePackages(packages) {
       type: "confirm"
     }
   ]);
-  if (result)
+  if (result) {
     await import("@antfu/install-pkg").then((i) => i.installPackage(nonExistingPackages, { dev: true }));
+  }
 }
 
 // src/configs/jsdoc.ts
@@ -741,6 +747,7 @@ var parserPlain2 = __toESM(require("eslint-parser-plain"), 1);
 var StylisticConfigDefaults = {
   indent: 4,
   jsx: true,
+  lessOpinionated: true,
   quotes: "single",
   semi: false
 };
@@ -752,6 +759,7 @@ async function stylistic(options = {}) {
   const {
     indent,
     jsx,
+    lessOpinionated,
     quotes,
     semi
   } = typeof stylistic2 === "boolean" ? StylisticConfigDefaults : { ...StylisticConfigDefaults, ...stylistic2 };
@@ -774,9 +782,13 @@ async function stylistic(options = {}) {
       rules: {
         ...config.rules,
         "antfu/consistent-list-newline": "off",
-        "antfu/if-newline": "error",
-        "antfu/top-level-function": "error",
-        "curly": ["error", "multi-or-nest", "consistent"],
+        ...lessOpinionated ? {
+          curly: ["error", "all"]
+        } : {
+          "antfu/if-newline": "error",
+          "antfu/top-level-function": "error",
+          "curly": ["error", "multi-or-nest", "consistent"]
+        },
         // 覆盖`stylistic`默认规则
         "style/member-delimiter-style": ["error", { multiline: { delimiter: "none" } }],
         "style/multiline-ternary": ["error", "never"],
@@ -889,7 +901,7 @@ async function formatters(options = {}, stylistic2 = {}) {
   }
   if (options.html) {
     configs.push({
-      files: ["**/*.html"],
+      files: [GLOB_HTML],
       languageOptions: {
         parser: parserPlain2
       },
@@ -985,152 +997,116 @@ async function react(options = {}) {
     typescript: typescript2 = true,
     version = "detect"
   } = options;
+  const tsconfigPath = options?.tsconfigPath ? toArray(options.tsconfigPath) : void 0;
+  const isTypeAware = !!tsconfigPath || !typescript2;
   await ensurePackages([
-    "eslint-plugin-react",
+    "@eslint-react/eslint-plugin",
     "eslint-plugin-react-hooks",
     "eslint-plugin-react-refresh"
   ]);
   const [
     pluginReact,
     pluginReactHooks,
-    pluginReactRefresh
+    pluginReactRefresh,
+    parserTs
   ] = await Promise.all([
-    // @ts-expect-error missing types
-    interopDefault(import("eslint-plugin-react")),
+    interopDefault(import("@eslint-react/eslint-plugin")),
     // @ts-expect-error missing types
     interopDefault(import("eslint-plugin-react-hooks")),
     // @ts-expect-error missing types
-    interopDefault(import("eslint-plugin-react-refresh"))
+    interopDefault(import("eslint-plugin-react-refresh")),
+    interopDefault(import("@typescript-eslint/parser"))
   ]);
   const _isAllowConstantExport = ReactRefreshAllowConstantExportPackages.some(
     (i) => (0, import_local_pkg2.isPackageExists)(i)
   );
+  const plugins = pluginReact.configs.all.plugins;
   return [
     {
       name: "eslint:react:setup",
       plugins: {
-        "react": pluginReact,
+        "react": plugins["@eslint-react"],
+        "react-dom": plugins["@eslint-react/dom"],
         "react-hooks": pluginReactHooks,
+        "react-hooks-extra": plugins["@eslint-react/hooks-extra"],
+        "react-naming-convention": plugins["@eslint-react/naming-convention"],
         "react-refresh": pluginReactRefresh
       }
     },
     {
       files,
       languageOptions: {
+        parser: parserTs,
         parserOptions: {
           ecmaFeatures: {
             jsx
-          }
+          },
+          ...isTypeAware ? { project: tsconfigPath } : {}
         }
       },
       name: "eslint:react:rules",
       rules: {
-        // react-hooks
+        // recommended rules from @eslint-react/dom
+        "react-dom/no-children-in-void-dom-elements": "warn",
+        "react-dom/no-dangerously-set-innerhtml": "warn",
+        "react-dom/no-dangerously-set-innerhtml-with-children": "error",
+        "react-dom/no-find-dom-node": "error",
+        "react-dom/no-missing-button-type": "warn",
+        "react-dom/no-missing-iframe-sandbox": "warn",
+        "react-dom/no-namespace": "error",
+        "react-dom/no-render-return-value": "error",
+        "react-dom/no-script-url": "warn",
+        "react-dom/no-unsafe-iframe-sandbox": "warn",
+        "react-dom/no-unsafe-target-blank": "warn",
+        // recommended rules react-hooks
         "react-hooks/exhaustive-deps": "warn",
         "react-hooks/rules-of-hooks": "error",
-        // react-refresh
+        // react refresh
         // 'react-refresh/only-export-components': [
         //     'warn',
-        //     { allowConstantExport: _isAllowConstantExport },
+        //     { allowConstantExport: isAllowConstantExport },
         // ],
-        "react-refresh/only-export-components": "off",
-        // 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": "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": "error",
-        "react/jsx-boolean-value": "error",
-        "react/jsx-filename-extension": "off",
-        // 禁止可能包含 JSX 文件扩展名
-        "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": "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": "error",
-        "react/jsx-no-target-blank": "error",
-        "react/jsx-no-undef": "error",
-        "react/jsx-no-useless-fragment": "error",
-        "react/jsx-props-no-spreading": "off",
-        // 强制任何 JSX 属性都不会传播
-        "react/jsx-uses-react": "error",
-        "react/jsx-uses-vars": "error",
+        // recommended rules from @eslint-react
+        "react/ensure-forward-ref-using-ref": "warn",
         "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": "error",
-        "react/no-deprecated": "error",
-        "react/no-did-mount-set-state": "error",
-        "react/no-did-update-set-state": "error",
+        "react/no-array-index-key": "warn",
+        "react/no-children-count": "warn",
+        "react/no-children-for-each": "warn",
+        "react/no-children-map": "warn",
+        "react/no-children-only": "warn",
+        "react/no-children-prop": "warn",
+        "react/no-children-to-array": "warn",
+        "react/no-clone-element": "warn",
+        "react/no-comment-textnodes": "warn",
+        "react/no-component-will-mount": "error",
+        "react/no-component-will-receive-props": "error",
+        "react/no-component-will-update": "error",
+        "react/no-create-ref": "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-duplicate-key": "error",
+        "react/no-implicit-key": "error",
+        "react/no-missing-key": "error",
+        "react/no-nested-components": "warn",
         "react/no-redundant-should-component-update": "error",
-        "react/no-render-return-value": "error",
-        "react/no-set-state": "error",
+        "react/no-set-state-in-component-did-mount": "warn",
+        "react/no-set-state-in-component-did-update": "warn",
+        "react/no-set-state-in-component-will-update": "warn",
         "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": "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": "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",
-        "style/jsx-pascal-case": "error",
-        ...typescript2 ? {
-          "react/jsx-no-undef": "off",
-          "react/prop-type": "off"
+        "react/no-unsafe-component-will-mount": "warn",
+        "react/no-unsafe-component-will-receive-props": "warn",
+        "react/no-unsafe-component-will-update": "warn",
+        "react/no-unstable-context-value": "error",
+        "react/no-unstable-default-props": "error",
+        "react/no-unused-class-component-members": "warn",
+        "react/no-unused-state": "warn",
+        "react/no-useless-fragment": "warn",
+        "react/prefer-destructuring-assignment": "warn",
+        "react/prefer-shorthand-boolean": "warn",
+        "react/prefer-shorthand-fragment": "warn",
+        ...isTypeAware ? {
+          "react/no-leaked-conditional-rendering": "warn"
         } : {},
+        // overrides
         ...overrides
       },
       settings: {
@@ -1960,6 +1936,10 @@ var VuePackages = [
   "@slidev/cli"
 ];
 var defaultPluginRenaming = {
+  "@eslint-react": "react",
+  "@eslint-react/dom": "react-dom",
+  "@eslint-react/hooks-extra": "react-hooks-extra",
+  "@eslint-react/naming-convention": "react-naming-convention",
   "@stylistic": "style",
   "@typescript-eslint": "ts",
   "import-x": "import",
@@ -1985,16 +1965,18 @@ function lincy(options = {}, ...userConfigs) {
   } = options;
   const stylisticOptions = options.stylistic === false ? false : typeof options.stylistic === "object" ? options.stylistic : {};
   if (stylisticOptions) {
-    if (!("jsx" in stylisticOptions))
+    if (!("jsx" in stylisticOptions)) {
       stylisticOptions.jsx = options.jsx ?? true;
+    }
   }
   const configs = [];
   if (enableGitignore) {
     if (typeof enableGitignore !== "boolean") {
       configs.push(interopDefault(import("eslint-config-flat-gitignore")).then((r) => [r(enableGitignore)]));
     } else {
-      if (import_node_fs.default.existsSync(".gitignore"))
+      if (import_node_fs.default.existsSync(".gitignore")) {
         configs.push(interopDefault(import("eslint-config-flat-gitignore")).then((r) => [r()]));
+      }
     }
   }
   configs.push(
@@ -2017,8 +1999,9 @@ function lincy(options = {}, ...userConfigs) {
     // Optional plugins (installed but not enabled by default)
     perfectionist()
   );
-  if (enableVue)
+  if (enableVue) {
     componentExts.push("vue");
+  }
   if (enableTypeScript) {
     configs.push(typescript({
       ...typeof enableTypeScript !== "boolean" ? enableTypeScript : {},
@@ -2098,20 +2081,23 @@ function lincy(options = {}, ...userConfigs) {
     ));
   }
   const fusedConfig = flatConfigProps.reduce((acc, key) => {
-    if (key in options)
+    if (key in options) {
       acc[key] = options[key];
+    }
     return acc;
   }, {});
-  if (Object.keys(fusedConfig).length)
+  if (Object.keys(fusedConfig).length) {
     configs.push([fusedConfig]);
-  let pipeline = new import_eslint_flat_config_utils.FlatConfigComposer();
-  pipeline = pipeline.append(
+  }
+  let composer = new import_eslint_flat_config_utils.FlatConfigComposer();
+  composer = composer.append(
     ...configs,
     ...userConfigs
   );
-  if (autoRenamePlugins)
-    pipeline = pipeline.renamePlugins(defaultPluginRenaming);
-  return pipeline;
+  if (autoRenamePlugins) {
+    composer = composer.renamePlugins(defaultPluginRenaming);
+  }
+  return composer;
 }
 
 // src/index.ts