@lincy/eslint-config 5.4.2 → 5.5.1

package/README.md

@@ -10,6 +10,8 @@
 - 也适用于 json、yaml、markdown
 - import导入排序, 对象字⾯量项尾逗号
 - 合理的默认值，最佳实践，只需一行配置
+- .gitignore默认支持
+- 需要 ESLint v9.5.0+
 - [ESLint Flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new)
 - 使用 [ESLint Stylistic](https://github.com/eslint-stylistic/eslint-stylistic)
 - **风格原则**: 读取最小，差异稳定
@@ -25,7 +27,7 @@ pnpm add -D eslint @lincy/eslint-config
 ### Create config file
 
 ```js
-// eslint.config.js
+// eslint.config.mjs
 import lincy from '@lincy/eslint-config'
 
 export default lincy()
@@ -110,7 +112,7 @@ export default lincy()
 如果 package.json 中开启了`"type": "module",`
 
 ```js
-// eslint.config.js
+// eslint.config.mjs
 import lincy from '@lincy/eslint-config'
 
 // or

package/dist/index.cjs

@@ -82,6 +82,7 @@ __export(index_exports, {
   node: () => node,
   parserPlain: () => parserPlain,
   perfectionist: () => perfectionist,
+  pnpm: () => pnpm,
   react: () => react,
   regexp: () => regexp,
   renamePluginInConfigs: () => renamePluginInConfigs,
@@ -101,7 +102,7 @@ __export(index_exports, {
 });
 module.exports = __toCommonJS(index_exports);
 
-// node_modules/.pnpm/tsup@8.3.6_jiti@2.4.2_postcss@8.4.49_tsx@4.19.2_typescript@5.7.3_yaml@2.7.0/node_modules/tsup/assets/cjs_shims.js
+// node_modules/.pnpm/tsup@8.4.0_jiti@2.4.2_postcss@8.4.49_tsx@4.19.3_typescript@5.8.2_yaml@2.7.0/node_modules/tsup/assets/cjs_shims.js
 var getImportMetaUrl = () => typeof document === "undefined" ? new URL(`file:${__filename}`).href : document.currentScript && document.currentScript.src || new URL("main.js", document.baseURI).href;
 var importMetaUrl = /* @__PURE__ */ getImportMetaUrl();
 
@@ -414,7 +415,9 @@ async function stylistic(options = {}) {
         },
         // 覆盖`stylistic`默认规则
         "style/brace-style": ["error", "stroustrup"],
+        "style/generator-star-spacing": ["error", { after: true, before: false }],
         "style/multiline-ternary": ["error", "never"],
+        "style/yield-star-spacing": ["error", { after: true, before: false }],
         ...overrides
       }
     }
@@ -1195,6 +1198,53 @@ async function perfectionist(options = {}) {
   ];
 }
 
