feat: migrate @nuxtjs/eslint-module

Co-authored-by: ricardogobbosouza <[email protected]>

Author: antfu

packages/module/package.json

@@ -39,9 +39,11 @@
     "@nuxt/eslint-plugin": "workspace:*",
     "@nuxt/kit": "^3.10.3",
     "eslint-flat-config-viewer": "^0.1.11",
+    "eslint-webpack-plugin": "^4.1.0",
     "get-port-please": "^3.1.2",
     "pathe": "^1.1.2",
-    "unimport": "^3.7.1"
+    "unimport": "^3.7.1",
+    "vite-plugin-eslint": "^1.8.1"
   },
   "devDependencies": {
     "@nuxt/module-builder": "^0.5.5",

packages/module/src/module.ts

@@ -1,6 +1,5 @@
 import { defineNuxtModule } from '@nuxt/kit'
 import { setupConfigGen } from './modules/config'
-import { setupESLintChecker } from './modules/checker'
 import { ModuleOptions } from './types'
 
 export * from './types'
@@ -14,12 +13,15 @@ export default defineNuxtModule<ModuleOptions>({
     config: true,
     checker: false,
   },
-  setup(options, nuxt) {
+  async setup(options, nuxt) {
     if (options.config) {
       setupConfigGen(options, nuxt)
     }
     if (options.checker) {
-      setupESLintChecker(options, nuxt)
+      await import('./modules/checker')
+        .then(({ setupESLintChecker }) => {
+          setupESLintChecker(options, nuxt)
+        })
     }
   },
 })

packages/module/src/modules/checker.ts

@@ -1,7 +1,67 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 import { Nuxt } from '@nuxt/schema'
-import { ModuleOptions } from '../module'
+import { CheckerOptions, ModuleOptions } from '../module'
+import { defineNuxtModule, addVitePlugin, addWebpackPlugin, useLogger } from '@nuxt/kit'
+import vitePluginEslint from 'vite-plugin-eslint'
+import EslintWebpackPlugin from 'eslint-webpack-plugin'
+import { relative } from 'pathe'
+import { watch } from 'chokidar'
 
-export function setupESLintChecker(options: ModuleOptions, nuxt: Nuxt) {
-  throw new Error('ESLint check is not implemented yet')
+const logger = useLogger('nuxt:eslint:checker')
+
+export function setupESLintChecker(moduleOptions: ModuleOptions, nuxt: Nuxt) {
+  // TODO: maybe support build mode later on
+  if (!nuxt.options.dev) {
+    return
+  }
+
+  const options: CheckerOptions = {
+    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,
+    failOnWarning: false,
+    failOnError: false,
+    ...(typeof moduleOptions.checker === 'boolean' ? {} : moduleOptions.checker || {}),
+  }
+
+  const configPaths = [
+    '.eslintignore',
+    '.eslintrc',
+    '.eslintrc.js',
+    '.eslintrc.yaml',
+    '.eslintrc.yml',
+    '.eslintrc.json',
+  ].map(path => relative(nuxt.options.rootDir, path))
+
+  if (nuxt.options.watch) {
+    nuxt.options.watch.push(...configPaths)
+  }
+  else {
+    const watcher = watch(configPaths, { depth: 0 }).on('change', (path: string) => {
+      logger.info(`Eslint config changed: ${path}`)
+      logger.warn('Please restart the Nuxt server to apply changes or upgrade to latest Nuxt for automatic restart.')
+    })
+    nuxt.hook('close', () => watcher.close())
+  }
+
+  addVitePlugin(() => vitePluginEslint(options), { server: false })
+
+  addWebpackPlugin(() => {
+    const webpackOptions = {
+      ...options,
+      context: nuxt.options.srcDir,
+      files: options.include,
+      lintDirtyModulesOnly: !options.lintOnStart,
+    }
+
+    delete webpackOptions.include
+    delete webpackOptions.lintOnStart
+
+    return new EslintWebpackPlugin(webpackOptions)
+  }, { server: false })
 }

packages/module/src/types.ts

@@ -1,4 +1,6 @@
 import { Import } from 'unimport'
+import type { Options as ViteCheckerOptions } from 'vite-plugin-eslint'
+import type { Options as WebpackCheckerOptions } from 'eslint-webpack-plugin'
 
 export interface ConfigGenOptions {
   /**
@@ -11,7 +13,7 @@ export interface ConfigGenOptions {
   standalone?: boolean
 }
 
-export interface CheckerOptions {
+export interface CheckerOptions extends ViteCheckerOptions, WebpackCheckerOptions {
   /**
    * Checking matched files on start
    */