fix(imports): generate d.ts file for eslint gte 9 auto imports #1981

unrevised6419 · 2025-11-27T19:42:02Z

Overview

When having the ESLint config in a *.ts file, we have a TS error Could not find a declaration file for module './.wxt/eslint-auto-imports.mjs'

Before	After

Manual Testing

Have ESLint 9 in your project
have ESLint config be in a TS file
Use WXT autoImports ESLint Plugin

netlify · 2025-11-27T19:42:07Z

✅ Deploy Preview for creative-fairy-df92c4 ready!

Name	Link
🔨 Latest commit	`bd7d30e`
🔍 Latest deploy log	https://app.netlify.com/projects/creative-fairy-df92c4/deploys/6943756acdc75a0008cda6ba
😎 Deploy Preview	https://deploy-preview-1981--creative-fairy-df92c4.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

aklinker1

Thanks for the PR. I like the addition of a declaration file, but there are lots of extra changes here that are not needed, and some that make this a breaking change:

I would prefer to keep the "8" and "9" labeling over "legacy". I expect ESLint will make more breaking changes to their config in future and using version numbers will be better for identifying versions in the long term. I don't see a reason to rename change change the functions related to this.
Making changes to the ResolvedConfig type is a breaking change. WXT Modules depend on this type, so renaming or changing properties is a breaking change. I'm fine with making breaking changes in general, but they need to be in isolated, small PRs into the major branch.

That being said, in this case, I don't think the rename provides much value, not enough to warrant a breaking change in the first place, so I'm recommending we just not make this change.

aklinker1 · 2025-12-16T14:48:10Z

packages/wxt/src/types.ts

+   * Default:
+   * - 9 and above: './.wxt/types/wxt-auto-imports.d.mts'
+   */
+  definitionPath?: string;


.d.ts files are "declaration" files, not "definition" files.

Suggested change

definitionPath?: string;

declarationFilePath?: string;

Actually, do we even need this config? It should always be the same as the JS file, right? Just with a different extension.

I would prefer to keep the "8" and "9" labeling over "legacy"

Will revert to 8 & 9, but not sure if this will work with upcoming eslint@10

Making changes to the ResolvedConfig type is a breaking change.

Got it, will revert. I thought is only internal.

Actually, do we even need this config?

maybe not, but each type of js file needs its own counterpart of d.ts file

.js -> .d.ts
.mjs -> .d.mts
.cjs -> .d.cts

Probably we can have an internal mapper, and based on the extension to chose ts,cts,mts

Question: When user defines filePath does it have some restrictions (relative or absolute) regarding the .wxt directory? Because I see in the code it always tries to resolve to the .wxt directory.

Because getUnimportEslintOptions will resolve it to .wxt directory, and later after returning the resovled config from getUnimportOptions, the defu overrides it again with the user value. It has strange behaviour.

For example

filePath: '.wxt/eslint-auto-imports.cjs',

From my understanding the user config file path needs to be a resolved path, because the default value is a resolved one.

The intention is to allow the user to use either a relative or absolute path in the config. The relative path should be relative to the .wxt directory. In the final resolved config passed around internally, the path should be absolute.

So it looks like there's a bug in resolve-config module responsible for this. You can see how we resolve paths manually outside of defu for all the other major file paths/directories:

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

Line 88 in 04ae542

const srcDir = path.resolve(root, mergedConfig.srcDir ?? root);

Shouldn't effect this PR, I'd prefer we fix it in a separate PR. I can do it unless you want to.

unrevised6419 · 2025-12-17T16:14:17Z

pnpm-lock.yaml

Note: Netlify failed because this file was not in sync with package.json

The rest of the checks will fail as well. You'll need to run:

git fetch git checkout origin/main pnpm-lock.yaml pnpm i

to reset it.

Oh shoot sorry, main is broken!

aklinker1

Nice, I like the new changes. Let's just add tests then the PR is good to go.

aklinker1 · 2025-12-18T02:40:54Z