+// src/configs/pnpm.ts
+async function pnpm() {
+  const [
+    pluginPnpm,
+    yamlParser,
+    jsoncParser
+  ] = await Promise.all([
+    interopDefault(import("eslint-plugin-pnpm")),
+    interopDefault(import("yaml-eslint-parser")),
+    interopDefault(import("jsonc-eslint-parser"))
+  ]);
+  return [
+    {
+      files: [
+        "package.json",
+        "**/package.json"
+      ],
+      languageOptions: {
+        parser: jsoncParser
+      },
+      name: "eslint/pnpm/package-json",
+      plugins: {
+        pnpm: pluginPnpm
+      },
+      rules: {
+        "pnpm/json-enforce-catalog": "error",
+        "pnpm/json-prefer-workspace-settings": "error",
+        "pnpm/json-valid-catalog": "error"
+      }
+    },
+    {
+      files: ["pnpm-workspace.yaml"],
+      languageOptions: {
+        parser: yamlParser
+      },
+      name: "eslint/pnpm/pnpm-workspace-yaml",
+      plugins: {
+        pnpm: pluginPnpm
+      },
+      rules: {
+        "pnpm/yaml-no-duplicate-catalog-item": "error",
+        "pnpm/yaml-no-unused-catalog-item": "error"
+      }
+    }
+  ];
+}
+
 // src/configs/react.ts
 var import_local_pkg2 = require("local-pkg");
 var ReactRefreshAllowConstantExportPackages = [
@@ -1240,7 +1290,6 @@ async function react(options = {}) {
     pluginReactRefresh
   ] = await Promise.all([
     interopDefault(import("@eslint-react/eslint-plugin")),
-    // @ts-expect-error missing types
     interopDefault(import("eslint-plugin-react-hooks")),
     interopDefault(import("eslint-plugin-react-refresh"))
   ]);
@@ -1276,22 +1325,29 @@ async function react(options = {}) {
       },
       name: "eslint/react/rules",
       rules: {
-        // recommended rules from @eslint-react/dom
-        "react-dom/no-children-in-void-dom-elements": "warn",
-        "react-dom/no-dangerously-set-innerhtml": "off",
+        // recommended rules from eslint-plugin-react-dom https://eslint-react.xyz/docs/rules/overview#dom-rules
+        "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-flush-sync": "error",
+        "react-dom/no-hydrate": "error",
         "react-dom/no-missing-button-type": "warn",
         "react-dom/no-missing-iframe-sandbox": "warn",
         "react-dom/no-namespace": "error",
+        "react-dom/no-render": "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-dom/no-use-form-state": "error",
+        "react-dom/no-void-elements-with-children": "error",
+        // recommended rules from eslint-plugin-react-hooks-extra https://eslint-react.xyz/docs/rules/overview#hooks-extra-rules
+        "react-hooks-extra/no-direct-set-state-in-use-effect": "warn",
+        "react-hooks-extra/no-unnecessary-use-prefix": "warn",
+        // recommended rules eslint-plugin-react-hooks https://github.com/facebook/react/tree/main/packages/eslint-plugin-react-hooks/src/rules
         "react-hooks/exhaustive-deps": "warn",
         "react-hooks/rules-of-hooks": "error",
-        // react refresh
+        // preconfigured rules from eslint-plugin-react-refresh https://github.com/ArnaudBarre/eslint-plugin-react-refresh/tree/main/src
         "react-refresh/only-export-components": [
           "warn",
           {
@@ -1322,31 +1378,35 @@ async function react(options = {}) {
             ]
           }
         ],
-        // recommended rules from @eslint-react/web-api
+        // recommended rules from eslint-plugin-react-web-api https://eslint-react.xyz/docs/rules/overview#web-api-rules
         "react-web-api/no-leaked-event-listener": "warn",
         "react-web-api/no-leaked-interval": "warn",
         "react-web-api/no-leaked-resize-observer": "warn",
         "react-web-api/no-leaked-timeout": "warn",
-        // recommended rules from @eslint-react
-        "react/ensure-forward-ref-using-ref": "warn",
+        // recommended rules from eslint-plugin-react-x https://eslint-react.xyz/docs/rules/overview#core-rules
         "react/no-access-state-in-setstate": "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-context-provider": "warn",
         "react/no-create-ref": "error",
+        "react/no-default-props": "error",
         "react/no-direct-mutation-state": "error",
-        "react/no-duplicate-key": "error",
+        "react/no-duplicate-jsx-props": "warn",
+        "react/no-duplicate-key": "warn",
+        "react/no-forward-ref": "warn",
+        "react/no-implicit-key": "warn",
         "react/no-missing-key": "error",
-        "react/no-nested-components": "warn",
+        "react/no-nested-component-definitions": "error",
+        "react/no-prop-types": "error",
         "react/no-redundant-should-component-update": "error",
         "react/no-set-state-in-component-did-mount": "warn",
         "react/no-set-state-in-component-did-update": "warn",
@@ -1355,14 +1415,13 @@ async function react(options = {}) {
         "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-unstable-context-value": "warn",
+        "react/no-unstable-default-props": "warn",
         "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",
+        "react/no-use-context": "warn",
+        "react/no-useless-forward-ref": "warn",
+        "react/use-jsx-vars": "warn",
         // overrides
         ...overrides
       }
@@ -1548,6 +1607,7 @@ function sortTsconfig() {
               "useDefineForClassFields",
               "emitDecoratorMetadata",
               "experimentalDecorators",
+              "libReplacement",
               /* Modules */
               "baseUrl",
               "rootDir",
@@ -1621,6 +1681,7 @@ function sortTsconfig() {
               "isolatedModules",
               "preserveSymlinks",
               "verbatimModuleSyntax",
+              "erasableSyntaxOnly",
               /* Completeness */
               "skipDefaultLibCheck",
               "skipLibCheck"
@@ -2061,13 +2122,13 @@ async function vue(options = {}) {
       rules: {
         ...pluginVue.configs.base.rules,
         ...vueVersion === "2" ? {
-          ...pluginVue.configs.essential.rules,
-          ...pluginVue.configs["strongly-recommended"].rules,
-          ...pluginVue.configs.recommended.rules
+          ...pluginVue.configs["vue2-essential"].rules,
+          ...pluginVue.configs["vue2-strongly-recommended"].rules,
+          ...pluginVue.configs["vue2-recommended"].rules
         } : {
-          ...pluginVue.configs["vue3-essential"].rules,
-          ...pluginVue.configs["vue3-strongly-recommended"].rules,
-          ...pluginVue.configs["vue3-recommended"].rules
+          ...pluginVue.configs["flat/essential"].map((c) => c.rules).reduce((acc, c) => ({ ...acc, ...c }), {}),
+          ...pluginVue.configs["flat/strongly-recommended"].map((c) => c.rules).reduce((acc, c) => ({ ...acc, ...c }), {}),
+          ...pluginVue.configs["flat/recommended"].map((c) => c.rules).reduce((acc, c) => ({ ...acc, ...c }), {})
         },
         "antfu/no-top-level-await": "off",
         "node/prefer-global/process": "off",
@@ -2234,6 +2295,41 @@ async function yaml(options = {}) {
         } : {},
         ...overrides
       }
+    },
+    {
+      files: ["pnpm-workspace.yaml"],
+      name: "eslint/yaml/pnpm-workspace",
+      rules: {
+        "yaml/sort-keys": [
+          "error",
+          {
+            order: [
+              "packages",
+              "overrides",
+              "patchedDependencies",
+              "hoistPattern",
+              "catalog",
+              "catalogs",
+              "allowedDeprecatedVersions",
+              "allowNonAppliedPatches",
+              "configDependencies",
+              "ignoredBuiltDependencies",
+              "ignoredOptionalDependencies",
+              "neverBuiltDependencies",
+              "onlyBuiltDependencies",
+              "onlyBuiltDependenciesFile",
+              "packageExtensions",
+              "peerDependencyRules",
+              "supportedArchitectures"
+            ],
+            pathPattern: "^$"
+          },
+          {
+            order: { type: "asc" },
+            pathPattern: ".*"
+          }
+        ]
+      }
     }
   ];
 }
@@ -2274,6 +2370,7 @@ function lincy(options = {}, ...userConfigs) {
     ignores: ignoresList = [],
     jsx: enableJsx = true,
     overrides = {},
+    pnpm: enableCatalogs = false,
     react: enableReact = false,
     regexp: enableRegexp = true,
     typescript: enableTypeScript = (0, import_local_pkg4.isPackageExists)("typescript"),
@@ -2409,6 +2506,11 @@ function lincy(options = {}, ...userConfigs) {
       sortTsconfig()
     );
   }
+  if (enableCatalogs) {
+    configs2.push(
+      pnpm()
+    );
+  }
   if (options.yaml ?? true) {
     configs2.push(yaml({
       ...resolveSubOptions(options, "yaml"),
@@ -2537,6 +2639,7 @@ var index_default = lincy;
   node,
   parserPlain,
   perfectionist,
+  pnpm,
   react,
   regexp,
   renamePluginInConfigs,