fix(imports): generate d.ts file for eslint auto imports

Author: unrevised6419

packages/wxt/src/builtin-modules/unimport.ts

@@ -1,10 +1,12 @@
 import { addViteConfig, defineWxtModule } from '../modules';
 import type {
   EslintGlobalsPropValue,
+  ResolvedEslintrc8,
+  ResolvedEslintrc9,
+  ResolvedEslintrcEnabled,
   Wxt,
   WxtDirFileEntry,
   WxtModule,
-  WxtResolvedUnimportOptions,
 } from '../types';
 import { type Unimport, createUnimport, toExports } from 'unimport';
 import UnimportPlugin from 'unimport/unplugin';
@@ -52,13 +54,12 @@ export default defineWxtModule({
       if (wxt.config.imports.eslintrc.enabled === false) return;
 
       // Only generate ESLint config if that feature is enabled
-      entries.push(
-        await getEslintConfigEntry(
-          unimport,
-          wxt.config.imports.eslintrc.enabled,
-          wxt.config.imports,
-        ),
+      const eslintConfigEntries = await getEslintConfigEntries(
+        unimport,
+        wxt.config.imports.eslintrc,
       );
+
+      entries.push(...eslintConfigEntries);
     });
 
     // Add vite plugin
@@ -101,40 +102,42 @@ async function getImportsModuleEntry(
   };
 }
 
-async function getEslintConfigEntry(
+async function getEslintConfigEntries(
   unimport: Unimport,
-  version: 8 | 9,
-  options: WxtResolvedUnimportOptions,
-): Promise<WxtDirFileEntry> {
+  eslintrc: ResolvedEslintrcEnabled,
+): Promise<WxtDirFileEntry[]> {
   const globals = (await unimport.getImports())
     .map((i) => i.as ?? i.name)
     .filter(Boolean)
     .sort()
     .reduce<Record<string, EslintGlobalsPropValue>>((globals, name) => {
-      globals[name] = options.eslintrc.globalsPropValue;
+      globals[name] = eslintrc.globalsPropValue;
       return globals;
     }, {});
 
-  if (version <= 8) return getEslint8ConfigEntry(options, globals);
-  else return getEslint9ConfigEntry(options, globals);
+  if (eslintrc.enabled === 9) {
+    return getEslint9ConfigEntry(eslintrc, globals);
+  } else {
+    return [getEslint8ConfigEntry(eslintrc, globals)];
+  }
 }
 
 export function getEslint8ConfigEntry(
-  options: WxtResolvedUnimportOptions,
+  eslintrc: ResolvedEslintrc8,
   globals: Record<string, EslintGlobalsPropValue>,
 ): WxtDirFileEntry {
   return {
-    path: options.eslintrc.filePath,
+    path: eslintrc.filePath,
     text: JSON.stringify({ globals }, null, 2) + '\n',
   };
 }
 
 export function getEslint9ConfigEntry(
-  options: WxtResolvedUnimportOptions,
+  eslintrc: ResolvedEslintrc9,
   globals: Record<string, EslintGlobalsPropValue>,
-): WxtDirFileEntry {
-  return {
-    path: options.eslintrc.filePath,
+): WxtDirFileEntry[] {
+  const jsFileEntry: WxtDirFileEntry = {
+    path: eslintrc.filePath,
     text: `const globals = ${JSON.stringify(globals, null, 2)}
 
 export default {
@@ -147,4 +150,14 @@ export default {
 };
 `,
   };
+
+  const tsFileEntry: WxtDirFileEntry = {
+    path: eslintrc.definitionPath,
+    text: `import type { ConfigObject } from "@eslint/core";
+declare const config: ConfigObject;
+export default config;
+`,
+  };
+
+  return [jsFileEntry, tsFileEntry];
 }

packages/wxt/src/core/resolve-config.ts

@@ -522,12 +522,27 @@ async function getUnimportEslintOptions(
       enabled = inlineEnabled;
   }
 
+  if (enabled === false) {
+    return { enabled: false };
+  }
+
+  const filePath = path.resolve(
+    wxtDir,
+    enabled === 9 ? 'eslint-auto-imports.mjs' : 'eslintrc-auto-import.json',
+  );
+
+  if (enabled === 9) {
+    return {
+      enabled: 9,
+      filePath,
+      globalsPropValue: true,
+      definitionPath: path.resolve(wxtDir, 'eslint-auto-imports.d.mts'),
+    };
+  }
+
   return {
     enabled,
-    filePath: path.resolve(
-      wxtDir,
-      enabled === 9 ? 'eslint-auto-imports.mjs' : 'eslintrc-auto-import.json',
-    ),
+    filePath,
     globalsPropValue: true,
   };
 }

packages/wxt/src/core/utils/testing/fake-objects.ts

@@ -248,6 +248,7 @@ export const fakeResolvedConfig = fakeObjectCreator<ResolvedConfig>(() => {
       eslintrc: {
         enabled: faker.helpers.arrayElement([false, 8, 9]),
         filePath: fakeFile(),
+        definitionPath: fakeFile(),
         globalsPropValue: faker.helpers.arrayElement([
           true,
           false,

packages/wxt/src/types.ts

@@ -1448,14 +1448,31 @@ export interface Eslintrc {
   globalsPropValue?: EslintGlobalsPropValue;
 }
 
-export interface ResolvedEslintrc {
-  /** False if disabled, otherwise the major version of ESLint installed */
-  enabled: false | 8 | 9;
+interface ResolvedEslintrcBase {
   /** Absolute path */
   filePath: string;
   globalsPropValue: EslintGlobalsPropValue;
 }
 
+export interface ResolvedEslintrc8 extends ResolvedEslintrcBase {
+  enabled: 8;
+}
+
+export interface ResolvedEslintrc9 extends ResolvedEslintrcBase {
+  enabled: 9;
+  definitionPath: string;
+}
+
+interface ResolvedEslintrcDisabled {
+  /** False if disabled, otherwise the major version of ESLint installed */
+  enabled: false;
+}
+
+export type ResolvedEslintrcEnabled = ResolvedEslintrc8 | ResolvedEslintrc9;
+export type ResolvedEslintrc =
+  | ResolvedEslintrcDisabled
+  | ResolvedEslintrcEnabled;
+
 export type WxtUnimportOptions = Partial<UnimportOptions> & {
   /**
    * When using ESLint, auto-imported variables are linted as "undeclared