pnpm-lock.yaml

The rest of the checks will fail as well. You'll need to run:

git fetch git checkout origin/main pnpm-lock.yaml pnpm i

to reset it.

aklinker1 · 2025-12-18T02:42:57Z

packages/wxt-demo/wxt.config.ts

+  imports: {
+    eslintrc: {
+      enabled: true,
+      filePath: path.resolve('.wxt/eslintrc-auto-import.json'),
+    },
+  },


Instead of changing the demo project, please write tests to test different config. ESLint tests are here:

wxt/packages/wxt/e2e/tests/auto-imports.test.ts

Line 219 in 04ae542

describe('eslintrc', () => {

aklinker1 · 2025-12-18T02:53:52Z

packages/wxt/src/types.ts

+   * Default:
+   * - 9 and above: './.wxt/types/wxt-auto-imports.d.mts'
+   */
+  definitionPath?: string;


The intention is to allow the user to use either a relative or absolute path in the config. The relative path should be relative to the .wxt directory. In the final resolved config passed around internally, the path should be absolute.

So it looks like there's a bug in resolve-config module responsible for this. You can see how we resolve paths manually outside of defu for all the other major file paths/directories:

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

Line 88 in 04ae542

const srcDir = path.resolve(root, mergedConfig.srcDir ?? root);

Shouldn't effect this PR, I'd prefer we fix it in a separate PR. I can do it unless you want to.

aklinker1 · 2025-12-18T02:57:59Z

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

+  const javaScriptFileDirname = path.dirname(options.eslintrc.filePath);
+  const javaScriptFileExtension = path.extname(options.eslintrc.filePath);
+  const javaScriptFileBasename = path.basename(
+    options.eslintrc.filePath,
+    javaScriptFileExtension,
+  );
+
+  const typeScriptFilePath = path.join(
+    javaScriptFileDirname,
+    `${javaScriptFileBasename}.d.ts`,
+  );


This could be simplified a little bit

Suggested change

const javaScriptFileDirname = path.dirname(options.eslintrc.filePath);

const javaScriptFileExtension = path.extname(options.eslintrc.filePath);

const javaScriptFileBasename = path.basename(

options.eslintrc.filePath,

javaScriptFileExtension,

);

const typeScriptFilePath = path.join(

javaScriptFileDirname,

`${javaScriptFileBasename}.d.ts`,

);

const typeScriptFilePath = options.eslintrc.filePath.slice(0, -extname(options.eslintrc.filePath)) + ".d.ts"

The second slice argument might be off by one, I can never remember if extname returns the extension with or without the dot. Or just remove the first dot from ".d.ts".

codecov · 2025-12-18T03:02:20Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 76.17%. Comparing base (43f6c06) to head (bd7d30e).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1981      +/-   ##
==========================================
+ Coverage   75.99%   76.17%   +0.18%     
==========================================
  Files         113      113              
  Lines        3049     3056       +7     
  Branches      686      686              
==========================================
+ Hits         2317     2328      +11     
+ Misses        649      644       -5     
- Partials       83       84       +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

pkg-pr-new · 2025-12-18T03:02:26Z

Open in StackBlitz

@wxt-dev/analytics

npm i https://pkg.pr.new/@wxt-dev/analytics@1981

@wxt-dev/auto-icons

npm i https://pkg.pr.new/@wxt-dev/auto-icons@1981

@wxt-dev/browser

npm i https://pkg.pr.new/@wxt-dev/browser@1981

@wxt-dev/i18n

npm i https://pkg.pr.new/@wxt-dev/i18n@1981

@wxt-dev/module-react

npm i https://pkg.pr.new/@wxt-dev/module-react@1981

@wxt-dev/module-solid

npm i https://pkg.pr.new/@wxt-dev/module-solid@1981

@wxt-dev/module-svelte

npm i https://pkg.pr.new/@wxt-dev/module-svelte@1981

@wxt-dev/module-vue

npm i https://pkg.pr.new/@wxt-dev/module-vue@1981

@wxt-dev/runner

npm i https://pkg.pr.new/@wxt-dev/runner@1981

@wxt-dev/storage

npm i https://pkg.pr.new/@wxt-dev/storage@1981

@wxt-dev/unocss

npm i https://pkg.pr.new/@wxt-dev/unocss@1981

@wxt-dev/webextension-polyfill

npm i https://pkg.pr.new/@wxt-dev/webextension-polyfill@1981

wxt

npm i https://pkg.pr.new/wxt@1981

commit: bd7d30e

unrevised6419 requested review from Timeraa and aklinker1 as code owners November 27, 2025 19:42

unrevised6419 changed the title ~~fix(imports): generate d.ts file for eslint auto imports~~ fix(imports): generate d.mts file for eslint auto imports Nov 27, 2025

unrevised6419 force-pushed the fix/eslint-auto-import-types branch 8 times, most recently from 30810fa to 0710f52 Compare November 28, 2025 08:15

unrevised6419 changed the title ~~fix(imports): generate d.mts file for eslint auto imports~~ feat(imports): allow eslint >9, generate d.mts file for eslint auto imports Nov 28, 2025

unrevised6419 changed the title ~~feat(imports): allow eslint >9, generate d.mts file for eslint auto imports~~ fix(imports): generate d.mts file for eslint auto imports Nov 28, 2025

unrevised6419 marked this pull request as draft December 3, 2025 18:53

unrevised6419 force-pushed the fix/eslint-auto-import-types branch from 747ee15 to d4f8d98 Compare December 6, 2025 20:54

unrevised6419 marked this pull request as ready for review December 6, 2025 20:56

aklinker1 requested changes Dec 16, 2025

View reviewed changes

unrevised6419 force-pushed the fix/eslint-auto-import-types branch 5 times, most recently from cd7edec to 737873c Compare December 17, 2025 15:37

unrevised6419 changed the title ~~fix(imports): generate d.mts file for eslint auto imports~~ fix(imports): generate d.ts file for eslint>9 auto imports Dec 17, 2025

unrevised6419 requested a review from aklinker1 December 17, 2025 15:38

unrevised6419 changed the title ~~fix(imports): generate d.ts file for eslint>9 auto imports~~ fix(imports): generate d.ts file for eslint gte 9 auto imports Dec 17, 2025

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

b4d1f8c

unrevised6419 force-pushed the fix/eslint-auto-import-types branch from 737873c to b4d1f8c Compare December 17, 2025 16:10

unrevised6419 commented Dec 17, 2025

View reviewed changes

aklinker1 requested changes Dec 18, 2025

View reviewed changes

Merge branch 'main' into fix/eslint-auto-import-types

bd7d30e

Uh oh!

fix(imports): generate d.ts file for eslint gte 9 auto imports #1981

Are you sure you want to change the base?

fix(imports): generate d.ts file for eslint gte 9 auto imports #1981

Conversation

unrevised6419 commented Nov 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overview

Manual Testing

Uh oh!

netlify bot commented Nov 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for creative-fairy-df92c4 ready!

Uh oh!

aklinker1 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aklinker1 Dec 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

unrevised6419 Dec 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

unrevised6419 Dec 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

unrevised6419 Dec 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aklinker1 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aklinker1 Dec 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Dec 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

pkg-pr-new bot commented Dec 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

unrevised6419 commented Nov 27, 2025 •

edited

Loading

netlify bot commented Nov 27, 2025 •

edited

Loading

aklinker1 left a comment •

edited

Loading

aklinker1 Dec 16, 2025 •

edited

Loading

unrevised6419 Dec 17, 2025 •

edited

Loading

unrevised6419 Dec 17, 2025 •

edited

Loading

unrevised6419 Dec 17, 2025 •

edited

Loading

aklinker1 Dec 18, 2025 •

edited

Loading

codecov bot commented Dec 18, 2025 •

edited

Loading

pkg-pr-new bot commented Dec 18, 2025 •

edited

Loading