feat(module): support customizable config.configFile, use relative …

…path to resolve, fix #495
nuxt · Sep 4, 2024 · a4ab4f5 · a4ab4f5
1 parent 148537b
commit a4ab4f5
Show file tree

Hide file tree

Showing 7 changed files with 1,587 additions and 1,036 deletions.
diff --git a/docs/pnpm-lock.yaml b/docs/pnpm-lock.yaml
diff --git a/packages/module/src/modules/config/addons/globals.ts b/packages/module/src/modules/config/addons/globals.ts
@@ -1,6 +1,5 @@
 import type { Nuxt } from '@nuxt/schema'
 import type { Unimport } from 'unimport'
-import type { Linter } from 'eslint'
 import type { ESLintConfigGenAddon } from '../../../types'
 
 export function createAddonGlobals(nuxt: Nuxt): ESLintConfigGenAddon {
@@ -21,17 +20,19 @@ export function createAddonGlobals(nuxt: Nuxt): ESLintConfigGenAddon {
       const imports = [
         ...await unimport?.getImports() || [],
         ...await nitroUnimport?.getImports() || [],
-      ]
+      ].sort()
 
       return {
         configs: [
-          '// Set globals from imports registry',
-          JSON.stringify(<Linter.Config>{
-            name: 'nuxt/import-globals',
-            languageOptions: {
-              globals: Object.fromEntries(imports.map(i => [i.as || i.name, 'readonly'])),
-            },
-          }),
+          [
+            '// Set globals from imports registry',
+            '{',
+            `  name: 'nuxt/import-globals',`,
+            '  languageOptions: {',
+            `    globals: Object.fromEntries(${JSON.stringify(imports.map(i => i.as || i.name))}.map(i => [i, 'readonly'])),`,
+            `  },`,
+            '}',
+          ].join('\n'),
         ],
       }
     },

diff --git a/packages/module/src/modules/config/generate.ts b/packages/module/src/modules/config/generate.ts
@@ -1,27 +1,36 @@
 import { builtinModules } from 'node:module'
+import { dirname, join, resolve } from 'node:path'
 import { stringifyImports } from 'unimport'
 import type { Import } from 'unimport'
 import type { Nuxt } from '@nuxt/schema'
 import { relative } from 'pathe'
-import type { NuxtESLintConfigOptions } from '@nuxt/eslint-config/flat'
 import { createResolver } from '@nuxt/kit'
 import type { ESLintConfigGenAddon } from '../../types'
 import type { ConfigGenOptions, ModuleOptions } from '../../module'
 import { getDirs } from './utils'
 
 const r = createResolver(import.meta.url)
 
