feat: add Next.js support (#731)

Peek-A-Booo · web-flow · commit 8f9b45cb1b02 · 2025-07-24T15:43:24.000+09:00
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@
 - Designed to work with TypeScript, JSX, Vue, JSON, YAML, Toml, Markdown, etc. Out-of-box.
 - Opinionated, but [very customizable](#customization)
 - [ESLint Flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new), compose easily!
-- Optional [React](#react), [Svelte](#svelte), [UnoCSS](#unocss), [Astro](#astro), [Solid](#solid) support
+- Optional [React](#react), [Next.js](#nextjs), [Svelte](#svelte), [UnoCSS](#unocss), [Astro](#astro), [Solid](#solid) support
 - Optional [formatters](#formatters) support for formatting CSS, HTML, XML, etc.
 - **Style principle**: Minimal for reading, stable for diff, consistent
   - Sorted imports, dangling commas
@@ -623,6 +623,25 @@ Running `npx eslint` should prompt you to install the required dependencies, oth
 npm i -D @eslint-react/eslint-plugin eslint-plugin-react-hooks eslint-plugin-react-refresh
 ```
 
+#### Next.js
+
+To enable Next.js support, you need to explicitly turn it on:
+
+```js
+// eslint.config.js
+import antfu from '@antfu/eslint-config'
+
+export default antfu({
+  nextjs: true,
+})
+```
+
+Running `npx eslint` should prompt you to install the required dependencies, otherwise, you can install them manually:
+
+```bash
+npm i -D @next/eslint-plugin-next
+```
+
 #### Svelte
 
 To enable svelte support, you need to explicitly turn it on:
diff --git a/eslint.config.ts b/eslint.config.ts
@@ -9,6 +9,7 @@ export default antfu(
     solid: true,
     svelte: true,
     astro: true,
+    nextjs: true,
     typescript: true,
     formatters: true,
     pnpm: true,
diff --git a/package.json b/package.json
@@ -44,6 +44,7 @@
   },
   "peerDependencies": {
     "@eslint-react/eslint-plugin": "^1.38.4",
+    "@next/eslint-plugin-next": "^15.4.0-canary.115",
     "@prettier/plugin-xml": "^3.4.1",
     "@unocss/eslint-plugin": ">=0.50.0",
     "astro-eslint-parser": "^1.0.2",
@@ -63,6 +64,9 @@
     "@eslint-react/eslint-plugin": {
       "optional": true
     },
+    "@next/eslint-plugin-next": {
+      "optional": true
+    },
     "@prettier/plugin-xml": {
       "optional": true
     },
@@ -146,6 +150,7 @@
     "@antfu/ni": "catalog:dev",
     "@eslint-react/eslint-plugin": "catalog:peer",
     "@eslint/config-inspector": "catalog:dev",
+    "@next/eslint-plugin-next": "catalog:peer",
     "@prettier/plugin-xml": "catalog:peer",
     "@types/node": "catalog:dev",
     "@unocss/eslint-plugin": "catalog:peer",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml
@@ -25,6 +25,7 @@ catalogs:
     vitest: ^3.2.4
   peer:
     '@eslint-react/eslint-plugin': ^1.52.3
+    '@next/eslint-plugin-next': ^15.4.0-canary.115
     '@prettier/plugin-xml': ^3.4.2
     '@unocss/eslint-plugin': ^66.3.3
     astro-eslint-parser: ^1.2.2
diff --git a/scripts/typegen.ts b/scripts/typegen.ts
@@ -3,7 +3,7 @@ import fs from 'node:fs/promises'
 import { flatConfigsToRulesDTS } from 'eslint-typegen/core'
 import { builtinRules } from 'eslint/use-at-your-own-risk'
 
-import { astro, combine, comments, formatters, imports, javascript, jsdoc, jsonc, jsx, markdown, node, perfectionist, react, regexp, solid, sortPackageJson, stylistic, svelte, test, toml, typescript, unicorn, unocss, vue, yaml } from '../src'
+import { astro, combine, comments, formatters, imports, javascript, jsdoc, jsonc, jsx, markdown, nextjs, node, perfectionist, react, regexp, solid, sortPackageJson, stylistic, svelte, test, toml, typescript, unicorn, unocss, vue, yaml } from '../src'
 
 const configs = await combine(
   {
@@ -24,6 +24,7 @@ const configs = await combine(
   markdown(),
   node(),
   perfectionist(),
+  nextjs(),
   react(),
   solid(),
   sortPackageJson(),
diff --git a/src/cli/constants-generated.ts b/src/cli/constants-generated.ts
@@ -1,5 +1,6 @@
 export const versionsMap = {
   "@eslint-react/eslint-plugin": "^1.52.3",
+  "@next/eslint-plugin-next": "^15.4.0-canary.115",
   "@unocss/eslint-plugin": "^66.3.3",
   "astro-eslint-parser": "^1.2.2",
   "eslint": "^9.31.0",
diff --git a/src/cli/constants.ts b/src/cli/constants.ts
@@ -108,6 +108,9 @@ export const dependenciesMap = {
   formatterAstro: [
     'prettier-plugin-astro',
   ],
+  nextjs: [
+    '@next/eslint-plugin-next',
+  ],
   react: [
     '@eslint-react/eslint-plugin',
     'eslint-plugin-react-hooks',
diff --git a/src/configs/index.ts b/src/configs/index.ts
@@ -10,6 +10,7 @@ export * from './jsdoc'
 export * from './jsonc'
 export * from './jsx'
 export * from './markdown'
+export * from './nextjs'
 export * from './node'
 export * from './perfectionist'
 export * from './pnpm'
diff --git a/src/configs/nextjs.ts b/src/configs/nextjs.ts
@@ -0,0 +1,58 @@
+import type { OptionsFiles, OptionsOverrides, TypedFlatConfigItem } from '../types'
+import { GLOB_SRC } from '../globs'
+import { ensurePackages, interopDefault } from '../utils'
+
+function normalizeRules(rules: Record<string, any>): Record<string, any> {
+  return Object.fromEntries(
+    Object.entries(rules).map(([key, value]) =>
+      [key, typeof value === 'string' ? [value] : value],
+    ),
+  )
+}
+
+export async function nextjs(
+  options: OptionsOverrides & OptionsFiles = {},
+): Promise<TypedFlatConfigItem[]> {
+  const {
+    files = [GLOB_SRC],
+    overrides = {},
+  } = options
+
+  await ensurePackages([
+    '@next/eslint-plugin-next',
+  ])
+
+  const pluginNextJS = await interopDefault(import('@next/eslint-plugin-next'))
+
+  return [
+    {
+      name: 'antfu/nextjs/setup',
+      plugins: {
+        '@next/next': pluginNextJS,
+      },
+    },
+    {
+      files,
+      languageOptions: {
+        parserOptions: {
+          ecmaFeatures: {
+            jsx: true,
+          },
+        },
+        sourceType: 'module',
+      },
+      rules: {
+        ...normalizeRules(pluginNextJS.configs.recommended.rules),
+        ...normalizeRules(pluginNextJS.configs['core-web-vitals'].rules),
+
+        // overrides
+        ...overrides,
+      },
+      settings: {
+        react: {
+          version: 'detect',
+        },
+      },
+    },
+  ]
+}
diff --git a/src/factory.ts b/src/factory.ts
@@ -16,6 +16,7 @@ import {
   jsonc,
   jsx,
   markdown,
+  nextjs,
   node,
   perfectionist,
   pnpm,
@@ -89,6 +90,7 @@ export function antfu(
     gitignore: enableGitignore = true,
     imports: enableImports = true,
     jsx: enableJsx = true,
+    nextjs: enableNextjs = false,
     pnpm: enableCatalogs = false, // TODO: smart detect
     react: enableReact = false,
     regexp: enableRegexp = true,
@@ -228,6 +230,12 @@ export function antfu(
     }))
   }
 
+  if (enableNextjs) {
+    configs.push(nextjs({
+      overrides: getOverrides(options, 'nextjs'),
+    }))
+  }
+
   if (enableSolid) {
     configs.push(solid({
       overrides: getOverrides(options, 'solid'),
diff --git a/src/types.ts b/src/types.ts
@@ -380,6 +380,17 @@ export interface OptionsConfig extends OptionsComponentExts, OptionsProjectType
    * @default false
    */
   react?: boolean | OptionsOverrides
+
+  /**
+   * Enable nextjs rules.
+   *
+   * Requires installing:
+   * - `@next/eslint-plugin-next`
+   *
+   * @default false
+   */
+  nextjs?: boolean | OptionsOverrides
+
   /**
    * Enable solid rules.
    *
