feat: divide in legacy/nonlegacy, allows eslint 10

Author: unrevised6419

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

@@ -1,9 +1,8 @@
 import { addViteConfig, defineWxtModule } from '../modules';
 import type {
   EslintGlobalsPropValue,
-  ResolvedEslintrc8,
-  ResolvedEslintrc9,
-  ResolvedEslintrcEnabled,
+  ResolvedEslintrc,
+  ResolvedEslintrcLegacy,
   Wxt,
   WxtDirFileEntry,
   WxtModule,
@@ -51,7 +50,7 @@ export default defineWxtModule({
       // Only create global types when user has enabled auto-imports
       entries.push(await getImportsDeclarationEntry(unimport));
 
-      if (wxt.config.imports.eslintrc.enabled === false) return;
+      if (!wxt.config.imports.eslintrc) return;
 
       // Only generate ESLint config if that feature is enabled
       const eslintConfigEntries = await getEslintConfigEntries(
@@ -104,7 +103,7 @@ async function getImportsModuleEntry(
 
 async function getEslintConfigEntries(
   unimport: Unimport,
-  eslintrc: ResolvedEslintrcEnabled,
+  eslintrc: ResolvedEslintrc | ResolvedEslintrcLegacy,
 ): Promise<WxtDirFileEntry[]> {
   const globals = (await unimport.getImports())
     .map((i) => i.as ?? i.name)
@@ -115,15 +114,15 @@ async function getEslintConfigEntries(
       return globals;
     }, {});
 
-  if (eslintrc.enabled === 9) {
-    return getEslint9ConfigEntry(eslintrc, globals);
+  if (eslintrc.legacy) {
+    return [getEslintLegacyConfigEntry(eslintrc, globals)];
   } else {
-    return [getEslint8ConfigEntry(eslintrc, globals)];
+    return getEslintConfigEntry(eslintrc, globals);
   }
 }
 
-export function getEslint8ConfigEntry(
-  eslintrc: ResolvedEslintrc8,
+export function getEslintLegacyConfigEntry(
+  eslintrc: ResolvedEslintrcLegacy,
   globals: Record<string, EslintGlobalsPropValue>,
 ): WxtDirFileEntry {
   return {
@@ -132,8 +131,8 @@ export function getEslint8ConfigEntry(
   };
 }
 
-export function getEslint9ConfigEntry(
-  eslintrc: ResolvedEslintrc9,
+export function getEslintConfigEntry(
+  eslintrc: ResolvedEslintrc,
   globals: Record<string, EslintGlobalsPropValue>,
 ): WxtDirFileEntry[] {
   const jsFileEntry: WxtDirFileEntry = {

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

@@ -14,6 +14,8 @@ import {
   WxtModule,
   WxtModuleWithMetadata,
   ResolvedEslintrc,
+  ResolvedEslintrcLegacy,
+  Eslintrc,
 } from '../types';
 import path from 'node:path';
 import { createFsCache } from './utils/cache';
@@ -491,54 +493,64 @@ async function getUnimportOptions(
     disabled,
   };
 
-  return defu<WxtResolvedUnimportOptions, [WxtResolvedUnimportOptions]>(
-    config.imports ?? {},
-    defaultOptions,
-  );
+  const importsCopy = {
+    ...(config.imports || {}),
+    eslintrc: undefined,
+  };
+
+  // @ts-expect-error merging objects with different types may create unexpected behavior
+  return defu(importsCopy, defaultOptions);
 }
 
 async function getUnimportEslintOptions(
   wxtDir: string,
   options: InlineConfig['imports'],
-): Promise<ResolvedEslintrc> {
-  const inlineEnabled =
-    options === false ? false : (options?.eslintrc?.enabled ?? 'auto');
-
-  let enabled: ResolvedEslintrc['enabled'];
-  switch (inlineEnabled) {
-    case 'auto':
-      const version = await getEslintVersion();
-      let major = parseInt(version[0]);
-      if (isNaN(major)) enabled = false;
-      if (major <= 8) enabled = 8;
-      else if (major >= 9) enabled = 9;
-      // NaN
-      else enabled = false;
-      break;
-    case true:
-      enabled = 8;
-      break;
-    default:
-      enabled = inlineEnabled;
-  }
+): Promise<ResolvedEslintrc | ResolvedEslintrcLegacy | undefined> {
+  if (options === false) return undefined;
 
-  if (enabled === false) {
-    return { enabled: false };
-  }
+  const enabled = options?.eslintrc?.enabled;
+  if (enabled === false) return undefined;
 
-  if (enabled === 9) {
-    return {
-      enabled: 9,
-      filePath: path.resolve(wxtDir, 'eslint-auto-imports.mjs'),
-      definitionPath: path.resolve(wxtDir, 'eslint-auto-imports.d.mts'),
-      globalsPropValue: true,
-    };
+  const isLegacy = enabled === true || enabled === 8;
+  if (isLegacy) return getEslintLegacyConfig(wxtDir, options.eslintrc);
+  if (enabled === 9) return getEslintConfig(wxtDir, options.eslintrc);
+
+  // Auto-detect ESLint version
+
+  const version = await getEslintVersion();
+  const major = parseInt(version[0]);
+
+  if (Number.isNaN(major)) return undefined;
+
+  if (major >= 9) {
+    return getEslintConfig(wxtDir, options.eslintrc);
+  } else {
+    return getEslintLegacyConfig(wxtDir, options.eslintrc);
   }
+}
 
+function getEslintConfig(
+  wxtDir: string,
+  eslintrc: Eslintrc | undefined,
+): ResolvedEslintrc {
+  return {
+    legacy: false,
+    filePath:
+      eslintrc?.filePath || path.resolve(wxtDir, 'eslint-auto-imports.mjs'),
+    definitionPath: path.resolve(wxtDir, 'eslint-auto-imports.d.mts'),
+    globalsPropValue: eslintrc?.globalsPropValue ?? true,
+  };
+}
+
+function getEslintLegacyConfig(
+  wxtDir: string,
+  eslintrc: Eslintrc | undefined,
+): ResolvedEslintrcLegacy {
   return {
-    enabled,
-    filePath: path.resolve(wxtDir, 'eslintrc-auto-import.json'),
-    globalsPropValue: true,
+    legacy: true,
+    filePath:
+      eslintrc?.filePath || path.resolve(wxtDir, 'eslintrc-auto-import.json'),
+    globalsPropValue: eslintrc?.globalsPropValue ?? true,
   };
 }
 

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

@@ -233,7 +233,7 @@ export const fakeResolvedConfig = fakeObjectCreator<ResolvedConfig>(() => {
   const manifestVersion = faker.helpers.arrayElement([2, 3] as const);
   const mode = faker.helpers.arrayElement(['development', 'production']);
 
-  return {
+  const config: ResolvedConfig = {
     browser,
     targetBrowsers: [],
     command,
@@ -246,7 +246,7 @@ export const fakeResolvedConfig = fakeObjectCreator<ResolvedConfig>(() => {
     imports: {
       disabled: faker.datatype.boolean(),
       eslintrc: {
-        enabled: faker.helpers.arrayElement([false, 8, 9]),
+        legacy: faker.datatype.boolean(),
         filePath: fakeFile(),
         definitionPath: fakeFile(),
         globalsPropValue: faker.helpers.arrayElement([
@@ -256,7 +256,7 @@ export const fakeResolvedConfig = fakeObjectCreator<ResolvedConfig>(() => {
           'readonly',
           'writable',
           'writeable',
-        ] as const),
+        ]),
       },
     },
     logger: mock(),
@@ -307,6 +307,8 @@ export const fakeResolvedConfig = fakeObjectCreator<ResolvedConfig>(() => {
     vite: () => ({}),
     plugins: [],
   };
+
+  return config;
 });
 
 export const fakeWxt = fakeObjectCreator<Wxt>(() => ({

packages/wxt/src/types.ts

@@ -1448,31 +1448,21 @@ export interface Eslintrc {
   globalsPropValue?: EslintGlobalsPropValue;
 }
 
-interface ResolvedEslintrcBase {
+export interface ResolvedEslintrcLegacy {
+  legacy: true;
   /** Absolute path */
   filePath: string;
   globalsPropValue: EslintGlobalsPropValue;
 }
 
-export interface ResolvedEslintrc8 extends ResolvedEslintrcBase {
-  enabled: 8;
-}
-
-export interface ResolvedEslintrc9 extends ResolvedEslintrcBase {
-  enabled: 9;
+export interface ResolvedEslintrc {
+  legacy: false;
+  /** Absolute path */
+  filePath: string;
   definitionPath: string;
+  globalsPropValue: EslintGlobalsPropValue;
 }
 
-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
@@ -1491,7 +1481,9 @@ export type WxtResolvedUnimportOptions = Partial<UnimportOptions> & {
    * You don't need to check this value before modifying the auto-import options. Even if `disabled` is `true`, there's no harm in adding imports to the config - they'll just be ignored.
    */
   disabled: boolean;
-  eslintrc: ResolvedEslintrc;
+
+  /** undefined if disabled, otherwise the major version of ESLint installed */
+  eslintrc: ResolvedEslintrc | ResolvedEslintrcLegacy | undefined;
 };
 
 /**