@lincy/eslint-config 5.7.1 → 5.8.1

package/README.md

@@ -283,50 +283,29 @@ export default lincy({
      * 覆盖规则
      */
     overrides: {
+        comments: {
+            // comments 规则
+        },
         ignores: [
             // 忽略的路径/文件
         ],
+        imports: {
+            // imports 规则
+        },
         javascript: {
             // javascript 规则
         },
-        typescript: {
-            // typescript 规则
-        },
-        stylistic: {
-            // stylistic 规则
-        },
-        test: {
-            // test 规则
-        },
-        vue: {
-            // vue 规则
-        },
-        react: {
-            // react 规则
+        jsdoc: {
+            // jsdoc 规则
         },
         jsonc: {
             // jsonc 规则
         },
-        yaml: {
-            // yaml 规则
-        },
-        toml: {
-            // toml 规则
-        },
         markdown: {
             // markdown 规则
         },
-        unocss: {
-            // unocss 规则
-        },
-        comments: {
-            // comments 规则
-        },
-        imports: {
-            // imports 规则
-        },
-        jsdoc: {
-            // jsdoc 规则
+        nextjs: {
+            // nextjs 规则
         },
         node: {
             // node 规则
@@ -334,15 +313,36 @@ export default lincy({
         perfectionist: {
             // perfectionist 规则
         },
-        sort: {
-            // sort 规则
+        react: {
+            // react 规则
+        },
+        regexp: {
+            // regexp 规则
+        },
+        stylistic: {
+            // stylistic 规则
+        },
+        test: {
+            // test 规则
+        },
+        toml: {
+            // toml 规则
+        },
+        typescript: {
+            // typescript 规则
         },
         unicorn: {
             // unicorn 规则
         },
-        regexp: {
-            // regexp 规则
-        }
+        unocss: {
+            // unocss 规则
+        },
+        vue: {
+            // vue 规则
+        },
+        yaml: {
+            // yaml 规则
+        },
     },
 
     // 工厂函数第一个参数默认为各规则的开关, 但是也可以作为追加规则使用, 当包含以下键名将会自动整合到一个规则里
@@ -463,13 +463,14 @@ export default combine(
 
 由于扁平化配置支持显式提供了插件名称，因此我们重命名了一些插件以使它们更加一致并隐藏实现细节。
 
-| New Prefix | Original Prefix        | Source Plugin                                                                              |
-| ---------- | ---------------------- | ------------------------------------------------------------------------------------------ |
-| `import/*` | `import-lite/*`        | [eslint-plugin-import-lite](https://github.com/9romise/eslint-plugin-import-lite)          |
-| `node/*`   | `n/*`                  | [eslint-plugin-n](https://github.com/eslint-community/eslint-plugin-n)                     |
-| `yaml/*`   | `yml/*`                | [eslint-plugin-yml](https://github.com/ota-meshi/eslint-plugin-yml)                        |
-| `ts/*`     | `@typescript-eslint/*` | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) |
-| `style/*`  | `@stylistic/*`         | [@stylistic/eslint-plugin](https://github.com/eslint-stylistic/eslint-stylistic)           |
+| New Prefix | Original Prefix        | Source Plugin                                                                                         |
+| ---------- | ---------------------- | ----------------------------------------------------------------------------------------------------- |
+| `import/*` | `import-lite/*`        | [eslint-plugin-import-lite](https://github.com/9romise/eslint-plugin-import-lite)                     |
+| `node/*`   | `n/*`                  | [eslint-plugin-n](https://github.com/eslint-community/eslint-plugin-n)                                |
+| `yaml/*`   | `yml/*`                | [eslint-plugin-yml](https://github.com/ota-meshi/eslint-plugin-yml)                                   |
+| `ts/*`     | `@typescript-eslint/*` | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint)            |
+| `style/*`  | `@stylistic/*`         | [@stylistic/eslint-plugin](https://github.com/eslint-stylistic/eslint-stylistic)                      |
+| `next/*`   | `@next/next`           | [@next/eslint-plugin-next](https://github.com/vercel/next.js/tree/canary/packages/eslint-plugin-next) |
 
 当您想要覆盖规则或内联禁用它们时，您需要更新到新的前缀：
 
@@ -573,7 +574,7 @@ export default lincy({
 
 使用外部格式化程序来格式化 ESLint 无法处理的文件（.css、.html 等）。 由 [eslint-plugin-format](https://github.com/antfu/eslint-plugin-format) 提供支持
 
-```js
+```ts
 // eslint.config.js
 import lincy from '@lincy/eslint-config'
 
@@ -626,12 +627,40 @@ pnpm add eslint-plugin-format -D
 
 当检测到依赖安装了`react`, 则默认开启
 
+```ts
+// eslint.config.js
+import lincy from '@lincy/eslint-config'
+
+export default lincy({
+    react: true
+})
+```
+
 运行“npx eslint”会提示您安装所需的依赖项，当然，也可以手动安装它们：
 
 ```bash
 pnpm i -D @eslint-react/eslint-plugin eslint-plugin-react-hooks eslint-plugin-react-refresh
 ```
 
+#### Next.js
+
+要启用 nextjs 支持，需要显式打开它
+
+```ts
+// eslint.config.js
+import lincy from '@lincy/eslint-config'
+
+export default lincy({
+    nextjs: true
+})
+```
+
+运行“npx eslint”会提示您安装所需的依赖项，当然，也可以手动安装它们：
+
+```bash
+pnpm i -D @next/eslint-plugin-next
+```
+
 #### UnoCSS
 
 要启用 UnoCSS 支持，需要显式打开它

package/dist/index.cjs

@@ -882,6 +882,34 @@ async function markdown(options = {}) {
 	];
 }
 
+//#endregion
+//#region src/configs/nextjs.ts
+function normalizeRules(rules) {
+	return Object.fromEntries(Object.entries(rules).map(([key, value]) => [key, typeof value === "string" ? [value] : value]));
+}
+async function nextjs(options = {}) {
+	const { files = [GLOB_SRC], overrides = {} } = options;
+	await ensurePackages(["@next/eslint-plugin-next"]);
+	const pluginNextJS = await interopDefault(import("@next/eslint-plugin-next"));
+	return [{
+		name: "eslint/nextjs/setup",
+		plugins: { next: pluginNextJS }
+	}, {
+		files,
+		languageOptions: {
+			parserOptions: { ecmaFeatures: { jsx: true } },
+			sourceType: "module"
+		},
+		name: "eslint/nextjs/rules",
+		rules: {
+			...normalizeRules(pluginNextJS.configs.recommended.rules),
+			...normalizeRules(pluginNextJS.configs["core-web-vitals"].rules),
+			...overrides
+		},
+		settings: { react: { version: "detect" } }
+	}];
+}
+
 //#endregion
 //#region src/configs/node.ts
 async function node(options = {}) {
@@ -1613,11 +1641,12 @@ async function typescript(options = {}) {
 //#endregion
 //#region src/configs/unicorn.ts
 async function unicorn(options = {}) {
+	const { allRecommended = false, overrides = {} } = options;
 	return [{
 		name: "eslint/unicorn/rules",
 		plugins: { unicorn: eslint_plugin_unicorn.default },
 		rules: {
-			...options.allRecommended ? eslint_plugin_unicorn.default.configs["flat/recommended"].rules : {
+			...allRecommended ? eslint_plugin_unicorn.default.configs.recommended.rules : {
 				"unicorn/consistent-empty-array-spread": "error",
 				"unicorn/error-message": "error",
 				"unicorn/escape-case": "error",
@@ -1634,7 +1663,7 @@ async function unicorn(options = {}) {
 				"unicorn/prefer-type-error": "error",
 				"unicorn/throw-new-error": "error"
 			},
-			...options.overrides
+			...overrides
 		}
 	}];
 }
@@ -1969,6 +1998,7 @@ const defaultPluginRenaming = {
 	"@eslint-react/dom": "react-dom",
 	"@eslint-react/hooks-extra": "react-hooks-extra",
 	"@eslint-react/naming-convention": "react-naming-convention",
+	"@next/next": "next",
 	"@stylistic": "style",
 	"@typescript-eslint": "ts",
 	"import-lite": "import",
@@ -1987,7 +2017,7 @@ const defaultPluginRenaming = {
 *  合并的 ESLint 配置
 */
 function lincy(options = {}, ...userConfigs) {
-	const { autoRenamePlugins = true, componentExts = [], gitignore: enableGitignore = true, ignores: ignoresList = [], imports: enableImports = true, jsx: enableJsx = true, overrides = {}, pnpm: enableCatalogs = false, react: enableReact = false, regexp: enableRegexp = true, typescript: enableTypeScript = (0, local_pkg.isPackageExists)("typescript"), unicorn: enableUnicorn = true, unocss: enableUnoCSS = false, vue: enableVue = VuePackages.some((i) => (0, local_pkg.isPackageExists)(i)) } = options;
+	const { autoRenamePlugins = true, componentExts = [], gitignore: enableGitignore = true, ignores: ignoresList = [], imports: enableImports = true, jsx: enableJsx = true, nextjs: enableNextjs = false, overrides = {}, pnpm: enableCatalogs = false, react: enableReact = false, regexp: enableRegexp = true, typescript: enableTypeScript = (0, local_pkg.isPackageExists)("typescript"), unicorn: enableUnicorn = true, unocss: enableUnoCSS = false, vue: enableVue = VuePackages.some((i) => (0, local_pkg.isPackageExists)(i)) } = options;
 	let isInEditor = options.isInEditor;
 	if (isInEditor == null) {
 		isInEditor = isInEditorEnv();
@@ -2009,19 +2039,16 @@ function lincy(options = {}, ...userConfigs) {
 	configs$1.push(ignores({ ignores: [...overrides.ignores || [], ...ignoresList] }), javascript({
 		isInEditor,
 		overrides: getOverrides(options, "javascript")
-	}), comments({ overrides: overrides.comments }), node({ overrides: overrides.node }), jsdoc({
-		overrides: overrides.jsdoc,
-		stylistic: stylisticOptions
-	}), imports({
-		overrides: overrides.imports,
+	}), comments({ overrides: getOverrides(options, "comments") }), node({ overrides: getOverrides(options, "node") }), jsdoc({
+		overrides: getOverrides(options, "jsdoc"),
 		stylistic: stylisticOptions
-	}), perfectionist({ overrides: overrides.perfectionist }));
+	}), perfectionist({ overrides: getOverrides(options, "perfectionist") }));
 	if (enableUnicorn) configs$1.push(unicorn({
 		...enableUnicorn === true ? {} : enableUnicorn,
-		overrides: overrides.unicorn
+		overrides: getOverrides(options, "unicorn")
 	}));
 	if (enableImports) configs$1.push(imports({
-		overrides: overrides.imports,
+		overrides: getOverrides(options, "imports"),
 		stylistic: stylisticOptions
 	}));
 	if (enableVue) componentExts.push("vue");
@@ -2058,6 +2085,7 @@ function lincy(options = {}, ...userConfigs) {
 		overrides: getOverrides(options, "react"),
 		tsconfigPath
 	}));
+	if (enableNextjs) configs$1.push(nextjs({ overrides: getOverrides(options, "nextjs") }));
 	if (enableUnoCSS) configs$1.push(unocss({
 		...resolveSubOptions(options, "unocss"),
 		overrides: getOverrides(options, "unocss")
@@ -2165,6 +2193,7 @@ exports.jsonc = jsonc;
 exports.jsx = jsx;
 exports.lincy = lincy;
 exports.markdown = markdown;
+exports.nextjs = nextjs;
 exports.node = node;
 exports.parserPlain = parserPlain;
 exports.perfectionist = perfectionist;