chore(release): wxt v0.19.7

Co-authored-by: Aaron <aaronklinker1@gmail.com>

.github/workflows/release.yml

@@ -7,12 +7,13 @@ on:
         default: wxt
         type: choice
         options:
-          - wxt
-          - module-react
-          - module-vue
-          - module-svelte
-          - module-solid
           - auto-icons
+          - i18n
+          - module-react
+          - module-solid
+          - module-svelte
+          - module-vue
+          - wxt
 
 jobs:
   validate:

.gitignore

@@ -21,3 +21,4 @@ docs/api/reference
 stats.html
 .tool-versions
 .cache
+*-stats.txt

CONTRIBUTING.md

@@ -57,6 +57,21 @@ pnpm test
 pnpm docs:dev
 ```
 
+## Profiling
+
+```sh
+# Build the latest version
+pnpm --filter wxt build
+
+# CD to the demo directory
+cd packages/wxt-demo
+
+# 1. Generate a flamechart with 0x
+pnpm dlx 0x node_modules/wxt/bin/wxt.mjs build
+# 2. Inspect the process with chrome @ chrome://inspect
+pnpm node --inspect node_modules/wxt/bin/wxt.mjs build
+```
+
 ## Updating Docs
 
 Documentation is written with VitePress, and is located in the `docs/` directory.

README.md

@@ -59,10 +59,10 @@ Or see the [installation guide](https://wxt.dev/guide/installation.html) to get
 - 🦾 Auto-imports
 - 🤖 Automated publishing
 - 🎨 Frontend framework agnostic: works with Vue, React, Svelte, etc
+- 📦 Modular architecture with [WXT modules](https://wxt.dev/guide/go-further/reusable-modules.html#overview)
 - 🖍️ Quickly bootstrap a new project
 - 📏 Bundle analysis
 - ⬇️ Download and bundle remote URL imports
-- 📦 Modular architecture with [modules](https://wxt.dev/guide/go-further/reusable-modules.html#overview)
 
 ## Contributors
 

docs/.vitepress/components/UsingWxtSection.vue

@@ -35,6 +35,9 @@ const chromeExtensionIds = [
   'bcpgdpedphodjcjlminjbdeejccjbimp', // 汇率转换-中文版本
   'loeilaonggnalkaiiaepbegccilkmjjp', // Currency Converter Plus
   'npcnninnjghigjfiecefheeibomjpkak', // Respond Easy
+  'cfkdcideecefncbglkhneoflfnmhoicc', // mindful - stay focused on your goals
+  'lnhejcpclabmbgpiiomjbhalblnnbffg', // 1Proompt
+  'fonflmjnjbkigocpoommgmhljdpljain', // NiceTab - https://github.com/web-dahuyou/NiceTab
 ];
 
 const { data, err, isLoading } = useListExtensionDetails(chromeExtensionIds);

docs/.vitepress/config.ts

@@ -130,6 +130,7 @@ export default defineConfig({
         menuGroup('Extension APIs', '/guide/extension-apis/', [
           menuItem('Storage', 'storage'),
           menuItem('Messaging', 'messaging'),
+          menuItem('I18n', 'i18n'),
           menuItem('Scripting', 'scripting'),
           menuItem('Others', 'others'),
         ]),
@@ -148,6 +149,13 @@ export default defineConfig({
         menuGroup('Upgrade Guide', '/guide/upgrade-guide/', [
           menuItem('wxt', 'wxt'),
         ]),
+        menuGroup('@wxt-dev/i18n', '/guide/i18n/', [
+          menuItem('Introduction', 'introduction.md'),
+          menuItem('Installation', 'installation.md'),
+          menuItem('Messages File Format', 'messages-file-format.md'),
+          menuItem('Build Integrations', 'build-integrations.md'),
+          menuItem('Editor Support', 'editor-support.md'),
+        ]),
       ]),
       '/api/': menuRoot([
         menuGroup('CLI', '/api/cli/', [

docs/guide/directory-structure/app-config.md

@@ -53,9 +53,9 @@ declare module 'wxt/sandbox' {
 }
 
 export default defineAppConfig({
-  bugReportingDisabled: process.env.VITE_BUG_REPORTING_DISABLED === 'true',
-  apiKey: process.env.VITE_API_KEY,
+  bugReportingDisabled: import.meta.env.VITE_BUG_REPORTING_DISABLED === 'true',
+  apiKey: import.meta.env.VITE_API_KEY,
 });
 ```
 
-> You don't have to do this, you can use `process.env.VITE_*` anywhere in your runtime code, but putting them here consolidates them to one place and defines what variables are expected.
+> You don't have to do this, you can use `import.meta.env.VITE_*` anywhere in your runtime code, but putting them here consolidates them to one place and defines what variables are expected.

docs/guide/extension-apis/i18n.md