-export async function generateESLintConfig(options: ModuleOptions, nuxt: Nuxt, addons: ESLintConfigGenAddon[]) {
+export async function generateESLintConfig(
+  options: ModuleOptions,
+  nuxt: Nuxt,
+  addons: ESLintConfigGenAddon[],
+) {
   const importLines: Import[] = []
   const configItems: string[] = []
 
-  const configDir = nuxt.options.buildDir
-
   const config: ConfigGenOptions = {
     standalone: true,
     ...typeof options.config !== 'boolean' ? options.config || {} : {},
   }
 
+  let {
+    configFile = join(nuxt.options.buildDir, 'eslint.config.mjs'),
+  } = config
+
+  configFile = resolve(nuxt.options.rootDir, configFile)
+  const configDir = dirname(configFile)
+
   importLines.push(
     {
       from: 'eslint-typegen',
@@ -40,12 +49,13 @@ export async function generateESLintConfig(options: ModuleOptions, nuxt: Nuxt, a
       from: '@nuxt/eslint-config/flat',
       name: 'resolveOptions',
     },
+    {
+      from: 'url',
+      name: 'fileURLToPath',
+    },
   )
 
-  const basicOptions: NuxtESLintConfigOptions = {
-    features: config,
-    dirs: getDirs(nuxt),
-  }
+  const dirs = getDirs(nuxt) || {}
 
   for (const addon of addons) {
     const resolved = await addon.getConfigs()
@@ -69,15 +79,32 @@ export async function generateESLintConfig(options: ModuleOptions, nuxt: Nuxt, a
     }
   }))
 
-  return [
+  const code = [
     '// ESLint config generated by Nuxt',
     '/// <reference path="./eslint-typegen.d.ts" />',
+    '/* eslint-disable */',
+    '// @ts-nocheck',
     '',
     stringifyImports(imports, false),
     '',
+    'const r = (...args) => fileURLToPath(new URL(...args, import.meta.url))',
+    '',
     'export { defineFlatConfigs }',
     '',
-    `export const options = resolveOptions(${JSON.stringify(basicOptions, null, 2)})`,
+    `export const options = resolveOptions({`,
+    `  features: ${JSON.stringify(config, null, 2)},`,
+    `  dirs: {`,
+    ...Object
+      .entries(dirs)
+      .map(([key, value]) => {
+        return `    ${key}: [${value.map(v =>
+          key === 'root'
+            ? `r(${JSON.stringify(relativeWithDot(v))})`
+            : JSON.stringify(v),
+        ).join(', ')}],`
+      }),
+    `}`,
+    `})`,
     '',
     `export const configs = createConfigForNuxt(options)`,
 
@@ -95,9 +122,14 @@ export async function generateESLintConfig(options: ModuleOptions, nuxt: Nuxt, a
     '  return configs',
     '    .clone()',
     '    .append(...customs)',
-    '    .onResolved(configs => typegen(configs, { dtsPath: new URL("./eslint-typegen.d.ts", import.meta.url), augmentFlatConfigUtils: true }))',
+    '    .onResolved(configs => typegen(configs, { dtsPath: r("./eslint-typegen.d.ts"), augmentFlatConfigUtils: true }))',
     '}',
     '',
     'export default withNuxt',
   ].join('\n')
+
+  return {
+    code,
+    configFile,
+  }
 }
diff --git a/packages/module/src/modules/config/index.ts b/packages/module/src/modules/config/index.ts
@@ -1,3 +1,5 @@
+import { dirname } from 'node:path'
+import fs from 'node:fs/promises'
 import { addTemplate } from '@nuxt/kit'
 import type { Nuxt } from '@nuxt/schema'
 import type { ESLintConfigGenAddon } from '../../types'
@@ -32,17 +34,18 @@ export async function setupConfigGen(options: ModuleOptions, nuxt: Nuxt) {
     declarations.push('/// <reference path="./eslint-typegen.d.ts" />')
   })
 
-  const template = addTemplate({
-    filename: 'eslint.config.mjs',
-    write: true,
-    async getContents() {
-      const addons: ESLintConfigGenAddon[] = [
-        ...defaultAddons,
-      ]
-      await nuxt.callHook('eslint:config:addons', addons)
-      return generateESLintConfig(options, nuxt, addons)
-    },
-  })
+  let _configFile: string = undefined!
+
+  async function writeConfigFile() {
+    const addons: ESLintConfigGenAddon[] = [
+      ...defaultAddons,
+    ]
+    await nuxt.callHook('eslint:config:addons', addons)
+    const { code, configFile } = await generateESLintConfig(options, nuxt, addons)
+    await fs.mkdir(dirname(configFile), { recursive: true })
+    await fs.writeFile(configFile, code, 'utf-8')
+    _configFile = configFile
+  }
 
   addTemplate({
     filename: 'eslint.config.d.mts',
@@ -52,9 +55,14 @@ export async function setupConfigGen(options: ModuleOptions, nuxt: Nuxt) {
     },
   })
 
+  setupDevToolsIntegration(nuxt)
+
+  await writeConfigFile()
+  nuxt.hook('builder:generateApp', () => {
+    writeConfigFile()
+  })
+
   if (autoInit) {
-    await initRootESLintConfig(nuxt, template.dst)
+    await initRootESLintConfig(nuxt, _configFile)
   }
-
-  setupDevToolsIntegration(nuxt)
 }
diff --git a/packages/module/src/types.ts b/packages/module/src/types.ts
@@ -13,6 +13,13 @@ declare module '@nuxt/schema' {
 }
 
 export interface ConfigGenOptions extends NuxtESLintFeaturesOptions {
+  /**
+   * File path to the generated ESLint config
+   *
+   * @default '.nuxt/eslint.config.mjs'
+   */
+  configFile?: string
+
   /**
    * Create `eslint.config.mjs` file automatically if not exists
    *

diff --git a/playground/nuxt.config.ts b/playground/nuxt.config.ts
@@ -14,6 +14,7 @@ export default defineNuxtConfig({
 
   eslint: {
     config: {
+      // configFile: './eslint.nuxt.config.mjs',
       stylistic: true,
     },
     checker: {