feat: use vite-plugin-eslint2, support checker for flat config

Thanks to nuxt-modules/eslint#124
Co-authored-by: ModyQyW <[email protected]>

Author: antfu

packages/module/package.json

@@ -43,7 +43,7 @@
     "get-port-please": "^3.1.2",
     "pathe": "^1.1.2",
     "unimport": "^3.7.1",
-    "vite-plugin-eslint": "^1.8.1"
+    "vite-plugin-eslint2": "^4.4.0"
   },
   "devDependencies": {
     "@nuxt/module-builder": "^0.5.5",

packages/module/src/modules/checker.ts

@@ -1,14 +1,21 @@
-/* eslint-disable @typescript-eslint/no-unused-vars */
 import { Nuxt } from '@nuxt/schema'
 import { CheckerOptions, ModuleOptions } from '../module'
-import { defineNuxtModule, addVitePlugin, addWebpackPlugin, useLogger } from '@nuxt/kit'
-import vitePluginEslint from 'vite-plugin-eslint'
+import { addVitePlugin, addWebpackPlugin, useLogger } from '@nuxt/kit'
+import vitePluginEslint from 'vite-plugin-eslint2'
 import EslintWebpackPlugin from 'eslint-webpack-plugin'
 import { relative } from 'pathe'
 import { watch } from 'chokidar'
+import { existsSync } from 'fs'
+import { resolve } from 'path'
 
 const logger = useLogger('nuxt:eslint:checker')
 
+const flatConfigFiles = [
+  'eslint.config.js',
+  'eslint.config.mjs',
+  'eslint.config.cjs',
+]
+
 export function setupESLintChecker(moduleOptions: ModuleOptions, nuxt: Nuxt) {
   // TODO: maybe support build mode later on
   if (!nuxt.options.dev) {
@@ -19,8 +26,6 @@ export function setupESLintChecker(moduleOptions: ModuleOptions, nuxt: Nuxt) {
     cache: true,
     include: [`${nuxt.options.srcDir}/**/*.{js,jsx,ts,tsx,vue}`],
     exclude: ['**/node_modules/**', nuxt.options.buildDir],
-    eslintPath: 'eslint',
-    formatter: 'stylish',
     lintOnStart: true,
     emitWarning: true,
     emitError: true,
@@ -29,13 +34,16 @@ export function setupESLintChecker(moduleOptions: ModuleOptions, nuxt: Nuxt) {
     ...(typeof moduleOptions.checker === 'boolean' ? {} : moduleOptions.checker || {}),
   }
 
+  const isUsingFlatConfig = process.env.ESLINT_USE_FLAT_CONFIG || flatConfigFiles.some(file => existsSync(resolve(nuxt.options.rootDir, file)))
+
   const configPaths = [
     '.eslintignore',
     '.eslintrc',
     '.eslintrc.js',
     '.eslintrc.yaml',
     '.eslintrc.yml',
     '.eslintrc.json',
+    ...flatConfigFiles,
   ].map(path => relative(nuxt.options.rootDir, path))
 
   if (nuxt.options.watch) {
@@ -49,7 +57,18 @@ export function setupESLintChecker(moduleOptions: ModuleOptions, nuxt: Nuxt) {
     nuxt.hook('close', () => watcher.close())
   }
 
-  addVitePlugin(() => vitePluginEslint(options), { server: false })
+  addVitePlugin(() => {
+    const viteOptions = {
+      linkInWorker: true,
+      ...options,
+      ...options.vite,
+    }
+
+    // https://github.com/ModyQyW/vite-plugin-eslint2#eslintpath
+    viteOptions.eslintPath ||= isUsingFlatConfig ? 'eslint/use-at-your-own-risk' : 'eslint'
+
+    return vitePluginEslint(viteOptions)
+  }, { server: false })
 
   addWebpackPlugin(() => {
     const webpackOptions = {

packages/module/src/types.ts

@@ -1,5 +1,5 @@
 import { Import } from 'unimport'
-import type { Options as ViteCheckerOptions } from 'vite-plugin-eslint'
+import type { ESLintPluginOptions as ViteCheckerOptions } from 'vite-plugin-eslint2'
 import type { Options as WebpackCheckerOptions } from 'eslint-webpack-plugin'
 
 export interface ConfigGenOptions {
@@ -13,9 +13,35 @@ export interface ConfigGenOptions {
   standalone?: boolean
 }
 
-export interface CheckerOptions extends ViteCheckerOptions, WebpackCheckerOptions {
+export interface CheckerOptions {
   /**
-   * Checking matched files on start
+   * Use ESLint cache to improve performance
+   *
+   * @default true
+   */
+  cache?: boolean
+
+  /**
+   * Files to include for linting
+   */
+  include?: string[]
+
+  /**
+   * Files to exclude from linting
+   */
+  exclude?: string[]
+
+  /**
+   * ESLint formatter for the output
+   *
+   * @see https://eslint.org/docs/user-guide/formatters/
+   */
+  formatter?: string
+
+  /**
+   * Lint on start
+   *
+   * @default true
    */
   lintOnStart?: boolean
 
@@ -46,6 +72,18 @@ export interface CheckerOptions extends ViteCheckerOptions, WebpackCheckerOption
    * @default false
    */
   failOnWarning?: boolean
+
+  /**
+   * Vite specific options
+   */
+  vite?: ViteCheckerOptions
+
+  /**
+   * Webpack specific options
+   *
+   * @see https://www.npmjs.com/package/eslint-webpack-plugin
+   */
+  webpack?: WebpackCheckerOptions
 }
 
 export interface ModuleOptions {