@@ -0,0 +1,56 @@
+# Internationalization
+
+This guide is for using the vanilla, `browser.i18n` APIs. There are two other alternatives:
+
+1. [`@wxt-dev/i18n`](/guide/i18n/installation) - a wrapper around `browser.i18n` APIs with additional features, a simplified localization file format, and editor support
+2. Third party packages - You can use any i18n package on NPM, most of which are more feature rich than `browser.i18n` and `@wxt-dev/i18n`
+
+:::info
+Currently, using the `browser.i18n` APIs are the recommended approach. WXT has some built-in support for them and they work well enough. `@wxt-dev/i18n` was recently released, and it will become the recommended approach after some of the bugs have been worked out. Head over to [it's docs](/guide/i18n/introduction.md) to learn more.
+:::
+
+## Setup
+
+First familiarize yourself with [Chrome's docs](https://developer.chrome.com/docs/extensions/reference/api/i18n). The only difference when using these APIs with WXT is where you put the localization files - in the [`public` directory](/guide/directory-structure/public/).
+
+```
+<srcDir>/
+└─ public/
+   └─ _locales/
+      ├─ en/
+      │  └─ messages.json
+      ├─ de/
+      │  └─ messages.json
+      └─ ko/
+         └─ messages.json
+```
+
+Next, to set a `default_locale` on your manifest, add it to your `wxt.config.ts` file:
+
+```ts
+// wxt.config.ts
+export default defineConfig({
+  manifest: {
+    default_locale: 'en',
+    name: '__MSG_extName__',
+    description: '__MSG_extDescription__',
+  },
+});
+```
+
+> You can localize the `name` and `description` of your extension from the `manifest` config as well.
+
+Finally, to get a translation, call `browser.i18n.getMessage`:
+
+```ts
+browser.i18n.getMessage('extName');
+browser.i18n.getMessage('extDescription');
+browser.i18n.getMessage(/* etc */);
+```
+
+## Examples
+
+See the official localization examples for more details:
+
+- [I18n](https://github.com/wxt-dev/wxt-examples/tree/main/examples/vanilla-i18n#readme)
+- [Vue I18n](https://github.com/wxt-dev/wxt-examples/tree/main/examples/vue-i18n#readme)

docs/guide/go-further/es-modules.md

@@ -35,4 +35,6 @@ Only MV3 support ESM background scripts/service workers. When targeting MV2, the
 
 ## Content Scripts
 
-Coming soon. Follow [Content Script ESM Support #357](https://github.com/wxt-dev/wxt/issues/357) for updates.
+WXT does not include built-in support for ESM content scripts. There are several technical issues that make implementing a generic solution impossible. See [Content Script ESM Support #357](https://github.com/wxt-dev/wxt/issues/357) for details.
+
+Instead, depending on your requirements, you can implement ESM support manually. See the [ESM Content Script UI](https://github.com/wxt-dev/examples/tree/main/examples/esm-content-script-ui) example to get started.

docs/guide/go-further/reusable-modules.md

@@ -25,12 +25,12 @@ There are two ways to add a module to your project:
    });
    ```
 
-2. **NPM package**: By convention, any package on NPM that starts with `@wxt-dev/module-*` or `wxt-module-*` can be installed and included in your project:
+2. **NPM package**: Find WXT modules on NPM and include them in your project:
    ```ts
    // wxt.config.ts
    export default defineConfig({
      // Add the module to your project
-     modules: ['wxt-module-example'],
+     modules: ['@wxt-dev/auto-icons'],
    });
    ```
 
@@ -99,9 +99,9 @@ export default defineConfig({
 
 ### Actually Doing Something
 
-The first argument of the setup function, `wxt`, provides full access to the current build's context. You can access the resolved configuration via `wxt.config`, or setup hooks to manipulate the build at different steps of the build process.
+The first argument of the setup function, `wxt`, provides full access to the current build's context. You can access the resolved configuration via `wxt.config`, or setup hooks to manipulate the build at different steps of the build process with `wxt.hooks`.
 
-Here's an example that shows you how to update the `outDir` based on the build mode. It does a good job showing how to access config, set up a hook, and do something when the hook is called.
+Here's an example that updates the `outDir` based on the build mode. It's a very simple example of how to access config and setup a hook.
 
 ```ts
 export default defineWxtModule((wxt) => {

docs/guide/i18n/build-integrations.md

@@ -0,0 +1,82 @@
+# Build Integrations
+
+To use the custom messages file format, you'll need to use `@wxt-dev/i18n/build` to transform the custom format to the one expected by browsers.
+
+Here's a list of build tools that already have an integration:
+
+[[toc]]
+
+:::info
+If you want to contribute, please do! In particular, an `unplugin` integration would be awesome!
+:::
+
+## WXT
+
+See [Installation with WXT](./installation#with-wxt).
+
+But TLDR, all you need is:
+
+```ts
+// wxt.config.ts
+export default defineConfig({
+  modules: ['@wxt-dev/i18n/module'],
+});
+```
+
+Types are generated whenever you run `wxt prepare` or another build command:
+
+```sh
+wxt prepare
+wxt
+wxt build
+wxt zip
+# etc
+```
+
+## Custom
+
+If you're not using WXT, you'll have to pre-process the localization files yourself. Here's a basic script to generate the `_locales/.../messages.json` and `wxt-i18n-structure.d.ts` files:
+
+```ts
+// build-i18n.js
+import {
+  parseMessagesFile,
+  generateChromeMessagesFile,
+  generateTypeFile,
+} from '@wxt-dev/i18n/build';
+
+// Read your localization files
+const messages = {
+  en: await parseMessagesFile('path/locales/en.yml'),
+  de: await parseMessagesFile('path/locales/de.yml'),
+  // ...
+};
+
+// Generate JSON files for the browser
+await generateChromeMessagesFile('dist/_locales/en/messages.json', messages.en);
+await generateChromeMessagesFile('dist/_locales/de/messages.json', messages.de);
+// ...
+
+// Generate a types file based on your default_locale
+await generateTypeFile('wxt-i18n-structure.d.ts', messages.en);
+```
+
+Then run the script:
+
+```sh
+node generate-i18n.js
+```
+
+If your build tool has a dev mode, you'll also want to rerun the script whenever you change a localization file.
+
+### Type Safety
+
+Once you've generated `wxt-i18n-structure.d.ts` (see the [Custom](#custom) section), you can use it to pass the generated type into `createI18n`:
+
+```ts
+import type { WxtI18nStructure } from './wxt-i18n-structure';
+
+export const i18n = createI18n<WxtI18nStructure>();
+```
+
+And just like that, you have type safety!

docs/guide/i18n/editor-support.md

@@ -0,0 +1,48 @@
+# Editor Support
+
+For better DX, you can configure your editor with plugins and extensions.
+
+[[toc]]
+
+## VS Code
+
+Install the [I18n Ally Extension](https://marketplace.visualstudio.com/items?itemName=lokalise.i18n-ally) to:
+
+- Go to translation definition
+- Inline previews of text
+- Hover to see other translations
+
+You'll need to configure it the extension so it knows where your localization files are and what function represents getting a translation:
+
+`.vscode/i18n-ally-custom-framework.yml`:
+
+```yml
+# An array of strings which contain Language Ids defined by VS Code
+# You can check available language ids here: https://code.visualstudio.com/docs/languages/identifiers
+languageIds:
+  - typescript
+
+# Look for t("...")
+usageMatchRegex:
+  - "[^\\w\\d]t\\(['\"`]({key})['\"`]"
+
+# Disable other built-in i18n ally frameworks
+monopoly: true
+```
+
+`.vscode/settings.json`:
+
+```json
+{
+  "i18n-ally.localesPaths": ["src/locales"],
+  "i18n-ally.keystyle": "nested"
+}
+```
+
+## Zed
+
+As of time of writing, Aug 18, 2024, no extensions exist for Zed to add I18n support.
+
+## IntelliJ
+
+Unknown - Someone who uses IntelliJ will have to open a PR for this!

docs/guide/i18n/installation.md

@@ -0,0 +1,81 @@
+# Installation
+
+[[toc]]
+
+### With WXT
+
+1. Install `@wxt-dev/i18n` via your package manager:
+
+   ```sh
+   pnpm i @wxt-dev/i18n
+   ```
+
+2. Add the WXT module to your `wxt.config.ts` file and setup a default locale:
+
+   ```ts
+   export default defineConfig({
+     modules: ['@wxt-dev/i18n/module'],
+     manifest: {
+       default_locale: 'en',
+     },
+   });
+   ```
+
+3. Create a localization file at `<srcDir>/locales/<default_locale>.yml` or move your existing localization files there.
+
+   ```yml
+   # <srcDir>/locales/en.yml
+   helloWorld: Hello world!
+   ```
+
+   :::tip
+   `@wxt-dev/i18n` supports the standard messages format, so if you already have localization files at `<srcDir>/public/_locale/<lang>/messages.json`, you don't need to convert them to YAML or refactor them - just move them to `<srcDir>/locales/<lang>.json` and they'll just work out of the box!
+   :::
+
+4. To get a translation, use the auto-imported `i18n` object or import it manually:
+
+   ```ts
+   import { i18n } from '#i18n';
+
+   i18n.t('helloWorld'); // "Hello world!"
+   ```
+
+And you're done! Using WXT, you get type-safety out of the box.
+
+### Without WXT
+
+1. Install `@wxt-dev/i18n` via your package manager:
+
+   ```sh
+   pnpm i @wxt-dev/i18n
+   ```
+
+2. Create a messages file at `_locales/<lang>/messages.json` or move your existing translations there:
+
+   ```json
+   {
+     "helloWorld": {
+       "message": "Hello world!"
+     }
+   }
+   ```
+
+   :::info
+   For the best DX, you should to integrate `@wxt-dev/i18n` into your build process. This enables:
+
+   1. Plural forms
+   2. Simple messages file format
+   3. Type safety
+
+   See [Build Integrations](./build-integrations) to set it up.
+   :::
+
+3. Create the `i18n` object, export it, and use it wherever you want!
+
+   ```ts
+   import { createI18n } from '@wxt-dev/i18n';
+
+   export const i18n = createI18n();
+
+   i18n.t('helloWorld'); // "Hello world!";
+   ```

docs/guide/i18n/introduction.md

@@ -0,0 +1,22 @@
+# Introduction
+
+:::info
+You don't have to use `wxt` to use this package - it will work in any bundler setup. See [Installation without WXT](./installation#without-wxt) for more details.
+:::
+
+`@wxt-dev/i18n` is a simple, type-safe wrapper around the `browser.i18n` APIs. It provides several benefits over the standard API:
+
+1. Simple messages file format
+2. Plural form support
+3. Integrates with the [I18n Ally VS Code extension](./editor-support#vscode)
+
+It also provides several benefits over other non-web extension specific i18n packages:
+
+1. Does not bundle localization files into every entrypoint
+2. Don't need to fetch the localization files asynchronously
+3. Can localize extension name in manifest
+4. Can access localized strings inside CSS files
+
+However, it does have one major downside:
+
+1. Like the `browser.i18n` API, to change the language, users must change the browser's language

docs/guide/i18n/messages-file-format.md

@@ -0,0 +1,170 @@
+# Messages File Format
+
+You can only use the file format discussed on this page if you have [integrated `@wxt-dev/i18n` into your build process](./build-integrations). If you have not integrated it into your build process, you must use JSON files in the `_locales` directory, like a normal web extension.
+
+[[toc]]
+
+## File Extensions
+
+You can define your messages in several different file types:
+
+- `.yml`
+- `.yaml`
+- `.json`
+- `.jsonc`
+- `.json5`
+- `.toml`
+
+## Nested Keys
+
+You can have translations at the top level or nest them into groups:
+
+```yml
+ok: OK
+cancel: Cancel
+welcome:
+  title: Welcome to XYZ
+dialogs:
+  confirmation:
+    title: 'Are you sure?'
+```
+
+To access a nested key, use `.`:
+
+```ts
+i18n.t('ok'); // "OK"
+i18n.t('cancel'); // "Cancel"
+i18n.t('welcome.title'); // "Welcome to XYZ"
+i18n.t('dialogs.confirmation.title'); // "Are you sure?"
+```
+
+## Substitutions
+
+Because `@wxt-dev/i18n` is based on `browser.i18n`, you define substitutions the same way, with `$1`-`$9`:
+
+```yml
+hello: Hello $1!
+order: Thanks for ordering your $1
+```
+
+### Escapting `$`
+
+To escape the dollar sign, put another `$` in front of it:
+
+```yml
+dollars: $$$1
+```
+
+```ts
+i18n.t('dollars', ['1.00']); // "$1.00"
+```
+
+## Plural Forms
+
+:::warning
+Plural support languages like Arabic, that have different forms for "few" or "many", is not supported right now. Feel free to open a PR if you are interested in this!
+:::
+
+To get a different translation based on a count:
+
+```yml
+items:
+  1: 1 item
+  n: $1 items
+```
+
+Then you pass in the count as the second argument to `i18n.t`:
+
+```ts
+i18n.t('items', 0); // "0 items"
+i18n.t('items', 1); // "1 item"
+i18n.t('items', 2); // "2 items"
+```
+
+To add a custom translation for 0 items:
+
+```yml
+items:
+  0: No items
+  1: 1 item
+  n: $1 items
+```
+
+```ts
+i18n.t('items', 0); // "No items"
+i18n.t('items', 1); // "1 item"
+i18n.t('items', 2); // "2 items"
+```
+
+If you need to pass a custom substitution for `$1` instead of the count, just add the substitution:
+
+```yml
+items:
+  0: No items
+  1: $1 item
+  n: $1 items
+```
+
+```ts
+i18n.t('items', 0, ['Zero']); // "No items"
+i18n.t('items', 1, ['One']); // "One item"
+i18n.t('items', 2, ['Multiple']); // "Multiple items"
+```
+
+## Verbose Keys
+
+`@wxt-dev/i18n` is compatible with the message format used by [`browser.i18n`](https://developer.chrome.com/docs/extensions/reference/api/i18n).
+
+:::info
+This means if you're migrating to `@wxt-dev/i18n` and you're already using the verbose format, you don't have to change anything!
+:::
+
+A key is treated as "verbose" when it is:
+
+1. At the top level (not nested)
+2. Only contains the following properties: `message`, `description` and/or `placeholder`
+
+:::code-group
+
+```json [JSON]
+{
+  "appName": {
+    "message": "GitHub - Better Line Counts",
+    "description": "The app's name, should not be translated",
+  },
+  "ok": "OK",
+  "deleteConfirmation": {
+    "title": "Delete XYZ?"
+    "message": "You cannot undo this action once taken."
+  }
+}
+```
+
+```yml [YAML]
+appName:
+  message: GitHub - Better Line Counts
+  description: The app's name, should not be translated
+ok: OK
+deleteConfirmation:
+  title: Delete XYZ?
+  message: You cannot undo this action once taken.
+```
+
+:::
+
+In this example, only `appName` is considered verbose. `deleteConfirmation` is not verbose because it contains the additional property `title`.
+
+```ts
+i18n.t('appName'); // ✅ "GitHub - Better Line Counts"
+i18n.t('appName.message'); // ❌
+i18n.t('ok'); // ✅ "OK"
+i18n.t('deleteConfirmation'); // ❌
+i18n.t('deleteConfirmation.title'); // ✅ "Delete XYZ?"
+i18n.t('deleteConfirmation.message'); // ✅ "You cannot undo this action once taken."
+```
+
+If this is confusing, don't worry! With type-safety, you'll get a type error if you do it wrong. If type-safety is disabled, you'll get a runtime warning in the devtools console.
+
+:::warning
+Using the verbose format is not recommended. I have yet to see a translation service and software that supports this format out of the box. Stick with the simple format when you can.
+:::

docs/guide/key-concepts/manifest.md

@@ -172,37 +172,9 @@ export default defineConfig({
 
 :::
 
-## Localization
+## Default Locale
 
-Similar to the icon, the [`_locales` directory](https://developer.chrome.com/docs/extensions/reference/i18n/) should be placed inside the the WXT's [`public` directory](/guide/directory-structure/public/).
-
-```
-public/
-└─ _locales/
-   ├─ en/
-   │  └─ messages.json
-   ├─ es/
-   │  └─ messages.json
-   └─ ko/
-      └─ messages.json
-```
-
-Then you'll need to explicitly override the `name` and `description` properties in your config for them to be localized.
-
-```ts
-export default defineConfig({
-  manifest: {
-    name: '__MSG_extName__',
-    description: '__MSG_extDescription__',
-    default_locale: 'en',
-  },
-});
-```
-
-See the official localization examples for more details:
-
-- [I18n](https://github.com/wxt-dev/wxt-examples/tree/main/examples/vanilla-i18n#readme)
-- [Vue I18n](https://github.com/wxt-dev/wxt-examples/tree/main/examples/vue-i18n#readme)
+See the dedicated [I18n docs](/guide/extension-apis/i18n) for setting up localization and a `default_locale`.
 
 ## Actions
 

docs/index.md

@@ -53,6 +53,11 @@ features:
     details: Works with any front-end framework with a Vite plugin.
     link: /guide/key-concepts/frontend-frameworks
     linkText: Add a framework
+  - icon: 📦
+    title: Modular Architecture
+    details: Reuse build-time and runtime-code across multiple extensions.
+    link: /guide/go-further/reusable-modules
+    linkText: Read docs
   - icon: 🖍️
     title: Bootstrap a New Project
     details: Get started quickly with several awesome project templates.

package.json

@@ -2,10 +2,9 @@
   "private": true,
   "type": "module",
   "engines": {
-    "node": ">=18.20.3",
-    "pnpm": "^8.6.3"
+    "node": ">=18.20.3"
   },
-  "packageManager": "pnpm@8.15.9",
+  "packageManager": "pnpm@9.6.0",
   "scripts": {
     "check": "check && pnpm -r --sequential run check",
     "test": "pnpm -r --sequential run test run",
@@ -21,7 +20,7 @@
     "@aklinker1/buildc": "^1.0.11",
     "@aklinker1/check": "^1.3.1",
     "@types/fs-extra": "^11.0.4",
-    "@vitest/coverage-v8": "^2.0.0",
+    "@vitest/coverage-v8": "^2.0.4",
     "changelogen": "^0.5.5",
     "consola": "^3.2.3",
     "dependency-graph": "^1.0.0",
@@ -37,12 +36,12 @@
     "typedoc": "^0.25.4",
     "typedoc-plugin-markdown": "4.0.0-next.23",
     "typedoc-vitepress-theme": "1.0.0-next.3",
-    "typescript": "^5.5.3",
+    "typescript": "^5.5.4",
     "vitepress": "^1.3.1",
-    "vitest-mock-extended": "^1.3.2",
-    "vue": "^3.4.33",
+    "vitest-mock-extended": "^2.0.0",
+    "vue": "^3.4.34",
     "wxt": "workspace:*",
-    "yaml": "^2.4.5"
+    "yaml": "^2.5.0"
   },
   "simple-git-hooks": {
     "pre-commit": "pnpm lint-staged"

packages/auto-icons/CHANGELOG.md

@@ -0,0 +1,34 @@
+# Changelog
+
+## v1.0.2
+
+[compare changes](https://github.com/wxt-dev/wxt/compare/auto-icons-v1.0.1...auto-icons-v1.0.2)
+
+### 📖 Documentation
+
+- **auto-icons:** Fix configuration example typo ([#905](https://github.com/wxt-dev/wxt/pull/905))
+
+### 🏡 Chore
+
+- Add more metadata for npm ([#885](https://github.com/wxt-dev/wxt/pull/885))
+
+### ❤️ Contributors
+
+- Uncenter ([@uncenter](http://github.com/uncenter))
+- Florian Metz ([@Timeraa](http://github.com/Timeraa))
+
+## v1.0.1
+
+[compare changes](https://github.com/wxt-dev/wxt/compare/auto-icons-v1.0.0...auto-icons-v1.0.1)
+
+### 🩹 Fixes
+
+- **auto-icons:** Path option ([#880](https://github.com/wxt-dev/wxt/pull/880))
+
+### 🏡 Chore
+
+- **deps:** Upgrade all dependencies ([#869](https://github.com/wxt-dev/wxt/pull/869))
+
+### ❤️ Contributors
+
+- Florian Metz ([@Timeraa](http://github.com/Timeraa))

packages/auto-icons/README.md

@@ -32,7 +32,7 @@ The module can be configured via the `autoIcons` config:
 
 ```ts
 export default defineConfig({
-  module: ['@wxt-dev/auto-icons'],
+  modules: ['@wxt-dev/auto-icons'],
   autoIcons: {
     // ...
   },

packages/auto-icons/package.json

@@ -1,6 +1,30 @@
 {
   "name": "@wxt-dev/auto-icons",
-  "version": "1.0.0",
+  "description": "WXT module for automatically generating extension icons in different sizes",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/wxt-dev/wxt.git",
+    "directory": "packages/auto-icons"
+  },
+  "homepage": "https://github.com/wxt-dev/wxt/blob/main/packages/auto-icons/README.md",
+  "keywords": [
+    "wxt",
+    "module",
+    "icons",
+    "manifest"
+  ],
+  "author": {
+    "name": "Florian Metz",
+    "email": "me@timeraa.dev"
+  },
+  "contributors": [
+    {
+      "name": "Aaron Klinker",
+      "email": "aaronklinker1+wxt@gmail.com"
+    }
+  ],
+  "license": "MIT",
+  "version": "1.0.2",
   "type": "module",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
@@ -15,7 +39,7 @@
   ],
   "scripts": {
     "build": "buildc -- unbuild",
-    "check": "buildc --deps-only -- check"
+    "check": "pnpm build && check"
   },
   "peerDependencies": {
     "wxt": ">=0.19.0"
@@ -23,7 +47,7 @@
   "devDependencies": {
     "@aklinker1/check": "^1.3.1",
     "publint": "^0.2.9",
-    "typescript": "^5.5.3",
+    "typescript": "^5.5.4",
     "unbuild": "^2.0.0",
     "wxt": "workspace:*"
   },

packages/auto-icons/src/index.ts

@@ -9,20 +9,24 @@ export default defineWxtModule<AutoIconsOptions>({
   name: '@wxt-dev/auto-icons',
   configKey: 'autoIcons',
   async setup(wxt, options) {
-    const parsedOptions = defu(options, {
-      enabled: true,
-      baseIconsPath: resolve(wxt.config.srcDir, 'assets/icon.png'),
-      grayscaleOnDevelopment: true,
-      sizes: [128, 48, 32, 16],
-    });
+    const parsedOptions = defu<Required<AutoIconsOptions>, AutoIconsOptions[]>(
+      options,
+      {
+        enabled: true,
+        baseIconPath: resolve(wxt.config.srcDir, 'assets/icon.png'),
+        grayscaleOnDevelopment: true,
+        sizes: [128, 48, 32, 16],
+      },
+    );
+
+    const resolvedPath = resolve(wxt.config.srcDir, parsedOptions.baseIconPath);
 
     if (!parsedOptions.enabled)
       return wxt.logger.warn(`\`[auto-icons]\` ${this.name} disabled`);
 
-    if (!(await exists(parsedOptions.baseIconsPath))) {
-      const relativePath = relative(process.cwd(), parsedOptions.baseIconsPath);
+    if (!(await exists(resolvedPath))) {
       return wxt.logger.warn(
-        `\`[auto-icons]\` Skipping icon generation, no base icon found at ${relativePath}`,
+        `\`[auto-icons]\` Skipping icon generation, no base icon found at ${relative(process.cwd(), resolvedPath)}`,
       );
     }
 
@@ -38,7 +42,7 @@ export default defineWxtModule<AutoIconsOptions>({
     });
 
     wxt.hooks.hook('build:done', async (wxt, output) => {
-      const image = sharp(parsedOptions.baseIconsPath).png();
+      const image = sharp(resolvedPath).png();
 
       if (
         wxt.config.mode === 'development' &&
@@ -80,6 +84,8 @@ export interface AutoIconsOptions {
   enabled?: boolean;
   /**
    * Path to the image to use.
+   *
+   * Path is relative to the project's src directory.
    * @default "<srcDir>/assets/icon.png"
    */
   baseIconPath?: string;

packages/i18n/README.md

@@ -0,0 +1,3 @@
+# WXT I18n
+
+[Read the docs](https://wxt.dev/guide/i18n/installation) to get started.

packages/i18n/package.json

@@ -0,0 +1,89 @@
+{
+  "name": "@wxt-dev/i18n",
+  "description": "Type-safe wrapper around browser.i18n.getMessage with additional features",
+  "version": "0.1.0",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/wxt-dev/wxt.git",
+    "directory": "packages/i18n"
+  },
+  "homepage": "http://wxt.dev/guide/i18n/installation.html",
+  "keywords": [
+    "wxt",
+    "module",
+    "i18n"
+  ],
+  "author": {
+    "name": "Aaron Klinker",
+    "email": "aaronklinker1+wxt@gmail.com"
+  },
+  "license": "MIT",
+  "scripts": {
+    "build": "buildc -- unbuild",
+    "check": "buildc --deps-only -- check",
+    "test": "buildc --deps-only -- vitest"
+  },
+  "dependencies": {
+    "chokidar": "^3.6.0",
+    "confbox": "^0.1.7",
+    "fast-glob": "^3.3.2"
+  },
+  "peerDependencies": {
+    "wxt": ">=0.19.7"
+  },
+  "peerDependenciesMeta": {
+    "wxt": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@aklinker1/check": "^1.3.1",
+    "@types/chrome": "^0.0.268",
+    "@types/node": "^20.14.2",
+    "publint": "^0.2.8",
+    "typescript": "^5.4.5",
+    "unbuild": "^2.0.0",
+    "vitest": "^1.6.0",
+    "vitest-plugin-random-seed": "^1.1.0",
+    "wxt": "workspace:*"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./build": {
+      "import": {
+        "types": "./dist/build.d.mts",
+        "default": "./dist/build.mjs"
+      },
+      "require": {
+        "types": "./dist/build.d.cts",
+        "default": "./dist/build.cjs"
+      }
+    },
+    "./module": {
+      "import": {
+        "types": "./dist/module.d.mts",
+        "default": "./dist/module.mjs"
+      },
+      "require": {
+        "types": "./dist/module.d.cts",
+        "default": "./dist/module.cjs"
+      }
+    }
+  },
+  "files": [
+    "dist"
+  ]
+}

packages/i18n/src/__tests__/build.test.ts

@@ -0,0 +1,164 @@
+import { describe, it, expect, vi } from 'vitest';
+import {
+  parseMessagesFile,
+  generateChromeMessagesFile,
+  generateTypeFile,
+} from '../build';
+import {
+  stringifyTOML,
+  stringifyYAML,
+  stringifyJSON5,
+  stringifyJSON,
+  stringifyJSONC,
+} from 'confbox';
+import { writeFile, readFile } from 'node:fs/promises';
+
+vi.mock('node:fs/promises');
+const mockWriteFile = vi.mocked(writeFile);
+const mockReadFile = vi.mocked(readFile);
+
+describe('Built Tools', () => {
+  it('should correctly convert all types of message formats', async () => {
+    const fileText = stringifyYAML({
+      simple: 'example',
+      sub: 'Hello $1',
+      nested: {
+        example: 'This is nested',
+        array: ['One', 'Two'],
+        notChrome: {
+          message: 'test 1',
+        },
+      },
+      chrome: {
+        message: 'test 2',
+        description: 'test',
+      },
+      plural0: {
+        0: 'Zero items',
+        1: 'One item',
+        n: '$1 items',
+      },
+      plural1: {
+        1: 'One item',
+        n: '$1 items',
+      },
+      pluralN: {
+        n: '$1 items',
+      },
+      pluralSub: {
+        1: 'Hello $2, I have one problem',
+        n: 'Hello $2, I have $1 problems',
+      },
+    });
+
+    mockReadFile.mockResolvedValue(fileText);
+
+    const messages = await parseMessagesFile(`file.yml`);
+    await generateChromeMessagesFile('output.json', messages);
+    await generateTypeFile('output.d.ts', messages);
+    const actualChromeMessagesFile = mockWriteFile.mock.calls[0][1];
+    const actualDtsFile = mockWriteFile.mock.calls[1][1];
+
+    expect(mockWriteFile).toBeCalledTimes(2);
+    expect(actualChromeMessagesFile).toMatchInlineSnapshot(`
+      "{
+        "simple": {
+          "message": "example"
+        },
+        "sub": {
+          "message": "Hello $1"
+        },
+        "nested_example": {
+          "message": "This is nested"
+        },
+        "nested_array_0": {
+          "message": "One"
+        },
+        "nested_array_1": {
+          "message": "Two"
+        },
+        "nested_notChrome_message": {
+          "message": "test 1"
+        },
+        "chrome": {
+          "message": "test 2",
+          "description": "test"
+        },
+        "plural0": {
+          "message": "Zero items | One item | $1 items"
+        },
+        "plural1": {
+          "message": "One item | $1 items"
+        },
+        "pluralN": {
+          "message": "$1 items"
+        },
+        "pluralSub": {
+          "message": "Hello $2, I have one problem | Hello $2, I have $1 problems"
+        }
+      }
+      "
+    `);
+    expect(actualDtsFile).toMatchInlineSnapshot(`
+      "export type GeneratedI18nStructure = {
+        "simple": { substitutions: 0, plural: false };
+        "sub": { substitutions: 1, plural: false };
+        "nested.example": { substitutions: 0, plural: false };
+        "nested.array.0": { substitutions: 0, plural: false };
+        "nested.array.1": { substitutions: 0, plural: false };
+        "nested.notChrome.message": { substitutions: 0, plural: false };
+        "chrome": { substitutions: 0, plural: false };
+        "plural0": { substitutions: 1, plural: true };
+        "plural1": { substitutions: 1, plural: true };
+        "pluralN": { substitutions: 1, plural: true };
+        "pluralSub": { substitutions: 2, plural: true };
+        "@@extension_id": { substitutions: 0, plural: false };
+        "@@ui_locale": { substitutions: 0, plural: false };
+        "@@bidi_dir": { substitutions: 0, plural: false };
+        "@@bidi_reversed_dir": { substitutions: 0, plural: false };
+        "@@bidi_start_edge": { substitutions: 0, plural: false };
+        "@@bidi_end_edge": { substitutions: 0, plural: false };
+      }
+      "
+    `);
+  });
+
+  it.each([
+    ['yaml', stringifyYAML],
+    ['yml', stringifyYAML],
+    ['toml', stringifyTOML],
+    ['json', stringifyJSON],
+    ['jsonc', stringifyJSONC],
+    ['json5', stringifyJSON5],
+  ])('Parse and generate: %s', async (extension, stringify) => {
+    const fileText = stringify({
+      simple: 'example',
+    });
+    const expectedDts = `export type GeneratedI18nStructure = {
+  "simple": { substitutions: 0, plural: false };
+  "@@extension_id": { substitutions: 0, plural: false };
+  "@@ui_locale": { substitutions: 0, plural: false };
+  "@@bidi_dir": { substitutions: 0, plural: false };
+  "@@bidi_reversed_dir": { substitutions: 0, plural: false };
+  "@@bidi_start_edge": { substitutions: 0, plural: false };
+  "@@bidi_end_edge": { substitutions: 0, plural: false };
+}
+`;
+    const expectedChromeMessages =
+      JSON.stringify({ simple: { message: 'example' } }, null, 2) + '\n';
+
+    mockReadFile.mockResolvedValue(fileText);
+
+    const messages = await parseMessagesFile(`file.${extension}`);
+    await generateChromeMessagesFile('output.json', messages);
+    await generateTypeFile('output.d.ts', messages);
+
+    expect(mockWriteFile).toBeCalledTimes(2);
+    expect(mockWriteFile).toBeCalledWith(
+      'output.json',
+      expectedChromeMessages,
+      'utf8',
+    );
+    expect(mockWriteFile).toBeCalledWith('output.d.ts', expectedDts, 'utf8');
+  });
+});

packages/i18n/src/__tests__/index.test.ts

@@ -0,0 +1,82 @@
+import { describe, it, expect, vi, beforeEach } from 'vitest';
+import { createI18n } from '../index';
+import { GetMessageOptions } from '../types';
+
+const getMessageMock = vi.fn();
+
+vi.stubGlobal('chrome', {
+  i18n: {
+    getMessage: getMessageMock,
+  },
+});
+
+describe('createI18n', () => {
+  beforeEach(() => {
+    getMessageMock.mockReturnValue('Some text.');
+  });
+
+  it.each([
+    ['key', 'key'],
+    ['some_key', 'some_key'],
+    ['some.nested.key', 'some_nested_key'],
+  ])('should retrieve "%s" as "%s"', (input, expectedKey) => {
+    const i18n = createI18n();
+    const expectedValue = String(Math.random());
+    getMessageMock.mockReturnValue(expectedValue);
+
+    const actual = i18n.t(input);
+
+    expect(actual).toBe(expectedValue);
+    expect(getMessageMock).toBeCalledTimes(1);
+    expect(getMessageMock).toBeCalledWith(expectedKey, undefined);
+  });
+
+  it.each([
+    ['n items', 0, 'n items'],
+    ['n items', 1, 'n items'],
+    ['n items', 2, 'n items'],
+    ['n items', 3, 'n items'],
+    ['1 item | n items', 0, 'n items'],
+    ['1 item | n items', 1, '1 item'],
+    ['1 item | n items', 2, 'n items'],
+    ['1 item | n items', 3, 'n items'],
+    ['0 items | 1 item | n items', 0, '0 items'],
+    ['0 items | 1 item | n items', 1, '1 item'],
+    ['0 items | 1 item | n items', 2, 'n items'],
+    ['0 items | 1 item | n items', 3, 'n items'],
+  ])(
+    'should retrieve plural forms correctly',
+    (rawMessage, count, expected) => {
+      const i18n = createI18n();
+      getMessageMock.mockReturnValue(rawMessage);
+      const key = 'items';
+
+      const actual = i18n.t(key, count);
+
+      expect(actual).toBe(expected);
+      expect(getMessageMock).toBeCalledTimes(1);
+      expect(getMessageMock).toBeCalledWith(key, [String(count)], undefined);
+    },
+  );
+
+  it('should allow overriding the plural substitutions', () => {
+    const i18n = createI18n();
+    i18n.t('key', 3, ['custom']);
+    expect(getMessageMock).toBeCalledWith('key', ['custom'], undefined);
+  });
+
+  it('should pass options into browser.i18n.getMessage', () => {
+    const i18n = createI18n();
+    const options: GetMessageOptions = {
+      escapeLt: true,
+    };
+
+    i18n.t('key', options);
+    i18n.t('key', [''], options);
+    i18n.t('key', 1, options);
+    i18n.t('key', 1, [''], options);
+    getMessageMock.mock.calls.forEach((call) => {
+      expect(call.pop()).toEqual(options);
+    });
+  });
+});

packages/i18n/src/__tests__/types.test.ts

@@ -0,0 +1,119 @@
+import { beforeEach, describe, it, vi } from 'vitest';
+import { createI18n } from '..';
+
+const getMessageMock = vi.fn();
+
+vi.stubGlobal('chrome', {
+  i18n: {
+    getMessage: getMessageMock,
+  },
+});
+
+const n: number = 1;
+
+describe('I18n Types', () => {
+  beforeEach(() => {
+    getMessageMock.mockReturnValue('Some text.');
+  });
+
+  describe('No type-safety', () => {
+    const i18n = createI18n();
+
+    describe('t', () => {
+      it('should allow passing any combination of arguments', () => {
+        i18n.t('any');
+        i18n.t('any', { escapeLt: true });
+        i18n.t('any', ['one']);
+        i18n.t('any', ['one'], { escapeLt: true });
+        i18n.t('any', ['one', 'two']);
+        i18n.t('any', ['one', 'two'], { escapeLt: true });
+        i18n.t('any', n, ['one', 'two']);
+        i18n.t('any', n, ['one', 'two'], { escapeLt: true });
+      });
+    });
+  });
+
+  describe('With type-safety', () => {
+    const i18n = createI18n<{
+      simple: { plural: false; substitutions: 0 };
+      simpleSub1: { plural: false; substitutions: 1 };
+      simpleSub2: { plural: false; substitutions: 2 };
+      plural: { plural: true; substitutions: 0 };
+      pluralSub1: { plural: true; substitutions: 1 };
+      pluralSub2: { plural: true; substitutions: 2 };
+    }>();
+
+    describe('t', () => {
+      it('should only allow passing valid combinations of arguments', () => {
+        i18n.t('simple');
+        i18n.t('simple', { escapeLt: true });
+        // @ts-expect-error
+        i18n.t('simple', []);
+        // @ts-expect-error
+        i18n.t('simple', ['one']);
+        // @ts-expect-error
+        i18n.t('simple', n);
+
+        i18n.t('simpleSub1', ['one']);
+        i18n.t('simpleSub1', ['one'], { escapeLt: true });
+        // @ts-expect-error
+        i18n.t('simpleSub1');
+        // @ts-expect-error
+        i18n.t('simpleSub1', []);
+        // @ts-expect-error
+        i18n.t('simpleSub1', ['one', 'two']);
+        // @ts-expect-error
+        i18n.t('simpleSub1', n);
+
+        i18n.t('simpleSub2', ['one', 'two']);
+        i18n.t('simpleSub2', ['one', 'two'], { escapeLt: true });
+        // @ts-expect-error
+        i18n.t('simpleSub2');
+        // @ts-expect-error
+        i18n.t('simpleSub2', ['one']);
+        // @ts-expect-error
+        i18n.t('simpleSub2', ['one', 'two', 'three']);
+        // @ts-expect-error
+        i18n.t('simpleSub2', n);
+
+        i18n.t('plural', n);
+        i18n.t('plural', n, { escapeLt: true });
+        // @ts-expect-error
+        i18n.t('plural');
+        // @ts-expect-error
+        i18n.t('plural', []);
+        // @ts-expect-error
+        i18n.t('plural', ['one']);
+        // @ts-expect-error
+        i18n.t('plural', n, ['sub']);
+
+        i18n.t('pluralSub1', n);
+        i18n.t('pluralSub1', n, { escapeLt: true });
+        i18n.t('pluralSub1', n, undefined, { escapeLt: true });
+        i18n.t('pluralSub1', n, ['one']);
+        i18n.t('pluralSub1', n, ['one'], { escapeLt: true });
+        // @ts-expect-error
+        i18n.t('pluralSub1');
+        // @ts-expect-error
+        i18n.t('pluralSub1', ['one']);
+        // @ts-expect-error
+        i18n.t('pluralSub1', n, []);
+        // @ts-expect-error
+        i18n.t('pluralSub1', n, ['one', 'two']);
+
+        i18n.t('pluralSub2', n, ['one', 'two']);
+        i18n.t('pluralSub2', n, ['one', 'two'], { escapeLt: true });
+        // @ts-expect-error
+        i18n.t('pluralSub2');
+        // @ts-expect-error
+        i18n.t('pluralSub2', ['one', 'two']);
+        // @ts-expect-error
+        i18n.t('pluralSub2', n, ['one']);
+        // @ts-expect-error
+        i18n.t('pluralSub2', n, ['one', 'two', 'three']);
+        // @ts-expect-error
+        i18n.t('pluralSub2', n);
+      });
+    });
+  });
+});

packages/i18n/src/__tests__/utils.test.ts

@@ -0,0 +1,63 @@
+import { describe, it, expect } from 'vitest';
+import { ChromeMessage } from '../build';
+import { applyChromeMessagePlaceholders, getSubstitionCount } from '../utils';
+
+describe('Utils', () => {
+  describe('applyChromeMessagePlaceholders', () => {
+    it('should return the combined stirng', () => {
+      const input = {
+        message: 'Hello $username$, welcome to $appName$',
+        placeholders: {
+          username: { content: '$1' },
+          appName: { content: 'Example' },
+        },
+      } satisfies ChromeMessage;
+      const expected = input.message
+        .replace('$username$', input.placeholders.username.content)
+        .replace('$appName$', input.placeholders.appName.content);
+
+      const actual = applyChromeMessagePlaceholders(input);
+
+      expect(actual).toBe(expected);
+    });
+
+    it('should ignore the case', () => {
+      const input = {
+        message: 'Hello $USERNAME$, welcome $username$',
+        placeholders: {
+          username: { content: '$1' },
+        },
+      } satisfies ChromeMessage;
+      const expected = input.message
+        .replace('$USERNAME$', input.placeholders.username.content)
+        .replace('$username$', input.placeholders.username.content);
+
+      const actual = applyChromeMessagePlaceholders(input);
+
+      expect(actual).toBe(expected);
+    });
+  });
+
+  describe('getSubstitionCount', () => {
+    it('should return the last substution present in the message', () => {
+      expect(getSubstitionCount('I like $1, but I like $2 better')).toBe(2);
+    });
+
+    it('should return 0 when no substitutions are present', () => {
+      expect(getSubstitionCount('test')).toBe(0);
+    });
+
+    it('should ignore escaped dollar signs', () => {
+      expect(getSubstitionCount('buy $1 now for $$2 dollars')).toBe(1);
+    });
+
+    it('should return the highest substitution when skipping numbers', () => {
+      expect(getSubstitionCount('I like $1, but I like $8 better')).toBe(8);
+    });
+
+    it('should only allow up to 9 substitutions', () => {
+      expect(getSubstitionCount('Hello $9')).toBe(9);
+      expect(getSubstitionCount('Hello $10')).toBe(1);
+    });
+  });
+});

packages/i18n/src/build.ts

@@ -0,0 +1,291 @@
+/**
+ * This module contains utils for generating types and `messages.json` files
+ * based on the custom messages file format.
+ *
+ * @module @wxt-dev/i18n/build
+ */
+
+import { mkdir, readFile, writeFile } from 'node:fs/promises';
+import { parseYAML, parseJSON5, parseTOML } from 'confbox';
+import { dirname, extname } from 'node:path';
+import { applyChromeMessagePlaceholders, getSubstitionCount } from './utils';
+
+//
+// TYPES
+//
+
+export interface ChromeMessage {
+  message: string;
+  description?: string;
+  placeholders?: Record<string, { content: string; example?: string }>;
+}
+
+export interface ParsedBaseMessage {
+  key: string[];
+  substitutions: number;
+}
+
+export interface ParsedChromeMessage extends ParsedBaseMessage, ChromeMessage {
+  type: 'chrome';
+}
+export interface ParsedSimpleMessage extends ParsedBaseMessage {
+  type: 'simple';
+  message: string;
+}
+export interface ParsedPluralMessage extends ParsedBaseMessage {
+  type: 'plural';
+  plurals: { [count: string]: string };
+}
+
+export type ParsedMessage =
+  | ParsedChromeMessage
+  | ParsedSimpleMessage
+  | ParsedPluralMessage;
+
+export type MessageFormat = 'JSON5' | 'YAML' | 'TOML';
+
+//
+// CONSTANTS
+//
+
+/**
+ * See https://developer.chrome.com/docs/extensions/reference/api/i18n#overview-predefined
+ */
+const PREDEFINED_MESSAGES: Record<string, ChromeMessage> = {
+  '@@extension_id': {
+    message: '<browser.runtime.id>',
+    description:
+      "The extension or app ID; you might use this string to construct URLs for resources inside the extension. Even unlocalized extensions can use this message.\nNote: You can't use this message in a manifest file.",
+  },
+  '@@ui_locale': {
+    message: '<browser.i18n.getUiLocale()>',
+    description: '',
+  },
+  '@@bidi_dir': {
+    message: '<ltr|rtl>',
+    description:
+      'The text direction for the current locale, either "ltr" for left-to-right languages such as English or "rtl" for right-to-left languages such as Japanese.',
+  },
+  '@@bidi_reversed_dir': {
+    message: '<rtl|ltr>',
+    description:
+      'If the `@@bidi_dir` is "ltr", then this is "rtl"; otherwise, it\'s "ltr".',
+  },
+  '@@bidi_start_edge': {
+    message: '<left|right>',
+    description:
+      'If the `@@bidi_dir` is "ltr", then this is "left"; otherwise, it\'s "right".',
+  },
+  '@@bidi_end_edge': {
+    message: '<right|left>',
+    description:
+      'If the `@@bidi_dir` is "ltr", then this is "right"; otherwise, it\'s "left".',
+  },
+};
+
+const EXT_FORMATS_MAP: Record<string, MessageFormat> = {
+  '.json': 'JSON5',
+  '.jsonc': 'JSON5',
+  '.json5': 'JSON5',
+  '.yaml': 'YAML',
+  '.yml': 'YAML',
+  '.toml': 'TOML',
+};
+
+const PARSERS: Record<MessageFormat, (text: string) => any> = {
+  YAML: parseYAML,
+  JSON5: parseJSON5,
+  TOML: parseTOML,
+};
+
+const ALLOWED_CHROME_MESSAGE_KEYS: Set<string> = new Set<keyof ChromeMessage>([
+  'description',
+  'message',
+  'placeholders',
+]);
+
+//
+// PARSING
+//
+
+/**
+ * Parse a messages file, extract the messages. Supports JSON, JSON5, and YAML.
+ */
+export async function parseMessagesFile(
+  file: string,
+): Promise<ParsedMessage[]> {
+  const text = await readFile(file, 'utf8');
+  const ext = extname(file).toLowerCase();
+  return parseMessagesText(text, EXT_FORMATS_MAP[ext] ?? 'JSON5');
+}
+
+/**
+ * Parse a string, extracting the messages. Supports JSON, JSON5, and YAML.
+ */
+export function parseMessagesText(
+  text: string,
+  format: 'JSON5' | 'YAML' | 'TOML',
+): ParsedMessage[] {
+  return parseMessagesObject(PARSERS[format](text));
+}
+
+/**
+ * Given the JS object form of a raw messages file, extract the messages.
+ */
+export function parseMessagesObject(object: any): ParsedMessage[] {
+  return _parseMessagesObject(
+    [],
+    {
+      ...object,
+      ...PREDEFINED_MESSAGES,
+    },
+    0,
+  );
+}
+
+function _parseMessagesObject(
+  path: string[],
+  object: any,
+  depth: number,
+): ParsedMessage[] {
+  switch (typeof object) {
+    case 'string':
+    case 'bigint':
+    case 'boolean':
+    case 'number':
+    case 'symbol': {
+      const message = String(object);
+      const substitutions = getSubstitionCount(message);
+      return [
+        {
+          type: 'simple',
+          key: path,
+          substitutions,
+          message,
+        },
+      ];
+    }
+    case 'object':
+      if (Array.isArray(object))
+        return object.flatMap((item, i) =>
+          _parseMessagesObject(path.concat(String(i)), item, depth + 1),
+        );
+      if (isPluralMessage(object)) {
+        const message = Object.values(object).join('|');
+        const substitutions = getSubstitionCount(message);
+        return [
+          {
+            type: 'plural',
+            key: path,
+            substitutions,
+            plurals: object,
+          },
+        ];
+      }
+      if (depth === 1 && isChromeMessage(object)) {
+        const message = applyChromeMessagePlaceholders(object);
+        const substitutions = getSubstitionCount(message);
+        return [
+          {
+            type: 'chrome',
+            key: path,
+            substitutions,
+            ...object,
+          },
+        ];
+      }
+      return Object.entries(object).flatMap(([key, value]) =>
+        _parseMessagesObject(path.concat(key), value, depth + 1),
+      );
+    default:
+      throw Error(`"Could not parse object of type "${typeof object}"`);
+  }
+}
+
+function isPluralMessage(object: any): object is Record<number | 'n', string> {
+  return Object.keys(object).every(
+    (key) => key === 'n' || isFinite(Number(key)),
+  );
+}
+
+function isChromeMessage(object: any): object is ChromeMessage {
+  return Object.keys(object).every((key) =>
+    ALLOWED_CHROME_MESSAGE_KEYS.has(key),
+  );
+}
+
+//
+// OUTPUT
+//
+
+export function generateTypeText(messages: ParsedMessage[]): string {
+  const renderMessageEntry = (message: ParsedMessage): string => {
+    // Use . for deep keys at runtime and types
+    const key = message.key.join('.');
+
+    const features = [
+      `substitutions: ${message.substitutions}`,
+      `plural: ${message.type === 'plural'}`,
+    ];
+    return `  "${key}": { ${features.join(', ')} };`;
+  };
+
+  return `export type GeneratedI18nStructure = {
+${messages.map(renderMessageEntry).join('\n')}
+}
+`;
+}
+
+export async function generateTypeFile(
+  outFile: string,
+  messages: ParsedMessage[],
+): Promise<void> {
+  const text = generateTypeText(messages);
+  await mkdir(dirname(outFile), { recursive: true });
+  await writeFile(outFile, text, 'utf8');
+}
+
+export function generateChromeMessages(
+  messages: ParsedMessage[],
+): Record<string, ChromeMessage> {
+  return messages.reduce<Record<string, ChromeMessage>>((acc, message) => {
+    // Use _ for deep keys in _locales/.../messages.json
+    const key = message.key.join('_');
+    // Don't output predefined messages
+    if (PREDEFINED_MESSAGES[key]) return acc;
+
+    switch (message.type) {
+      case 'chrome':
+        acc[key] = {
+          message: message.message,
+          description: message.description,
+          placeholders: message.placeholders,
+        };
+        break;
+      case 'plural':
+        acc[key] = {
+          message: Object.values(message.plurals).join(' | '),
+        };
+        break;
+      case 'simple':
+        acc[key] = {
+          message: message.message,
+        };
+        break;
+    }
+    return acc;
+  }, {});
+}
+
+export function generateChromeMessagesText(messages: ParsedMessage[]): string {
+  const raw = generateChromeMessages(messages);
+  return JSON.stringify(raw, null, 2);
+}
+
+export async function generateChromeMessagesFile(
+  file: string,
+  messages: ParsedMessage[],
+): Promise<void> {
+  const text = generateChromeMessagesText(messages);
+  await writeFile(file, text + '\n', 'utf8');
+}

packages/i18n/src/index.ts

@@ -0,0 +1,82 @@
+/**
+ * @module @wxt-dev/i18n
+ */
+import {
+  I18nStructure,
+  DefaultI18nStructure,
+  I18n,
+  Substitution,
+  GetMessageOptions,
+} from './types';
+
+export function createI18n<
+  T extends I18nStructure = DefaultI18nStructure,
+>(): I18n<T> {
+  const t = (key: string, ...args: any[]) => {
+    // Resolve args
+    let sub: Substitution[] | undefined;
+    let count: number | undefined;
+    let options: GetMessageOptions | undefined;
+    args.forEach((arg, i) => {
+      if (arg == null) {
+        // ignore nullish args
+      } else if (typeof arg === 'number') {
+        count = arg;
+      } else if (Array.isArray(arg)) {
+        sub = arg;
+      } else if (typeof arg === 'object') {
+        options = arg;
+      } else {
+        throw Error(
+          `Unknown argument at index ${i}. Must be a number for pluralization, substitution array, or options object.`,
+        );
+      }
+    });
+
+    // Default substitutions to [n]
+    if (count != null && sub == null) {
+      sub = [String(count)];
+    }
+
+    // Load the localization
+    let message: string;
+    if (sub?.length) {
+      // Convert all substitutions to strings
+      const stringSubs = sub?.map((sub) => String(sub));
+      message = chrome.i18n.getMessage(
+        key.replaceAll('.', '_'),
+        stringSubs,
+        // @ts-ignore - @types/chrome doesn't type the options object, but it's there
+        options,
+      );
+    } else {
+      message = chrome.i18n.getMessage(
+        key.replaceAll('.', '_'),
+        // @ts-ignore - @types/chrome doesn't type the options object, but it's there
+        options,
+      );
+    }
+    if (!message) {
+      console.warn(`[i18n] Message not found: "${key}"`);
+    }
+    if (count == null) return message;
+
+    // Apply pluralization
+    const plural = message.split(' | ');
+    switch (plural.length) {
+      // "n items"
+      case 1:
+        return plural[0];
+      // "1 item | n items"
+      case 2:
+        return plural[count === 1 ? 0 : 1];
+      // "0 items | 1 item | n items"
+      case 3:
+        return plural[count === 0 || count === 1 ? count : 2];
+      default:
+        throw Error('Unknown plural formatting');
+    }
+  };
+
+  return { t } as I18n<T>;
+}

packages/i18n/src/module.ts

@@ -0,0 +1,162 @@
+/**
+ * The WXT Module to integrate `@wxt-dev/i18n` into your project.
+ *
+ * ```ts
+ * export default defineConfig({
+ *   modules: ["@wxt-dev/i18n/module"],
+ * });
+ * ```
+ *
+ * @module @wxt-dev/i18n/module
+ */
+
+import 'wxt';
+import { addAlias, defineWxtModule } from 'wxt/modules';
+import {
+  generateChromeMessagesText,
+  parseMessagesFile,
+  generateTypeText,
+} from './build';
+import glob from 'fast-glob';
+import { basename, extname, join, resolve } from 'node:path';
+import { watch } from 'chokidar';
+import { GeneratedPublicFile, WxtDirFileEntry } from 'wxt';
+import { writeFile } from 'node:fs/promises';
+
+export default defineWxtModule({
+  name: '@wxt-dev/i18n',
+  imports: [{ from: '#i18n', name: 'i18n' }],
+
+  setup(wxt) {
+    if (wxt.config.manifest.default_locale == null) {
+      wxt.logger.warn(
+        `\`[i18n]\` manifest.default_locale not set, \`@wxt-dev/i18n\` disabled.`,
+      );
+      return;
+    }
+    wxt.logger.info(
+      '`[i18n]` Default locale: ' + wxt.config.manifest.default_locale,
+    );
+
+    const getLocalizationFiles = async () => {
+      const files = await glob('locales/*', {
+        cwd: wxt.config.srcDir,
+        absolute: true,
+      });
+      return files.map((file) => ({
+        file,
+        locale: basename(file).replace(extname(file), ''),
+      }));
+    };
+
+    const generateOutputJsonFiles = async (): Promise<
+      GeneratedPublicFile[]
+    > => {
+      const files = await getLocalizationFiles();
+      return await Promise.all(
+        files.map(async ({ file, locale }) => {
+          const messages = await parseMessagesFile(file);
+          return {
+            contents: generateChromeMessagesText(messages),
+            relativeDest: join('_locales', locale, 'messages.json'),
+          };
+        }),
+      );
+    };
+
+    const generateTypes = async (): Promise<WxtDirFileEntry> => {
+      const files = await getLocalizationFiles();
+      const defaultLocaleFile = files.find(
+        ({ locale }) => locale === wxt.config.manifest.default_locale,
+      )!;
+      if (defaultLocaleFile == null) {
+        throw Error(
+          `\`[i18n]\` Required localization file does not exist: \`<srcDir>/locales/${wxt.config.manifest.default_locale}.{json|json5|yml|yaml|toml}\``,
+        );
+      }
+
+      const messages = await parseMessagesFile(defaultLocaleFile.file);
+      return {
+        path: typesPath,
+        text: generateTypeText(messages),
+      };
+    };
+
+    const updateLocalizations = async (file: string): Promise<void> => {
+      wxt.logger.info(
+        `\`[i18n]\` Localization file changed: \`${basename(file)}\``,
+      );
+
+      // Regenerate files
+      const [typesFile, jsonFiles] = await Promise.all([
+        generateTypes(),
+        generateOutputJsonFiles(),
+      ]);
+
+      // Write files to disk
+      await Promise.all([
+        writeFile(
+          resolve(wxt.config.wxtDir, typesFile.path),
+          typesFile.text,
+          'utf8',
+        ),
+        ...jsonFiles.map((file) =>
+          writeFile(
+            resolve(wxt.config.outDir, file.relativeDest),
+            file.contents,
+            'utf8',
+          ),
+        ),
+      ]);
+
+      // TODO: Implement HMR instead of reloading extension. The reload is
+      // fast, but it causes the popup to close, which I'd like to prevent.
+      wxt.server?.reloadExtension();
+      wxt.logger.success(`\`[i18n]\` Extension reloaded`);
+    };
+
+    // Create .wxt/i18n.ts
+
+    const sourcePath = resolve(wxt.config.wxtDir, 'i18n/index.ts');
+    const typesPath = resolve(wxt.config.wxtDir, 'i18n/structure.d.ts');
+
+    wxt.hooks.hook('prepare:types', async (_, entries) => {
+      entries.push({
+        path: sourcePath,
+        text: `import { createI18n } from '@wxt-dev/i18n';
+import type { GeneratedI18nStructure } from './structure';
+
+export const i18n = createI18n<GeneratedI18nStructure>();
+
+export { GeneratedI18nStructure }
+`,
+      });
+    });
+
+    addAlias(wxt, '#i18n', sourcePath);
+
+    // Generate separate declaration file containing types - this prevents
+    // firing the dev server's default file watcher when updating the types,
+    // which would cause a full rebuild and reload of the extension.
+
+    wxt.hooks.hook('prepare:types', async (_, entries) => {
+      entries.push(await generateTypes());
+    });
+
+    // Generate _locales/.../messages.json files
+
+    wxt.hooks.hook('build:publicAssets', async (_, assets) => {
+      const outFiles = await generateOutputJsonFiles();
+      assets.push(...outFiles);
+    });
+
+    // Reload extension during development
+
+    if (wxt.config.command === 'serve') {
+      wxt.hooks.hookOnce('build:done', () => {
+        const watcher = watch(resolve(wxt.config.srcDir, 'locales'));
+        watcher.on('change', updateLocalizations);
+      });
+    }
+  },
+});

packages/i18n/src/types.ts

@@ -0,0 +1,89 @@
+export interface I18nFeatures {
+  plural: boolean;
+  substitutions: SubstitutionCount;
+}
+
+export type I18nStructure = {
+  [K: string]: I18nFeatures;
+};
+
+export type DefaultI18nStructure = {
+  [K: string]: any;
+};
+
+// prettier-ignore
+export type SubstitutionTuple<T extends SubstitutionCount> =
+    T extends 1 ? [$1: Substitution]
+  : T extends 2 ? [$1: Substitution, $2: Substitution]
+  : T extends 3 ? [$1: Substitution, $2: Substitution, $3: Substitution]
+  : T extends 4 ? [$1: Substitution, $2: Substitution, $3: Substitution, $4: Substitution]
+  : T extends 5 ? [$1: Substitution, $2: Substitution, $3: Substitution, $4: Substitution, $5: Substitution]
+  : T extends 6 ? [$1: Substitution, $2: Substitution, $3: Substitution, $4: Substitution, $5: Substitution, $6: Substitution]
+  : T extends 7 ? [$1: Substitution, $2: Substitution, $3: Substitution, $4: Substitution, $5: Substitution, $6: Substitution, $7: Substitution]
+  : T extends 8 ? [$1: Substitution, $2: Substitution, $3: Substitution, $4: Substitution, $5: Substitution, $6: Substitution, $7: Substitution, $8: Substitution]
+  : T extends 9 ? [$1: Substitution, $2: Substitution, $3: Substitution, $4: Substitution, $5: Substitution, $6: Substitution, $7: Substitution, $8: Substitution, $9: Substitution]
+  : never
+
+export type TFunction<T extends I18nStructure> = {
+  // Non-plural, no substitutions
+  <K extends keyof T>(
+    // prettier-ignore
+    key: K & { [P in keyof T]: T[P] extends { plural: false; substitutions: 0 } ? P : never; }[keyof T],
+    options?: GetMessageOptions,
+  ): string;
+
+  // Non-plural with substitutions
+  <K extends keyof T>(
+    // prettier-ignore
+    key: K & { [P in keyof T]: T[P] extends { plural: false; substitutions: SubstitutionCount } ? P : never; }[keyof T],
+    substitutions: T[K] extends I18nFeatures
+      ? SubstitutionTuple<T[K]['substitutions']>
+      : never,
+    options?: GetMessageOptions,
+  ): string;
+
+  // Plural with 1 substitution
+  <K extends keyof T>(
+    // prettier-ignore
+    key: K & { [P in keyof T]: T[P] extends { plural: true; substitutions: 1 } ? P : never; }[keyof T],
+    n: number,
+    substitutions?: SubstitutionTuple<1>,
+    options?: GetMessageOptions,
+  ): string;
+
+  // Plural without substitutions
+  <K extends keyof T>(
+    // prettier-ignore
+    key: K & { [P in keyof T]: T[P] extends { plural: true; substitutions: 0 | 1 } ? P : never; }[keyof T],
+    n: number,
+    options?: GetMessageOptions,
+  ): string;
+
+  // Plural with substitutions
+  <K extends keyof T>(
+    // prettier-ignore
+    key: K & { [P in keyof T]: T[P] extends { plural: true; substitutions: SubstitutionCount } ? P : never; }[keyof T],
+    n: number,
+    substitutions: T[K] extends I18nFeatures
+      ? SubstitutionTuple<T[K]['substitutions']>
+      : never,
+    options?: GetMessageOptions,
+  ): string;
+};
+
+export interface I18n<T extends DefaultI18nStructure> {
+  t: TFunction<T>;
+}
+
+export type Substitution = string | number;
+
+export interface GetMessageOptions {
+  /**
+   * Escape `<` in translation to `&lt;`. This applies only to the message itself, not to the placeholders. Developers might want to use this if the translation is used in an HTML context. Closure Templates used with Closure Compiler generate this automatically.
+   *
+   * See https://developer.chrome.com/docs/extensions/reference/api/i18n#type-getMessage-options
+   */
+  escapeLt?: boolean;
+}
+
+type SubstitutionCount = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;

packages/i18n/src/utils.ts

@@ -0,0 +1,23 @@
+import { ChromeMessage } from './build';
+
+export function applyChromeMessagePlaceholders(message: ChromeMessage): string {
+  if (message.placeholders == null) return message.message;
+
+  return Object.entries(message.placeholders ?? {}).reduce(
+    (text, [name, value]) => {
+      return text.replaceAll(new RegExp(`\\$${name}\\$`, 'gi'), value.content);
+    },
+    message.message,
+  );
+}
+
+export function getSubstitionCount(message: string): number {
+  return (
+    1 +
+    new Array(MAX_SUBSTITUTIONS).findLastIndex((_, i) =>
+      message.match(new RegExp(`(?<!\\$)\\$${i + 1}`)),
+    )
+  );
+}
+
+const MAX_SUBSTITUTIONS = 9;

packages/i18n/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "types": ["chrome", "node"]
+  },
+  "exclude": ["node_modules/**", "dist/**"]
+}

packages/i18n/vitest.config.ts

@@ -0,0 +1,10 @@
+import { defineProject } from 'vitest/config';
+import RandomSeed from 'vitest-plugin-random-seed';
+
+export default defineProject({
+  test: {
+    mockReset: true,
+    restoreMocks: true,
+  },
+  plugins: [RandomSeed()],
+});

packages/module-react/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## v1.1.1
+
+[compare changes](https://github.com/wxt-dev/wxt/compare/module-react-v1.1.0...module-react-v1.1.1)
+
+### 🏡 Chore
+
+- **deps:** Bump all non-major dependencies ([#834](https://github.com/wxt-dev/wxt/pull/834))
+- **deps:** Upgrade all dependencies ([#869](https://github.com/wxt-dev/wxt/pull/869))
+- Add more metadata for npm ([#885](https://github.com/wxt-dev/wxt/pull/885))
+
+### ❤️ Contributors
+
+- Florian Metz ([@Timeraa](http://github.com/Timeraa))
+
 ## v1.1.0
 
 [compare changes](https://github.com/wxt-dev/wxt/compare/module-react-v1.0.0...module-react-v1.1.0)

packages/module-react/modules/react.ts

@@ -9,7 +9,6 @@ export default defineWxtModule<ReactModuleOptions>({
     const { vite } = options ?? {};
 
     addViteConfig(wxt, () => ({
-      // @ts-expect-error: Vite version conflicts
       plugins: [react(vite)],
     }));
 

packages/module-react/package.json

@@ -1,6 +1,23 @@
 {
   "name": "@wxt-dev/module-react",
-  "version": "1.1.0",
+  "description": "WXT module to enable React support",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/wxt-dev/wxt.git",
+    "directory": "packages/module-react"
+  },
+  "homepage": "https://github.com/wxt-dev/wxt/blob/main/packages/module-react/README.md",
+  "keywords": [
+    "wxt",
+    "module",
+    "react"
+  ],
+  "author": {
+    "name": "Aaron Klinker",
+    "email": "aaronklinker1+wxt@gmail.com"
+  },
+  "license": "MIT",
+  "version": "1.1.1",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
@@ -22,7 +39,7 @@
   ],
   "scripts": {
     "dev": "wxt",
-    "check": "buildc --deps-only -- check",
+    "check": "pnpm build && check",
     "build": "buildc -- unbuild",
     "prepare": "buildc --deps-only -- wxt prepare"
   },
@@ -39,7 +56,7 @@
     "publint": "^0.2.9",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
-    "typescript": "^5.5.3",
+    "typescript": "^5.5.4",
     "unbuild": "^2.0.0",
     "wxt": "workspace:*"
   }

packages/module-solid/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## v1.1.2
+
+[compare changes](https://github.com/wxt-dev/wxt/compare/module-solid-v1.1.1...module-solid-v1.1.2)
+
+### 🏡 Chore
+
+- **deps:** Bump all non-major dependencies ([#834](https://github.com/wxt-dev/wxt/pull/834))
+- **deps:** Upgrade all dependencies ([#869](https://github.com/wxt-dev/wxt/pull/869))
+- Add more metadata for npm ([#885](https://github.com/wxt-dev/wxt/pull/885))
+
+### ❤️ Contributors
+
+- Florian Metz ([@Timeraa](http://github.com/Timeraa))
+
 ## v1.1.1
 
 [compare changes](https://github.com/wxt-dev/wxt/compare/module-solid-v1.1.0...module-solid-v1.1.1)

packages/module-solid/modules/solid.ts

@@ -9,7 +9,6 @@ export default defineWxtModule<SolidModuleOptions>({
     const { vite } = options ?? {};
 
     addViteConfig(wxt, () => ({
-      // @ts-expect-error: Vite version mismatch
       plugins: [solid(vite)],
       build: {
         target: 'esnext',

packages/module-solid/package.json

@@ -1,6 +1,23 @@
 {
   "name": "@wxt-dev/module-solid",
-  "version": "1.1.1",
+  "description": "WXT module to enable SolidJS support",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/wxt-dev/wxt.git",
+    "directory": "packages/module-solid"
+  },
+  "homepage": "https://github.com/wxt-dev/wxt/blob/main/packages/module-solid/README.md",
+  "keywords": [
+    "wxt",
+    "module",
+    "solidjs"
+  ],
+  "author": {
+    "name": "Aaron Klinker",
+    "email": "aaronklinker1+wxt@gmail.com"
+  },
+  "license": "MIT",
+  "version": "1.1.2",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
@@ -22,7 +39,7 @@
   ],
   "scripts": {
     "dev": "wxt",
-    "check": "buildc --deps-only -- check",
+    "check": "pnpm build && check",
     "build": "buildc -- unbuild",
     "prepare": "buildc --deps-only -- wxt prepare"
   },
@@ -35,8 +52,8 @@
   "devDependencies": {
     "@aklinker1/check": "^1.3.1",
     "publint": "^0.2.9",
-    "solid-js": "^1.8.18",
-    "typescript": "^5.5.3",
+    "solid-js": "^1.8.19",
+    "typescript": "^5.5.4",
     "unbuild": "^2.0.0",
     "wxt": "workspace:*"
   }

packages/module-svelte/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Changelog
 
+## v1.0.1
+
+[compare changes](https://github.com/wxt-dev/wxt/compare/module-svelte-v1.0.0...module-svelte-v1.0.1)
+
+### 🩹 Fixes
+
+- Upgrade wxt peer to >= 0.18.6 ([7edf1c8](https://github.com/wxt-dev/wxt/commit/7edf1c8))
+
+### 📖 Documentation
+
+- Fix link to unimport ([#826](https://github.com/wxt-dev/wxt/pull/826))
+
+### 🏡 Chore
+
+- Add changelog ([21e8ca0](https://github.com/wxt-dev/wxt/commit/21e8ca0))
+- Extract build cache script to NPM package ([#737](https://github.com/wxt-dev/wxt/pull/737))
+- **deps:** Upgrade non-major deps ([#778](https://github.com/wxt-dev/wxt/pull/778))
+- **deps:** Bump all non-major dependencies ([#834](https://github.com/wxt-dev/wxt/pull/834))
+- **deps:** Upgrade all dependencies ([#869](https://github.com/wxt-dev/wxt/pull/869))
+- Add more metadata for npm ([#885](https://github.com/wxt-dev/wxt/pull/885))
+
+### ❤️ Contributors
+
+- Florian Metz ([@Timeraa](http://github.com/Timeraa))
+- Eetann ([@eetann](http://github.com/eetann))
+
 ## v1.0.0
 
-Initial release 🎉
+Initial release 🎉

packages/module-svelte/package.json

@@ -1,6 +1,23 @@
 {
   "name": "@wxt-dev/module-svelte",
-  "version": "1.0.0",
+  "description": "WXT module to enable Svelte support",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/wxt-dev/wxt.git",
+    "directory": "packages/module-svelte"
+  },
+  "homepage": "https://github.com/wxt-dev/wxt/blob/main/packages/module-svelte/README.md",
+  "keywords": [
+    "wxt",
+    "module",
+    "svelte"
+  ],
+  "author": {
+    "name": "Aaron Klinker",
+    "email": "aaronklinker1+wxt@gmail.com"
+  },
+  "license": "MIT",
+  "version": "1.0.1",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
@@ -22,7 +39,7 @@
   ],
   "scripts": {
     "build": "buildc -- unbuild",
-    "check": "buildc --deps-only -- check"
+    "check": "pnpm build && check"
   },
   "peerDependencies": {
     "wxt": ">=0.18.6"
@@ -33,7 +50,7 @@
   "devDependencies": {
     "@aklinker1/check": "^1.3.1",
     "publint": "^0.2.9",
-    "typescript": "^5.5.3",
+    "typescript": "^5.5.4",
     "unbuild": "^2.0.0",
     "wxt": "workspace:*"
   }

packages/module-svelte/src/index.ts

@@ -14,7 +14,6 @@ export default defineWxtModule<SvelteModuleOptions>({
 
     addViteConfig(wxt, () => ({
       plugins: [
-        // @ts-expect-error: Vite version mismatch
         svelte({
           // Using a svelte.config.js file causes a segmentation fault when importing the file
           configFile: false,

packages/module-vue/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## v1.0.1
+
+[compare changes](https://github.com/wxt-dev/wxt/compare/module-vue-v1.0.0...module-vue-v1.0.1)
+
+### 🩹 Fixes
+
+- Upgrade wxt peer to >= 0.18.6 ([7edf1c8](https://github.com/wxt-dev/wxt/commit/7edf1c8))
+
+### 🏡 Chore
+
+- Add changelog ([21e8ca0](https://github.com/wxt-dev/wxt/commit/21e8ca0))
+- Extract build cache script to NPM package ([#737](https://github.com/wxt-dev/wxt/pull/737))
+- **deps:** Upgrade non-major deps ([#778](https://github.com/wxt-dev/wxt/pull/778))
+- **deps:** Bump all non-major dependencies ([#834](https://github.com/wxt-dev/wxt/pull/834))
+- **deps:** Upgrade all dependencies ([#869](https://github.com/wxt-dev/wxt/pull/869))
+- Add more metadata for npm ([#885](https://github.com/wxt-dev/wxt/pull/885))
+
+### ❤️ Contributors
+
+- Florian Metz ([@Timeraa](http://github.com/Timeraa))
+
 ## v1.0.0
 
-Initial release 🎉
+Initial release 🎉

packages/module-vue/package.json

@@ -1,6 +1,23 @@
 {
   "name": "@wxt-dev/module-vue",
-  "version": "1.0.0",
+  "description": "WXT module to enable Vue support",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/wxt-dev/wxt.git",
+    "directory": "packages/module-vue"
+  },
+  "homepage": "https://github.com/wxt-dev/wxt/blob/main/packages/module-vue/README.md",
+  "keywords": [
+    "wxt",
+    "module",
+    "vue"
+  ],
+  "author": {
+    "name": "Aaron Klinker",
+    "email": "aaronklinker1+wxt@gmail.com"
+  },
+  "license": "MIT",
+  "version": "1.0.1",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
@@ -22,18 +39,18 @@
   ],
   "scripts": {
     "build": "buildc -- unbuild",
-    "check": "buildc --deps-only -- check"
+    "check": "pnpm build && check"
   },
   "peerDependencies": {
     "wxt": ">=0.18.6"
   },
   "dependencies": {
-    "@vitejs/plugin-vue": "^5.0.5"
+    "@vitejs/plugin-vue": "^5.1.1"
   },
   "devDependencies": {
     "@aklinker1/check": "^1.3.1",
     "publint": "^0.2.9",
-    "typescript": "^5.5.3",
+    "typescript": "^5.5.4",
     "unbuild": "^2.0.0",
     "wxt": "workspace:*"
   }

packages/wxt-demo/package.json

@@ -17,21 +17,22 @@
     "postinstall": "buildc --deps-only -- wxt prepare"
   },
   "dependencies": {
+    "@wxt-dev/i18n": "workspace:*",
     "react": "^18.3.1",
     "react-dom": "^18.3.1"
   },
   "devDependencies": {
-    "@types/chrome": "^0.0.268",
+    "@types/chrome": "^0.0.269",
     "@types/react": "^18.3.3",
     "@types/react-dom": "^18.3.0",
     "@wxt-dev/auto-icons": "workspace:*",
     "sass": "^1.77.8",
-    "typescript": "^5.5.3",
-    "vitest": "^2.0.3",
+    "typescript": "^5.5.4",
+    "vitest": "^2.0.4",
     "vitest-plugin-random-seed": "^1.1.0",
     "wxt": "workspace:*"
   },
   "buildc": {
-    "outDir": ".output/chrome-mv3"
+    "cachable": false
   }
 }

packages/wxt-demo/src/entrypoints/__tests__/background.test.ts

@@ -1,7 +1,7 @@
 import { beforeEach, describe, expect, it, vi } from 'vitest';
 import background from '../background';
 
-browser.i18n.getMessage = () => 'fake-message';
+chrome.i18n.getMessage = () => 'fake-message';
 
 const logMock = vi.fn();
 console.log = logMock;

packages/wxt-demo/src/entrypoints/background.ts

@@ -1,5 +1,3 @@
-import messages from '~/public/_locales/en/messages.json';
-
 export default defineBackground({
   // type: 'module',
 
@@ -12,7 +10,6 @@ export default defineBackground({
       chrome: import.meta.env.CHROME,
       firefox: import.meta.env.FIREFOX,
       manifestVersion: import.meta.env.MANIFEST_VERSION,
-      messages,
     });
 
     console.log(useAppConfig());
@@ -27,11 +24,14 @@ export default defineBackground({
     browser.runtime.getURL('/icon-128.png?query=param');
 
     // @ts-expect-error: should only accept known message names
-    browser.i18n.getMessage('test');
-    browser.i18n.getMessage('prompt_for_name');
-    browser.i18n.getMessage('hello', 'Aaron');
-    browser.i18n.getMessage('bye', ['Aaron']);
-    browser.i18n.getMessage('@@extension_id');
+    i18n.t('test');
+    i18n.t('prompt_for_name');
+    i18n.t('hello', ['test']);
+    i18n.t('bye', ['Aaron']);
+    i18n.t('@@extension_id');
+    i18n.t('deep.example');
+    i18n.t('items', 0);
+    i18n.t('items', 0, ['one']);
 
     console.log('WXT MODE:', {
       MODE: import.meta.env.MODE,

packages/wxt-demo/src/entrypoints/ui.content/index.ts

@@ -13,7 +13,7 @@ export default defineContentScript({
       anchor: 'form[role=search]',
       onMount: (container) => {
         const app = document.createElement('div');
-        app.textContent = browser.i18n.getMessage('prompt_for_name');
+        app.textContent = i18n.t('prompt_for_name');
         container.append(app);
       },
     });

packages/wxt-demo/src/locales/en.yml

@@ -0,0 +1,25 @@
+prompt_for_name:
+  message: What's your name?
+  description: Ask for the user's name
+hello:
+  message: Hello, $USER$
+  description: Greet the user
+  placeholders:
+    user:
+      content: $1
+      example: Cira
+bye:
+  message: Goodbye, $USER$. Come back to $OUR_SITE$ soon!
+  description: Say goodbye to the user
+  placeholders:
+    our_site:
+      content: Example.com
+    user:
+      content: $1
+      example: Cira
+deep:
+  example: 'this is deep'
+items:
+  0: Zero items
+  1: 1 item
+  n: $1 items

packages/wxt-demo/src/modules/i18n.ts

@@ -0,0 +1,3 @@
+import module from '@wxt-dev/i18n/module';
+
+export default module;

packages/wxt-demo/src/public/_locales/en/messages.json

@@ -1,29 +0,0 @@
-{
-  "prompt_for_name": {
-    "message": "What's your name?",
-    "description": "Ask for the user's name"
-  },
-  "hello": {
-    "message": "Hello, $USER$",
-    "description": "Greet the user",
-    "placeholders": {
-      "user": {
-        "content": "$1",
-        "example": "Cira"
-      }
-    }
-  },
-  "bye": {
-    "message": "Goodbye, $USER$. Come back to $OUR_SITE$ soon!",
-    "description": "Say goodbye to the user",
-    "placeholders": {
-      "our_site": {
-        "content": "Example.com"
-      },
-      "user": {
-        "content": "$1",
-        "example": "Cira"
-      }
-    }
-  }
-}

packages/wxt-demo/vitest.config.ts

@@ -6,8 +6,5 @@ export default defineProject({
     mockReset: true,
     restoreMocks: true,
   },
-  plugins: [
-    // @ts-expect-error: Vite version mismatch
-    WxtVitest(),
-  ],
+  plugins: [WxtVitest()],
 });

packages/wxt/CHANGELOG.md

@@ -1,5 +1,117 @@
 # Changelog
 
+## v0.19.7
+
+[compare changes](https://github.com/wxt-dev/wxt/compare/wxt-v0.19.6...wxt-v0.19.7)
+
+### 🚀 Enhancements
+
+- **testing:** Run WXT modules when setting up test environment ([#926](https://github.com/wxt-dev/wxt/pull/926))
+- **modules:** Add `addAlias` helper ([#928](https://github.com/wxt-dev/wxt/pull/928))
+
+### 🩹 Fixes
+
+- **testing:** Stub `chrome` and `browser` globals with `fakeBrowser` automatically ([#925](https://github.com/wxt-dev/wxt/pull/925))
+- Ensure TSConfig paths start with `../` or  `./` so they are valid ([#927](https://github.com/wxt-dev/wxt/pull/927))
+
+### 📖 Documentation
+
+- Fix module name for `wxt/browser/chrome` ([751706d](https://github.com/wxt-dev/wxt/commit/751706d))
+
+### 🏡 Chore
+
+- Remove warning log for missing public directory ([5f2e1c3](https://github.com/wxt-dev/wxt/commit/5f2e1c3))
+
+## v0.19.6
+
+[compare changes](https://github.com/wxt-dev/wxt/compare/wxt-v0.19.5...wxt-v0.19.6)
+
+### 🔥 Performance
+
+- Ignore non-source code from the file watcher ([#919](https://github.com/wxt-dev/wxt/pull/919))
+
+### 🩹 Fixes
+
+- Typo in sidepanel options (`browse_style` → `browser_style`) ([#914](https://github.com/wxt-dev/wxt/pull/914))
+- **types:** Don't report type errors when using string templates with `browser.i18n.getMessage` ([#916](https://github.com/wxt-dev/wxt/pull/916))
+
+### ❤️ Contributors
+
+- 1natsu ([@1natsu](https://github.com/1natsu172))
+
+## v0.19.5
+
+[compare changes](https://github.com/wxt-dev/wxt/compare/wxt-v0.19.4...wxt-v0.19.5)
+
+### 🚀 Enhancements
+
+- Allow zipping hidden files by listing them explicitly in `includeSources` ([#902](https://github.com/wxt-dev/wxt/pull/902))
+- Allow excluding files when zipping ([#906](https://github.com/wxt-dev/wxt/pull/906))
+
+### 🩹 Fixes
+
+- #907 move wxt devDeps execa to dependencies ([#908](https://github.com/wxt-dev/wxt/pull/908), [#907](https://github.com/wxt-dev/wxt/issues/907))
+- Update chromium setting for enabling content script sourcemaps ([e6529e6](https://github.com/wxt-dev/wxt/commit/e6529e6))
+
+### ❤️ Contributors
+
+- 1natsu ([@1natsu](https://github.com/1natsu172))
+- Florian Metz ([@Timeraa](http://github.com/Timeraa))
+- Hikiko4ern ([@hikiko4ern](http://github.com/hikiko4ern))
+
+## v0.19.4
+
+[compare changes](https://github.com/wxt-dev/wxt/compare/wxt-v0.19.3...wxt-v0.19.4)
+
+### 🚀 Enhancements
+
+- Add `injectScript` helper ([#900](https://github.com/wxt-dev/wxt/pull/900))
+
+### 🩹 Fixes
+
+- Do not clear `.wxt/tsconfig.json` in `findEntrypoints` if it exists ([#898](https://github.com/wxt-dev/wxt/pull/898))
+- **types:** `PublicPath` type resolution with `extensionApi: "chrome"` ([#901](https://github.com/wxt-dev/wxt/pull/901))
+- Fix `createIframeUi` `page` option types ([3a8e613](https://github.com/wxt-dev/wxt/commit/3a8e613))
+
+### ❤️ Contributors
+
+- Hikiko4ern ([@hikiko4ern](http://github.com/hikiko4ern))
+
+## v0.19.3
+
+[compare changes](https://github.com/wxt-dev/wxt/compare/wxt-v0.19.2...wxt-v0.19.3)
+
+### 🩹 Fixes
+
+- Add `consola` to `wxt` dependencies ([#892](https://github.com/wxt-dev/wxt/pull/892))
+- **content-script-context:** Fix initialization logic for Firefox ([#895](https://github.com/wxt-dev/wxt/pull/895))
+
+### 📖 Documentation
+
+- Improve `prepare:types` hook JSDoc ([#886](https://github.com/wxt-dev/wxt/pull/886))
+
+### ❤️ Contributors
+
+- Hikiko4ern ([@hikiko4ern](http://github.com/hikiko4ern))
+- Himanshu Patil ([@mehimanshupatil](https://github.com/mehimanshupatil))
+
+## v0.19.2
+
+[compare changes](https://github.com/wxt-dev/wxt/compare/wxt-v0.19.1...wxt-v0.19.2)
+
+### 🩹 Fixes
+
+- Remove unused top-level functions and variables when loading entrypoints with the `vite-node` loader ([#875](https://github.com/wxt-dev/wxt/pull/875))
+- Don't default to dev mode for production builds when using `vite-node` loader ([#877](https://github.com/wxt-dev/wxt/pull/877))
+
+### 📖 Documentation
+
+- Update README and homepage features with WXT modules ([ed07a49](https://github.com/wxt-dev/wxt/commit/ed07a49))
+
+### 🏡 Chore
+
+- **deps:** Upgrade all dependencies ([#869](https://github.com/wxt-dev/wxt/pull/869))
+
 ## v0.19.1
 
 [compare changes](https://github.com/wxt-dev/wxt/compare/wxt-v0.19.0...wxt-v0.19.1)
@@ -8,6 +120,10 @@
 
 - Auto Icons Module ([#851](https://github.com/wxt-dev/wxt/pull/851))
 
+### 🔥 Performance
+
+- Tree-shake unrelated code inside `vite-node` entrypoint loader ([#867](https://github.com/wxt-dev/wxt/pull/867))
+
 ### 🩹 Fixes
 
 - Define web globals when importing entrypoints ([#865](https://github.com/wxt-dev/wxt/pull/865))

packages/wxt/README.md

@@ -59,6 +59,7 @@ Or see the [installation guide](https://wxt.dev/guide/installation.html) to get
 - 🦾 Auto-imports
 - 🤖 Automated publishing
 - 🎨 Frontend framework agnostic: works with Vue, React, Svelte, etc
+- 📦 Modular architecture with [WXT modules](https://wxt.dev/guide/go-further/reusable-modules.html#overview)
 - 🖍️ Quickly bootstrap a new project
 - 📏 Bundle analysis
 - ⬇️ Download and bundle remote URL imports

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

@@ -19,6 +19,7 @@ exports[`Auto Imports > eslintrc > "enabled: 8" should output a JSON config file
     "defineUnlistedScript": true,
     "defineWxtPlugin": true,
     "fakeBrowser": true,
+    "injectScript": true,
     "storage": true,
     "useAppConfig": true
   }
@@ -44,6 +45,7 @@ const globals = {
   "defineUnlistedScript": true,
   "defineWxtPlugin": true,
   "fakeBrowser": true,
+  "injectScript": true,
   "storage": true,
   "useAppConfig": true
 }
@@ -77,6 +79,7 @@ exports[`Auto Imports > eslintrc > "enabled: true" should output a JSON config f
     "defineUnlistedScript": true,
     "defineWxtPlugin": true,
     "fakeBrowser": true,
+    "injectScript": true,
     "storage": true,
     "useAppConfig": true
   }
@@ -103,6 +106,7 @@ exports[`Auto Imports > eslintrc > should allow customizing the output 1`] = `
     "defineUnlistedScript": "readonly",
     "defineWxtPlugin": "readonly",
     "fakeBrowser": "readonly",
+    "injectScript": "readonly",
     "storage": "readonly",
     "useAppConfig": "readonly"
   }

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

@@ -31,6 +31,7 @@ describe('Auto Imports', () => {
             const defineUnlistedScript: typeof import('wxt/sandbox')['defineUnlistedScript']
             const defineWxtPlugin: typeof import('wxt/sandbox')['defineWxtPlugin']
             const fakeBrowser: typeof import('wxt/testing')['fakeBrowser']
+            const injectScript: typeof import('wxt/client')['injectScript']
             const storage: typeof import('wxt/storage')['storage']
             const useAppConfig: typeof import('wxt/client')['useAppConfig']
           }

packages/wxt/e2e/tests/typescript-project.test.ts

@@ -126,7 +126,7 @@ describe('TypeScript Project', () => {
         export interface WxtI18n extends I18n.Static {
           /**
            * The extension or app ID; you might use this string to construct URLs for resources inside the extension. Even unlocalized extensions can use this message.
-      Note: You can't use this message in a manifest file.
+           * Note: You can't use this message in a manifest file.
            *
            * "<browser.runtime.id>"
            */
@@ -136,8 +136,6 @@ describe('TypeScript Project', () => {
             options?: GetMessageOptions,
           ): string;
           /**
-           * No message description.
-           *
            * "<browser.i18n.getUiLocale()>"
            */
           getMessage(
@@ -215,6 +213,11 @@ describe('TypeScript Project', () => {
             substitutions?: string | string[],
             options?: GetMessageOptions,
           ): string;
+          getMessage(
+            messageName: "@@extension_id" | "@@ui_locale" | "@@bidi_dir" | "@@bidi_reversed_dir" | "@@bidi_start_edge" | "@@bidi_end_edge" | "prompt_for_name" | "hello" | "bye",
+            substitutions?: string | string[],
+            options?: GetMessageOptions,
+          ): string;
         }
       }
       "
@@ -376,6 +379,22 @@ describe('TypeScript Project', () => {
     `);
   });
 
+  it('should start path aliases with "./" for paths inside the .wxt dir', async () => {
+    const project = new TestProject();
+    project.addFile('src/entrypoints/unlisted.html', '<html></html>');
+    project.setConfigFileConfig({
+      srcDir: 'src',
+      alias: {
+        example: '.wxt/example.ts',
+      },
+    });
+
+    await project.prepare();
+
+    const output = await project.serializeFile('.wxt/tsconfig.json');
+    expect(output).toContain('./example.ts');
+  });
+
   // TODO: Once a module has been published, use it here for testing - local files are never added to the .wxt/wxt.d.ts file
   it.todo(
     'should add modules from NPM to the TS project if they have a configKey',

packages/wxt/e2e/tests/zip.test.ts

@@ -97,8 +97,7 @@ describe('Zipping', () => {
     expect(await project.fileExists(sourcesZip)).toBe(true);
   });
 
-  // TODO: Fix #738 and re-enable
-  it.skip('should not zip hidden files into sources by default', async () => {
+  it('should not zip hidden files into sources by default', async () => {
     const project = new TestProject({
       name: 'test',
       version: '1.0.0',
@@ -108,6 +107,7 @@ describe('Zipping', () => {
       'export default defineBackground(() => {});',
     );
     project.addFile('.env');
+    project.addFile('.hidden-dir/file');
     const unzipDir = project.resolvePath('.output/test-1.0.0-sources');
     const sourcesZip = project.resolvePath('.output/test-1.0.0-sources.zip');
 
@@ -116,10 +116,37 @@ describe('Zipping', () => {
     });
     await extract(sourcesZip, { dir: unzipDir });
     expect(await project.fileExists(unzipDir, '.env')).toBe(false);
+    expect(await project.fileExists(unzipDir, '.hidden-dir/file')).toBe(false);
   });
 
-  // TODO: Fix #738 and re-enable
-  it.skip('should allow zipping hidden files into sources when explicitly listed', async () => {
+  it('should not zip files inside hidden directories if only the directory is specified', async () => {
+    const project = new TestProject({
+      name: 'test',
+      version: '1.0.0',
+    });
+    project.addFile(
+      'entrypoints/background.ts',
+      'export default defineBackground(() => {});',
+    );
+    project.addFile('.hidden-dir/file');
+    project.addFile('.hidden-dir/nested/file');
+    const unzipDir = project.resolvePath('.output/test-1.0.0-sources');
+    const sourcesZip = project.resolvePath('.output/test-1.0.0-sources.zip');
+
+    await project.zip({
+      browser: 'firefox',
+      zip: {
+        includeSources: ['.hidden-dir'],
+      },
+    });
+    await extract(sourcesZip, { dir: unzipDir });
+    expect(await project.fileExists(unzipDir, '.hidden-dir/file')).toBe(false);
+    expect(await project.fileExists(unzipDir, '.hidden-dir/nested/file')).toBe(
+      false,
+    );
+  });
+
+  it('should allow zipping hidden files into sources when explicitly listed', async () => {
     const project = new TestProject({
       name: 'test',
       version: '1.0.0',
@@ -129,16 +156,26 @@ describe('Zipping', () => {
       'export default defineBackground(() => {});',
     );
     project.addFile('.env');
+    project.addFile('.hidden-dir/file');
+    project.addFile('.hidden-dir/nested/file1');
+    project.addFile('.hidden-dir/nested/file2');
     const unzipDir = project.resolvePath('.output/test-1.0.0-sources');
     const sourcesZip = project.resolvePath('.output/test-1.0.0-sources.zip');
 
     await project.zip({
       browser: 'firefox',
       zip: {
-        includeSources: ['.env'],
+        includeSources: ['.env', '.hidden-dir/file', '.hidden-dir/nested/**'],
       },
     });
     await extract(sourcesZip, { dir: unzipDir });
     expect(await project.fileExists(unzipDir, '.env')).toBe(true);
+    expect(await project.fileExists(unzipDir, '.hidden-dir/file')).toBe(true);
+    expect(await project.fileExists(unzipDir, '.hidden-dir/nested/file1')).toBe(
+      true,
+    );
+    expect(await project.fileExists(unzipDir, '.hidden-dir/nested/file2')).toBe(
+      true,
+    );
   });
 });

packages/wxt/package.json

@@ -1,7 +1,7 @@
 {
   "name": "wxt",
   "type": "module",
-  "version": "0.19.1",
+  "version": "0.19.7",
   "description": "Next gen framework for developing web extensions",
   "repository": {
     "type": "git",
@@ -72,7 +72,7 @@
   "scripts": {
     "wxt": "tsx src/cli/index.ts",
     "build": "buildc -- unbuild",
-    "check": "buildc --deps-only -- run-s -c check:*",
+    "check": "pnpm build && run-s -c check:*",
     "check:default": "check",
     "check:tsc-virtual": "tsc --noEmit -p src/virtual",
     "test": "buildc --deps-only -- vitest",
@@ -91,9 +91,11 @@
     "cac": "^6.7.14",
     "chokidar": "^3.6.0",
     "ci-info": "^4.0.0",
+    "consola": "^3.2.3",
     "defu": "^6.1.4",
     "dequal": "^2.0.3",
     "esbuild": "^0.23.0",
+    "execa": "^9.3.0",
     "fast-glob": "^3.3.2",
     "filesize": "^10.1.4",
     "fs-extra": "^11.2.0",
@@ -116,32 +118,31 @@
     "picocolors": "^1.0.1",
     "prompts": "^2.4.2",
     "publish-browser-extension": "^2.1.3",
-    "unimport": "^3.9.0",
-    "vite": "^5.3.4",
-    "vite-node": "^2.0.0",
+    "unimport": "^3.9.1",
+    "vite": "^5.3.5",
+    "vite-node": "^2.0.4",
     "web-ext-run": "^0.2.1",
     "webextension-polyfill": "^0.12.0"
   },
   "devDependencies": {
     "@aklinker1/check": "^1.3.1",
     "@faker-js/faker": "^8.4.1",
-    "@types/chrome": "^0.0.268",
+    "@types/chrome": "^0.0.269",
     "@types/fs-extra": "^11.0.4",
     "@types/lodash.merge": "^4.6.9",
     "@types/natural-compare": "^1.4.3",
-    "@types/node": "^20.14.11",
+    "@types/node": "^20.14.12",
     "@types/normalize-path": "^3.0.2",
     "@types/prompts": "^2.4.9",
-    "execa": "^9.3.0",
     "extract-zip": "^2.0.1",
     "happy-dom": "^14.12.3",
     "lodash.merge": "^4.6.2",
     "p-map": "^7.0.2",
     "publint": "^0.2.9",
     "tsx": "4.15.7",
-    "typescript": "^5.5.3",
+    "typescript": "^5.5.4",
     "unbuild": "^2.0.0",
-    "vitest": "^2.0.3",
+    "vitest": "^2.0.4",
     "vitest-plugin-random-seed": "^1.1.0"
   },
   "peerDependencies": {

packages/wxt/src/browser/chrome.ts

@@ -1,4 +1,9 @@
 /// <reference types="chrome" />
+/**
+ * @module wxt/browser/chrome
+ */
+import type { WxtRuntime, WxtI18n } from './index';
+
 /**
  * EXPERIMENTAL
  *
@@ -7,13 +12,6 @@
  * @module wxt/browser/chrome
  */
 
-export interface WxtRuntime {
-  // Overriden per-project
-}
-export interface WxtI18n {
-  // Overriden per-project
-}
-
 export type Chrome = typeof chrome;
 export type WxtBrowser = Omit<Chrome, 'runtime' | 'i18n'> & {
   runtime: WxtRuntime & Omit<Chrome['runtime'], 'getURL'>;

packages/wxt/src/browser/index.ts

@@ -4,18 +4,18 @@
  * @module wxt/browser
  */
 
-import originalBrowser, { Browser, Runtime, I18n } from 'webextension-polyfill';
+import originalBrowser, { Browser } from 'webextension-polyfill';
 
-export interface AugmentedBrowser extends Browser {
-  runtime: WxtRuntime;
-  i18n: WxtI18n;
-}
+export type AugmentedBrowser = Omit<Browser, 'runtime' | 'i18n'> & {
+  runtime: WxtRuntime & Omit<Browser['runtime'], 'getURL'>;
+  i18n: WxtI18n & Omit<Browser['i18n'], 'getMessage'>;
+};
 
-export interface WxtRuntime extends Runtime.Static {
+export interface WxtRuntime {
   // Overriden per-project
 }
 
-export interface WxtI18n extends I18n.Static {
+export interface WxtI18n {
   // Overriden per-project
 }
 

packages/wxt/src/client/content-scripts/__tests__/content-script-context.test.ts

@@ -0,0 +1,59 @@
+/** @vitest-environment happy-dom */
+
+import { describe, it, expect, vi, beforeEach } from 'vitest';
+import { ContentScriptContext } from '..';
+import { fakeBrowser } from '@webext-core/fake-browser';
+import { sleep } from '../../../core/utils/time';
+
+describe('Content Script Context', () => {
+  beforeEach(() => {
+    vi.useRealTimers();
+    fakeBrowser.runtime.id = 'anything';
+  });
+
+  it("should recognize when the content script has lost it's connection to the extension API", () => {
+    const ctx = new ContentScriptContext('test');
+    const onInvalidated = vi.fn();
+
+    ctx.onInvalidated(onInvalidated);
+    // @ts-expect-error
+    delete fakeBrowser.runtime.id;
+    const isValid = ctx.isValid;
+
+    expect(onInvalidated).toBeCalled();
+    expect(isValid).toBe(false);
+  });
+
+  it('should invalidate the current content script when a new context is created', async () => {
+    const name = 'test';
+    const onInvalidated = vi.fn();
+    const ctx = new ContentScriptContext(name);
+    ctx.onInvalidated(onInvalidated);
+
+    // Wait for events to run before next tick next tick
+    await sleep(0);
+
+    // Create a new context after first is initialized, and wait for it to initialize
+    new ContentScriptContext(name);
+    await sleep(0);
+
+    expect(onInvalidated).toBeCalled();
+    expect(ctx.isValid).toBe(false);
+  });
+
+  it('should not invalidate the current content script when a new context is created with a different name', async () => {
+    const onInvalidated = vi.fn();
+    const ctx = new ContentScriptContext('test1');
+    ctx.onInvalidated(onInvalidated);
+
+    // Wait for events to run before next tick next tick
+    await sleep(0);
+
+    // Create a new context after first is initialized, and wait for it to initialize
+    new ContentScriptContext('test2');
+    await sleep(0);
+
+    expect(onInvalidated).not.toBeCalled();
+    expect(ctx.isValid).toBe(true);
+  });
+});

packages/wxt/src/client/content-scripts/content-script-context.ts

@@ -46,13 +46,13 @@ export class ContentScriptContext implements AbortController {
     public readonly options?: Omit<ContentScriptDefinition, 'main'>,
   ) {
     this.#abortController = new AbortController();
+
     if (this.#isTopFrame) {
+      this.#listenForNewerScripts({ ignoreFirstEvent: true });
       this.#stopOldScripts();
-    }
-    this.setTimeout(() => {
-      // Run on next tick so the listener it adds isn't triggered by stopOldScript
+    } else {
       this.#listenForNewerScripts();
-    });
+    }
   }
 
   get signal() {
@@ -224,12 +224,18 @@ export class ContentScriptContext implements AbortController {
     );
   }
 
-  #listenForNewerScripts() {
+  #listenForNewerScripts(options?: { ignoreFirstEvent?: boolean }) {
+    let isFirst = true;
+
     const cb = (event: MessageEvent) => {
       if (
         event.data?.type === ContentScriptContext.SCRIPT_STARTED_MESSAGE_TYPE &&
         event.data?.contentScriptName === this.contentScriptName
       ) {
+        const wasFirst = isFirst;
+        isFirst = false;
+        if (wasFirst && options?.ignoreFirstEvent) return;
+
         this.notifyInvalidated();
       }
     };

packages/wxt/src/client/content-scripts/ui/index.ts

@@ -62,6 +62,7 @@ export function createIframeUi<TMounted>(
   const wrapper = document.createElement('div');
   wrapper.setAttribute('data-wxt-iframe', '');
   const iframe = document.createElement('iframe');
+  // @ts-expect-error: getURL is defined per-project, but not inside the package
   iframe.src = browser.runtime.getURL(options.page);
   wrapper.appendChild(iframe);
 
@@ -258,6 +259,7 @@ function mountUi(
  * Load the CSS for the current entrypoint.
  */
 async function loadCss(): Promise<string> {
+  // @ts-expect-error: getURL is defined per-project, but not inside the package
   const url = browser.runtime.getURL(
     `/content-scripts/${import.meta.env.ENTRYPOINT}.css`,
   );

packages/wxt/src/client/content-scripts/ui/types.ts

@@ -83,7 +83,8 @@ export type IframeContentScriptUiOptions<TMounted> =
      * The path to the HTML page that will be shown in the iframe. This string is passed into
      * `browser.runtime.getURL`.
      */
-    page: PublicPath;
+    // @ts-expect-error: HtmlPublicPath is generated per-project
+    page: import('wxt/browser').HtmlPublicPath;
     /**
      * Callback executed when mounting the UI. Use this function to customize the iframe or wrapper
      * element's appearance. It is called every time `ui.mount()` is called.

packages/wxt/src/client/index.ts

@@ -5,3 +5,4 @@
  */
 export * from './content-scripts';
 export * from './app-config';
+export * from './inject-script';

packages/wxt/src/client/inject-script.ts

@@ -0,0 +1,47 @@
+import { browser } from 'wxt/browser';
+
+export type ScriptPublicPath = Extract<
+  // @ts-expect-error: PublicPath is generated per-project
+  import('wxt/browser').PublicPath,
+  `${string}.js`
+>;
+
+/**
+ * This function can only be called inside content scripts.
+ *
+ * Inject an unlisted script into the page. Scripts are added to the `<head>`
+ * element or `document.documentElement` if there is no head.
+ *
+ * Make sure to add the injected script to your manifest's
+ * `web_accessible_resources`.
+ */
+export async function injectScript(
+  path: ScriptPublicPath,
+  options?: InjectScriptOptions,
+): Promise<void> {
+  // @ts-expect-error: getURL is defined per-project, but not inside the package
+  const url = browser.runtime.getURL(path);
+  const script = document.createElement('script');
+
+  if (browser.runtime.getManifest().manifest_version === 2) {
+    // MV2 requires using an inline script
+    script.innerHTML = await fetch(url).then((res) => res.text());
+  } else {
+    // MV3 requires using src
+    script.src = url;
+  }
+
+  if (!options?.keepInDom) {
+    script.onload = () => script.remove();
+  }
+
+  (document.head ?? document.documentElement).append(script);
+}
+
+export interface InjectScriptOptions {
+  /**
+   * By default, the injected script is removed from the DOM after being
+   * injected. To disable this behavior, set this flag to true.
+   */
+  keepInDom?: boolean;
+}

packages/wxt/src/core/builders/vite/index.ts

@@ -287,6 +287,9 @@ export async function createViteBuilder(
           strictPort: true,
           host: info.hostname,
           origin: info.origin,
+          watch: {
+            ignored: [`${wxtConfig.outBaseDir}/**`, `${wxtConfig.wxtDir}/**`],
+          },
         },
       };
       const baseConfig = await getBaseConfig();

packages/wxt/src/core/builders/vite/plugins/bundleAnalysis.ts

@@ -6,7 +6,6 @@ import path from 'node:path';
 let increment = 0;
 
 export function bundleAnalysis(config: ResolvedConfig): vite.Plugin {
-  // @ts-expect-error: Vite version mismatch
   return visualizer({
     template: 'raw-data',
     filename: path.resolve(

packages/wxt/src/core/builders/vite/plugins/extensionApiMock.ts

@@ -11,6 +11,9 @@ import { ResolvedConfig } from '../../../../types';
  * `npm list` and inline them automatically.
  */
 export function extensionApiMock(config: ResolvedConfig): vite.PluginOption {
+  const virtualSetupModule = 'virtual:wxt-setup';
+  const resolvedVirtualSetupModule = '\0' + virtualSetupModule;
+
   return {
     name: 'wxt:extension-api-mock',
     config() {
@@ -19,6 +22,9 @@ export function extensionApiMock(config: ResolvedConfig): vite.PluginOption {
         'dist/virtual/mock-browser',
       );
       return {
+        test: {
+          setupFiles: [virtualSetupModule],
+        },
         resolve: {
           alias: [
             { find: 'webextension-polyfill', replacement },
@@ -33,5 +39,19 @@ export function extensionApiMock(config: ResolvedConfig): vite.PluginOption {
         },
       };
     },
+    resolveId(id) {
+      if (id.endsWith(virtualSetupModule)) return resolvedVirtualSetupModule;
+    },
+    load(id) {
+      if (id === resolvedVirtualSetupModule) return setupTemplate;
+    },
   };
 }
+
+const setupTemplate = `
+  import { vi } from 'vitest';
+  import { fakeBrowser } from 'wxt/testing';
+
+  vi.stubGlobal("chrome", fakeBrowser);
+  vi.stubGlobal("browser", fakeBrowser);
+`;

packages/wxt/src/core/create-server.ts

@@ -145,11 +145,6 @@ function createFileReloader(server: WxtDevServer) {
   const changeQueue: Array<[string, string]> = [];
 
   return async (event: string, path: string) => {
-    await wxt.reloadConfig();
-
-    // Here, "path" is a non-normalized path (ie: C:\\users\\... instead of C:/users/...)
-    if (path.startsWith(wxt.config.outBaseDir)) return;
-    if (path.startsWith(wxt.config.wxtDir)) return;
     changeQueue.push([event, path]);
 
     await fileChangedMutex.runExclusive(async () => {
@@ -160,6 +155,8 @@ function createFileReloader(server: WxtDevServer) {
         .map(([_, file]) => file);
       if (fileChanges.length === 0) return;
 
+      await wxt.reloadConfig();
+
       const changes = detectDevChanges(fileChanges, server.currentOutput);
       if (changes.type === 'no-change') return;
 

packages/wxt/src/core/package-managers/__tests__/fixtures/simple-pnpm-project/pnpm-lock.yaml

@@ -1,34 +1,41 @@
-lockfileVersion: '6.0'
+lockfileVersion: '9.0'
 
 settings:
   autoInstallPeers: true
   excludeLinksFromLockfile: false
 
-dependencies:
-  mime-types:
-    specifier: 2.1.35
-    version: 2.1.35
+importers:
 
-devDependencies:
-  flatten:
-    specifier: 1.0.3
-    version: 1.0.3
+  .:
+    dependencies:
+      mime-types:
+        specifier: 2.1.35
+        version: 2.1.35
+    devDependencies:
+      flatten:
+        specifier: 1.0.3
+        version: 1.0.3
 
 packages:
 
-  /flatten@1.0.3:
+  flatten@1.0.3:
     resolution: {integrity: sha512-dVsPA/UwQ8+2uoFe5GHtiBMu48dWLTdsuEd7CKGlZlD78r1TTWBvDuFaFGKCo/ZfEr95Uk56vZoX86OsHkUeIg==}
     deprecated: flatten is deprecated in favor of utility frameworks such as lodash.
-    dev: true
 
-  /mime-db@1.52.0:
+  mime-db@1.52.0:
     resolution: {integrity: sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==}
     engines: {node: '>= 0.6'}
-    dev: false
 
-  /mime-types@2.1.35:
+  mime-types@2.1.35:
     resolution: {integrity: sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==}
     engines: {node: '>= 0.6'}
+
+snapshots:
+
+  flatten@1.0.3: {}
+
+  mime-db@1.52.0: {}
+
+  mime-types@2.1.35:
     dependencies:
       mime-db: 1.52.0
-    dev: false

packages/wxt/src/core/runners/web-ext.ts

@@ -97,6 +97,9 @@ const DEFAULT_CHROMIUM_PREFS = {
       // and log locations show up properly, see:
       // https://github.com/wxt-dev/wxt/issues/236#issuecomment-1915364520
       skipContentScripts: false,
+      // Was renamed at some point, see:
+      // https://github.com/wxt-dev/wxt/issues/912#issuecomment-2284288171
+      'skip-content-scripts': false,
     },
   },
 };

packages/wxt/src/core/utils/__tests__/transform.test.ts

@@ -88,5 +88,54 @@ export default defineBackground();`;
 
       expect(actual).toEqual(expected);
     });
+
+    it("should remove any functions delcared outside the main function that aren't used", () => {
+      const input = `
+              function getMatches() {
+                return ["*://*/*"]
+              }
+              function unused1() {}
+              function unused2() {
+                unused1();
+              }
+
+              export default defineContentScript({
+                matches: getMatches(),
+                main: () => {},
+              })
+            `;
+      const expected = `function getMatches() {
+  return ["*://*/*"]
+}
+
+export default defineContentScript({
+  matches: getMatches()
+})`;
+
+      const actual = removeMainFunctionCode(input).code;
+
+      expect(actual).toEqual(expected);
+    });
+
+    it("should remove any variables delcared outside the main function that aren't used", () => {
+      const input = `
+        const unused1 = "a", matches = ["*://*/*"];
+        let unused2 = unused1 + "b";
+
+        export default defineContentScript({
+          matches,
+          main: () => {}
+        })
+      `;
+      const expected = `const matches = ["*://*/*"];
+
+export default defineContentScript({
+  matches
+})`;
+
+      const actual = removeMainFunctionCode(input).code;
+
+      expect(actual).toEqual(expected);
+    });
   });
 });

packages/wxt/src/core/utils/building/find-entrypoints.ts

@@ -36,7 +36,17 @@ import { createExtensionEnvironment } from '../environments';
 export async function findEntrypoints(): Promise<Entrypoint[]> {
   // Make sure required TSConfig file exists to load dependencies
   await fs.mkdir(wxt.config.wxtDir, { recursive: true });
-  await fs.writeJson(resolve(wxt.config.wxtDir, 'tsconfig.json'), {});
+  try {
+    await fs.writeJson(
+      resolve(wxt.config.wxtDir, 'tsconfig.json'),
+      {},
+      { flag: 'wx' },
+    );
+  } catch (err) {
+    if (!(err instanceof Error) || !('code' in err) || err.code !== 'EEXIST') {
+      throw err;
+    }
+  }
 
   const relativePaths = await glob(Object.keys(PATH_GLOB_TO_TYPE_MAP), {
     cwd: wxt.config.entrypointsDir,
@@ -377,7 +387,7 @@ async function getSidepanelEntrypoint(
   const options = await getHtmlEntrypointOptions<SidepanelEntrypointOptions>(
     info,
     {
-      browserStyle: 'browse_style',
+      browserStyle: 'browser_style',
       exclude: 'exclude',
       include: 'include',
       defaultIcon: 'default_icon',

packages/wxt/src/core/utils/building/generate-wxt-dir.ts

@@ -94,9 +94,9 @@ async function getPathsDeclarationEntry(
     .join('\n');
 
   const template = `// Generated by wxt
-import "${wxt.config.browserModule}";
+import "wxt/browser";
 
-declare module "${wxt.config.browserModule}" {
+declare module "wxt/browser" {
   export type PublicPath =
 {{ union }}
   type HtmlPublicPath = Extract<PublicPath, \`\${string}.html\`>
@@ -117,9 +117,9 @@ declare module "${wxt.config.browserModule}" {
 async function getI18nDeclarationEntry(): Promise<WxtDirFileEntry> {
   const defaultLocale = wxt.config.manifest.default_locale;
   const template = `// Generated by wxt
-import "${wxt.config.browserModule}";
+import "wxt/browser";
 
-declare module "${wxt.config.browserModule}" {
+declare module "wxt/browser" {
   /**
    * See https://developer.chrome.com/docs/extensions/reference/i18n/#method-getMessage
    */
@@ -150,18 +150,43 @@ declare module "${wxt.config.browserModule}" {
     messages = parseI18nMessages({});
   }
 
-  const overrides = messages.map((message) => {
-    return `    /**
-     * ${message.description || 'No message description.'}
-     *
-     * "${message.message}"
-     */
-    getMessage(
-      messageName: "${message.name}",
+  const renderGetMessageOverload = (
+    keyType: string,
+    description?: string,
+    translation?: string,
+  ) => {
+    const commentLines: string[] = [];
+    if (description) commentLines.push(...description.split('\n'));
+    if (translation) {
+      if (commentLines.length > 0) commentLines.push('');
+      commentLines.push(`"${translation}"`);
+    }
+    const comment =
+      commentLines.length > 0
+        ? `/**\n${commentLines.map((line) => `     * ${line}`.trimEnd()).join('\n')}\n     */\n    `
+        : '';
+    return `    ${comment}getMessage(
+      messageName: ${keyType},
       substitutions?: string | string[],
       options?: GetMessageOptions,
     ): string;`;
-  });
+  };
+
+  const overrides = [
+    // Generate individual overloads for each message so JSDoc contains description and base translation.
+    ...messages.map((message) =>
+      renderGetMessageOverload(
+        `"${message.name}"`,
+        message.description,
+        message.message,
+      ),
+    ),
+    // Include a final union-based override so TS accepts valid string templates or concatinations
+    // ie: browser.i18n.getMessage(`some_enum_${enumValue}`)
+    renderGetMessageOverload(
+      messages.map((message) => `"${message.name}"`).join(' | '),
+    ),
+  ];
 
   return {
     path: 'types/i18n.d.ts',
@@ -208,7 +233,11 @@ function getMainDeclarationEntry(references: WxtDirEntry[]): WxtDirFileEntry {
 
 async function getTsConfigEntry(): Promise<WxtDirFileEntry> {
   const dir = wxt.config.wxtDir;
-  const getTsconfigPath = (path: string) => normalizePath(relative(dir, path));
+  const getTsconfigPath = (path: string) => {
+    const res = normalizePath(relative(dir, path));
+    if (res.startsWith('.') || res.startsWith('/')) return res;
+    return './' + res;
+  };
   const paths = Object.entries(wxt.config.alias)
     .flatMap(([alias, absolutePath]) => {
       const aliasPath = getTsconfigPath(absolutePath);

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

@@ -90,9 +90,6 @@ export async function resolveConfig(
     ? new Set(mergedConfig.filterEntrypoints)
     : undefined;
   const publicDir = path.resolve(srcDir, mergedConfig.publicDir ?? 'public');
-  if (await isDirMissing(publicDir)) {
-    logMissingDir(logger, 'Public', publicDir);
-  }
   const typesDir = path.resolve(wxtDir, 'types');
   const outBaseDir = path.resolve(root, mergedConfig.outDir ?? '.output');
   const outDir = path.resolve(outBaseDir, `${browser}-mv${manifestVersion}`);
@@ -183,8 +180,6 @@ export async function resolveConfig(
     userConfigMetadata: userConfigMetadata ?? {},
     alias,
     extensionApi,
-    browserModule:
-      extensionApi === 'chrome' ? 'wxt/browser/chrome' : 'wxt/browser',
     entrypointLoader: mergedConfig.entrypointLoader ?? 'vite-node',
     experimental: defu(mergedConfig.experimental, {}),
     dev: {
@@ -270,6 +265,7 @@ function resolveZipConfig(
     includeSources: [],
     compressionLevel: 9,
     ...mergedConfig.zip,
+    exclude: mergedConfig.zip?.exclude ?? [],
     excludeSources: [
       '**/node_modules',
       // WXT files

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

@@ -286,6 +286,7 @@ export const fakeResolvedConfig = fakeObjectCreator<ResolvedConfig>(() => {
       artifactTemplate: '{{name}}-{{version}}.zip',
       includeSources: [],
       excludeSources: [],
+      exclude: [],
       sourcesRoot: fakeDir(),
       sourcesTemplate: '{{name}}-sources.zip',
       name: faker.person.firstName().toLowerCase(),
@@ -297,7 +298,6 @@ export const fakeResolvedConfig = fakeObjectCreator<ResolvedConfig>(() => {
     userConfigMetadata: {},
     alias: {},
     extensionApi: 'webextension-polyfill',
-    browserModule: 'wxt/browser',
     entrypointLoader: 'vite-node',
     experimental: {},
     dev: {

packages/wxt/src/core/utils/transform.ts

@@ -3,7 +3,8 @@ import { ProxifiedModule, parseModule } from 'magicast';
 /**
  * Removes any code used at runtime related to an entrypoint's main function.
  * 1. Removes or clears out `main` function from returned object
- * 2. Removes unused imports
+ * 2. Removes any unused functions/variables outside the definition that aren't being called/used
+ * 3. Removes unused imports
  * 3. Removes value-less, side-effect only imports (like `import "./styles.css"` or `import "webextension-polyfill"`)
  */
 export function removeMainFunctionCode(code: string): {
@@ -12,7 +13,15 @@ export function removeMainFunctionCode(code: string): {
 } {
   const mod = parseModule(code);
   emptyMainFunction(mod);
-  removeUnusedImports(mod);
+  let removedCount = 0;
+  let depth = 0;
+  const maxDepth = 10;
+  do {
+    removedCount = 0;
+    removedCount += removeUnusedTopLevelVariables(mod);
+    removedCount += removeUnusedTopLevelFunctions(mod);
+    removedCount += removeUnusedImports(mod);
+  } while (removedCount > 0 && depth++ <= maxDepth);
   removeSideEffectImports(mod);
   return mod.generate();
 }
@@ -35,32 +44,92 @@ function emptyMainFunction(mod: ProxifiedModule): void {
   }
 }
 
+function removeUnusedTopLevelVariables(mod: ProxifiedModule): number {
+  const simpleAst = getSimpleAstJson(mod.$ast);
+  const usedMap = findUsedIdentifiers(simpleAst);
+
+  let deletedCount = 0;
+  const ast = mod.$ast as any;
+  for (let i = ast.body.length - 1; i >= 0; i--) {
+    if (ast.body[i].type === 'VariableDeclaration') {
+      for (let j = ast.body[i].declarations.length - 1; j >= 0; j--) {
+        if (!usedMap.get(ast.body[i].declarations[j].id.name)) {
+          ast.body[i].declarations.splice(j, 1);
+          deletedCount++;
+        }
+      }
+      if (ast.body[i].declarations.length === 0) {
+        ast.body.splice(i, 1);
+      }
+    }
+  }
+  return deletedCount;
+}
+
+function removeUnusedTopLevelFunctions(mod: ProxifiedModule): number {
+  const simpleAst = getSimpleAstJson(mod.$ast);
+  const usedMap = findUsedIdentifiers(simpleAst);
+
+  let deletedCount = 0;
+  const ast = mod.$ast as any;
+  for (let i = ast.body.length - 1; i >= 0; i--) {
+    if (
+      ast.body[i].type === 'FunctionDeclaration' &&
+      !usedMap.get(ast.body[i].id.name)
+    ) {
+      ast.body.splice(i, 1);
+      deletedCount++;
+    }
+  }
+  return deletedCount;
+}
+
+function removeUnusedImports(mod: ProxifiedModule): number {
+  const simpleAst = getSimpleAstJson(mod.$ast);
+  const usedMap = findUsedIdentifiers(simpleAst);
+  const importSymbols = Object.keys(mod.imports);
+
+  let deletedCount = 0;
+  importSymbols.forEach((name) => {
+    if (usedMap.get(name)) return;
+
+    delete mod.imports[name];
+    deletedCount++;
+  });
+  return deletedCount;
+}
+
 // TODO: Do a more complex declaration analysis where shadowed variables are detected and ignored.
 // Right now, this code assumes there are no shadowed variables.
-function removeUnusedImports(mod: ProxifiedModule): void {
-  const importSymbols = Object.keys(mod.imports);
-  const usedMap = new Map(importSymbols.map((sym) => [sym, false]));
-
-  const queue: any[] = [getSimpleAstJson(mod.$ast)];
+function findUsedIdentifiers(simpleAst: any) {
+  const usedMap = new Map<string, boolean>();
+  const queue: any[] = [simpleAst];
   for (const item of queue) {
     if (!item) {
-      continue;
     } else if (Array.isArray(item)) {
       queue.push(...item);
     } else if (item.type === 'ImportDeclaration') {
-      // Exclude looking for identifiers in import statements
+      // Don't look inside imports, identifiers are only used for declaration
       continue;
     } else if (item.type === 'Identifier') {
-      // Only track import usages
-      if (usedMap.has(item.name)) usedMap.set(item.name, true);
+      usedMap.set(item.name, true);
     } else if (typeof item === 'object') {
-      queue.push(Object.values(item));
+      const filterFns: Record<string, (entry: [string, any]) => boolean> = {
+        // Ignore the function declaration's name
+        FunctionDeclaration: ([key]) => key !== 'id',
+        // Ignore object property names
+        ObjectProperty: ([key]) => key !== 'key',
+        // Ignore variable declaration's name
+        VariableDeclarator: ([key]) => key !== 'id',
+      };
+      queue.push(
+        Object.entries(item)
+          .filter(filterFns[item.type] ?? (() => true))
+          .map(([_, value]) => value),
+      );
     }
   }
-
-  for (const [name, used] of usedMap.entries()) {
-    if (!used) delete mod.imports[name];
-  }
+  return usedMap;
 }
 
 function deleteImportAst(

packages/wxt/src/core/wxt.ts

@@ -27,6 +27,10 @@ export async function registerWxt(
   inlineConfig: InlineConfig = {},
   getServer?: (config: ResolvedConfig) => Promise<WxtDevServer>,
 ): Promise<void> {
+  // Default NODE_ENV environment variable before other packages, like vite, do it
+  // See https://github.com/wxt-dev/wxt/issues/873#issuecomment-2254555523
+  process.env.NODE_ENV ??= command === 'serve' ? 'development' : 'production';
+
   const hooks = createHooks<WxtHooks>();
   const config = await resolveConfig(inlineConfig, command);
   const server = await getServer?.(config);

packages/wxt/src/core/zip.ts

@@ -47,7 +47,9 @@ export async function zip(config?: InlineConfig): Promise<string[]> {
 
   const outZipFilename = applyTemplate(wxt.config.zip.artifactTemplate);
   const outZipPath = path.resolve(wxt.config.outBaseDir, outZipFilename);
-  await zipDir(wxt.config.outDir, outZipPath);
+  await zipDir(wxt.config.outDir, outZipPath, {
+    exclude: wxt.config.zip.exclude,
+  });
   zipFiles.push(outZipPath);
 
   // ZIP sources for Firefox
@@ -99,13 +101,11 @@ async function zipDir(
 ): Promise<void> {
   const archive = new JSZip();
   const files = (
-    await glob('**/*', {
+    await glob(['**/*', ...(options?.include || [])], {
       cwd: directory,
       // Ignore node_modules, otherwise this glob step takes forever
       ignore: ['**/node_modules'],
       onlyFiles: true,
-      // TODO: Fix #738
-      // dot: true,
     })
   ).filter((relativePath) => {
     return (

packages/wxt/src/modules.ts

@@ -172,3 +172,42 @@ export function addImportPreset(
     wxt.config.imports.presets.push(preset);
   });
 }
+
+/**
+ * Adds an import alias to the project's TSConfig paths and bundler. Path can
+ * be absolute or relative to the project's root directory.
+ *
+ * Usually, this is used to provide access to some code generated by your
+ * module. In the example below, a `i18n` plugin generates a variable that it
+ * wants to provide access to, so it creates the file and adds an import alias
+ * to it.
+ *
+ * @example
+ * import path from 'node:path';
+ *
+ * export default defineWxtModule((wxt) => {
+ *   const i18nPath = path.resolve(wxt.config.wxtDir, "i18n.ts");
+ *
+ *   // Generate the file
+ *   wxt.hooks.hook("prepare:types", (_, entries) => {
+ *     entries.push({
+ *       path: i18nPath,
+ *       text: `export const i18n = ...`,
+ *     });
+ *   });
+ *
+ *   // Add alias
+ *   addAlias(wxt, "#i18n", i18nPath);
+ * });
+ */
+export function addAlias(wxt: Wxt, alias: string, path: string) {
+  wxt.hooks.hook('ready', (wxt) => {
+    const target = resolve(wxt.config.root, path);
+    if (wxt.config.alias[alias] != null) {
+      wxt.logger.warn(
+        `Skipped adding alias (${alias} => ${target}) because an alias with the same name already exists: ${alias} => ${wxt.config.alias[alias]}`,
+      );
+    }
+    wxt.config.alias[alias] = target;
+  });
+}

packages/wxt/src/testing/wxt-vitest-plugin.ts

@@ -6,10 +6,10 @@ import {
   extensionApiMock,
   resolveAppConfig,
 } from '../core/builders/vite/plugins';
-import { resolveConfig } from '../core/utils/building';
 import { InlineConfig } from '../types';
 import { vitePlugin as unimportPlugin } from '../builtin-modules/unimport';
 import { createUnimport } from 'unimport';
+import { registerWxt, wxt } from '../core/wxt';
 
 /**
  * Vite plugin that configures Vitest with everything required to test a WXT extension, based on the `<root>/wxt.config.ts`
@@ -29,17 +29,17 @@ import { createUnimport } from 'unimport';
 export async function WxtVitest(
   inlineConfig?: InlineConfig,
 ): Promise<vite.PluginOption[]> {
-  const config = await resolveConfig(inlineConfig ?? {}, 'serve');
+  await registerWxt('serve', inlineConfig ?? {});
 
   const plugins: vite.PluginOption[] = [
-    globals(config),
-    download(config),
-    tsconfigPaths(config),
-    resolveAppConfig(config),
-    extensionApiMock(config),
+    globals(wxt.config),
+    download(wxt.config),
+    tsconfigPaths(wxt.config),
+    resolveAppConfig(wxt.config),
+    extensionApiMock(wxt.config),
   ];
-  if (config.imports !== false) {
-    const unimport = createUnimport(config.imports);
+  if (wxt.config.imports !== false) {
+    const unimport = createUnimport(wxt.config.imports);
     await unimport.init();
     plugins.push(unimportPlugin(unimport));
   }

packages/wxt/src/types.ts

@@ -181,6 +181,16 @@ export interface InlineConfig {
      * ]
      */
     excludeSources?: string[];
+    /**
+     * [Minimatch](https://www.npmjs.com/package/minimatch) patterns of files to exclude when
+     * zipping the extension.
+     *
+     * @example
+     * [
+     *   "**\/*.map", // Exclude all sourcemaps
+     * ]
+     */
+    exclude?: string[];
     /**
      * The Firefox review process requires the extension be buildable from source to make reviewing
      * easier. This field allows you to use private packages without exposing your auth tokens.
@@ -1046,9 +1056,14 @@ export interface WxtHooks {
    *   // variable called "example" in the TS project.
    *   entries.push({
    *     path: "types/example.d.ts",
-   *     textContent: "declare const a: string;",
+   *     text: "declare const a: string;",
    *     tsReference: true,
    *   });
+   *   // use module to add Triple-Slash Directive in .wxt/wxt.d.ts
+   *   // eg: /// <reference types="@types/example" />
+   *   entries.push({
+   *     module: '@types/example'
+   *  });
    * })
    */
   'prepare:types': (wxt: Wxt, entries: WxtDirEntry[]) => HookResult;
@@ -1187,6 +1202,7 @@ export interface ResolvedConfig {
     downloadedPackagesDir: string;
     downloadPackages: string[];
     compressionLevel: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
+    exclude: string[];
   };
   /**
    * @deprecated Use `build:manifestGenerated` hook instead.
@@ -1210,7 +1226,6 @@ export interface ResolvedConfig {
    */
   alias: Record<string, string>;
   extensionApi: 'webextension-polyfill' | 'chrome';
-  browserModule: 'wxt/browser' | 'wxt/browser/chrome';
   entrypointLoader: 'vite-node' | 'jiti';
   experimental: {};
   dev: {
@@ -1409,6 +1424,10 @@ export type WxtDirEntry = WxtDirTypeReferenceEntry | WxtDirFileEntry;
  * Represents type reference to a node module to be added to `.wxt/wxt.d.ts` file
  */
 export interface WxtDirTypeReferenceEntry {
+  /**
+   * Specifies the module name that will be used in the `/// <reference types="..." />` directive.
+   * This value will be added to the `.wxt/wxt.d.ts` file to include type definitions from the specified module.
+   */
   module: string;
 }
 

scripts/benchmarks/browser-startup.patch

@@ -0,0 +1,26 @@
+diff --git a/packages/wxt/src/core/runners/web-ext.ts b/packages/wxt/src/core/runners/web-ext.ts
+index 09819c3..a0f0df2 100644
+--- a/packages/wxt/src/core/runners/web-ext.ts
++++ b/packages/wxt/src/core/runners/web-ext.ts
+@@ -3,6 +3,8 @@ import { ExtensionRunner } from '../../types';
+ import { formatDuration } from '../utils/time';
+ import defu from 'defu';
+ import { wxt } from '../wxt';
++import fs from 'node:fs';
++import stream from 'node:stream/promises';
+ 
+ /**
+  * Create an `ExtensionRunner` backed by `web-ext`.
+@@ -78,6 +80,12 @@ export function createWebExtRunner(): ExtensionRunner {
+ 
+       const duration = Date.now() - startTime;
+       wxt.logger.success(`Opened browser in ${formatDuration(duration)}`);
++      await runner.exit();
++      const s = fs.createWriteStream('stats.txt', { flags: 'a' });
++      s.write(duration + ' ');
++      s.end();
++      await stream.finished(s);
++      process.exit(0);
+     },
+ 
+     async closeBrowser() {

scripts/benchmarks/browser-startup.sh

@@ -0,0 +1,41 @@
+#!/bin/bash
+set -e
+
+#
+# Benchmark how long it takes for the browser to open in dev mode.
+#
+# To run:
+#   cd <root>
+#   ./scripts/benchmarks/browser-startup.sh
+#
+# You can set N below to change the number of samples per git ref.
+#
+
+N=20
+
+function benchmark_ref() {
+    # Prep
+    git checkout $1
+    pnpm buildc clean
+    git apply scripts/benchmarks/browser-startup.patch
+    pnpm i --ignore-scripts
+    pnpm -r --filter wxt build
+    echo -n "$1 " >> stats.txt
+
+    # Run benchmark
+    for i in $(seq $N); do
+        pnpm wxt packages/wxt-demo
+    done
+    git checkout HEAD -- packages/wxt/src/core/runners/web-ext.ts pnpm-lock.yaml
+    echo "" >> stats.txt
+}
+
+rm -f stats.txt
+
+benchmark_ref "HEAD"
+
+# Benchmark a commit:
+#   benchmark_ref "3109bba"
+#
+# Benchmark a version:
+#   benchmark_ref "v0.19.0"

templates/react/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "wxt-starter",
+  "name": "wxt-react-starter",
   "description": "manifest.json description",
   "private": true,
   "version": "0.0.0",
@@ -22,7 +22,7 @@
     "@types/react": "^18.3.3",
     "@types/react-dom": "^18.3.0",
     "@wxt-dev/module-react": "^1.1.0",
-    "typescript": "^5.5.3",
-    "wxt": "^0.18.15"
+    "typescript": "^5.5.4",
+    "wxt": "^0.19.1"
   }
 }

templates/solid/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "wxt-starter",
+  "name": "wxt-solid-starter",
   "description": "manifest.json description",
   "private": true,
   "version": "0.0.0",
@@ -15,11 +15,11 @@
     "postinstall": "wxt prepare"
   },
   "dependencies": {
-    "solid-js": "^1.8.18"
+    "solid-js": "^1.8.19"
   },
   "devDependencies": {
     "@wxt-dev/module-solid": "^1.1.1",
-    "typescript": "^5.5.3",
-    "wxt": "^0.18.15"
+    "typescript": "^5.5.4",
+    "wxt": "^0.19.1"
   }
 }

templates/svelte/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "wxt-starter",
+  "name": "wxt-svelte-starter",
   "description": "manifest.json description",
   "private": true,
   "version": "0.0.0",
@@ -19,7 +19,7 @@
     "svelte": "^4.2.18",
     "svelte-check": "^3.8.4",
     "tslib": "^2.6.3",
-    "typescript": "^5.5.3",
-    "wxt": "^0.18.15"
+    "typescript": "^5.5.4",
+    "wxt": "^0.19.1"
   }
 }

templates/vanilla/package.json

@@ -15,7 +15,7 @@
     "postinstall": "wxt prepare"
   },
   "devDependencies": {
-    "typescript": "^5.5.3",
-    "wxt": "^0.18.15"
+    "typescript": "^5.5.4",
+    "wxt": "^0.19.1"
   }
 }

templates/vue/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "wxt-starter",
+  "name": "wxt-vue-starter",
   "description": "manifest.json description",
   "private": true,
   "version": "0.0.0",
@@ -15,12 +15,12 @@
     "postinstall": "wxt prepare"
   },
   "dependencies": {
-    "vue": "^3.4.33"
+    "vue": "^3.4.34"
   },
   "devDependencies": {
     "@wxt-dev/module-vue": "^1.0.0",
-    "typescript": "^5.5.3",
-    "vue-tsc": "^2.0.26",
-    "wxt": "^0.18.15"
+    "typescript": "^5.5.4",
+    "vue-tsc": "^2.0.29",
+    "wxt": "^0.19.1"
   }
 }