wxt 0.20.13 → 0.20.14

package/dist/{modules.d.ts → modules.d.mts}

@@ -1,13 +1,9 @@
-/**
- * Utilities for creating [WXT Modules](https://wxt.dev/guide/essentials/wxt-modules.html).
- *
- * @module wxt/modules
- */
-import type { Entrypoint, Wxt, WxtModule, WxtModuleOptions, WxtModuleSetup } from './types';
-import * as vite from 'vite';
-import type { UnimportOptions } from 'unimport';
-export { WxtModule };
-export declare function defineWxtModule<TOptions extends WxtModuleOptions>(module: WxtModule<TOptions> | WxtModuleSetup<TOptions>): WxtModule<TOptions>;
+import { Entrypoint, Wxt, WxtModule, WxtModuleOptions, WxtModuleSetup } from "./types.mjs";
+import * as vite from "vite";
+import { UnimportOptions } from "unimport";
+
+//#region src/modules.d.ts
+declare function defineWxtModule<TOptions extends WxtModuleOptions>(module: WxtModule<TOptions> | WxtModuleSetup<TOptions>): WxtModule<TOptions>;
 /**
  * Adds a TS/JS file as an entrypoint to the project. This file will be bundled
  * along with the other entrypoints.
@@ -35,7 +31,7 @@ export declare function defineWxtModule<TOptions extends WxtModuleOptions>(modul
  *   });
  * });
  */
-export declare function addEntrypoint(wxt: Wxt, entrypoint: Entrypoint): void;
+declare function addEntrypoint(wxt: Wxt, entrypoint: Entrypoint): void;
 /**
  * Copy files inside a directory (as if it were the public directory) into the
  * extension's output directory. The directory itself is not copied, just the
@@ -49,7 +45,7 @@ export declare function addEntrypoint(wxt: Wxt, entrypoint: Entrypoint): void;
  *   addPublicAssets(wxt, "./dist/prebundled");
  * });
  */
-export declare function addPublicAssets(wxt: Wxt, dir: string): void;
+declare function addPublicAssets(wxt: Wxt, dir: string): void;
 /**
  * Merge additional vite config for one or more entrypoint "groups" that make
  * up individual builds. Config in the project's `wxt.config.ts` file takes
@@ -68,7 +64,7 @@ export declare function addPublicAssets(wxt: Wxt, dir: string): void;
  *   });
  * });
  */
-export declare function addViteConfig(wxt: Wxt, viteConfig: (env: vite.ConfigEnv) => vite.UserConfig | undefined): void;
+declare function addViteConfig(wxt: Wxt, viteConfig: (env: vite.ConfigEnv) => vite.UserConfig | undefined): void;
 /**
  * Add a runtime plugin to the project. In each entrypoint, before executing
  * the `main` function, plugins are executed.
@@ -82,7 +78,7 @@ export declare function addViteConfig(wxt: Wxt, viteConfig: (env: vite.ConfigEnv
  *   addWxtPlugin(wxt, "wxt-module-analytics/client-plugin");
  * });
  */
-export declare function addWxtPlugin(wxt: Wxt, plugin: string): void;
+declare function addWxtPlugin(wxt: Wxt, plugin: string): void;
 /**
  * Add an Unimport preset ([built-in](https://github.com/unjs/unimport?tab=readme-ov-file#built-in-presets),
  * [custom](https://github.com/unjs/unimport?tab=readme-ov-file#custom-presets),
@@ -110,7 +106,7 @@ export declare function addWxtPlugin(wxt: Wxt, plugin: string): void;
  *   addImportPreset(wxt, { package: "vue" });
  * });
  */
-export declare function addImportPreset(wxt: Wxt, preset: UnimportOptions['presets'][0]): void;
+declare function addImportPreset(wxt: Wxt, preset: UnimportOptions['presets'][0]): void;
 /**
  * Adds an import alias to the project's TSConfig paths and bundler. Path can
  * be absolute or relative to the project's root directory.
@@ -138,4 +134,6 @@ export declare function addImportPreset(wxt: Wxt, preset: UnimportOptions['prese
  *   addAlias(wxt, "#i18n", i18nPath);
  * });
  */
-export declare function addAlias(wxt: Wxt, alias: string, path: string): void;
+declare function addAlias(wxt: Wxt, alias: string, path: string): void;
+//#endregion
+export { WxtModule, addAlias, addEntrypoint, addImportPreset, addPublicAssets, addViteConfig, addWxtPlugin, defineWxtModule };

package/dist/modules.mjs

@@ -1,60 +1,190 @@
-import * as vite from "vite";
 import glob from "fast-glob";
 import { resolve } from "node:path";
-export {};
-export function defineWxtModule(module) {
-  if (typeof module === "function") return { setup: module };
-  return module;
+import * as vite from "vite";
+
+//#region src/modules.ts
+function defineWxtModule(module) {
+	if (typeof module === "function") return { setup: module };
+	return module;
 }
-export function addEntrypoint(wxt, entrypoint) {
-  wxt.hooks.hook("entrypoints:resolved", (_, entrypoints) => {
-    entrypoints.push(entrypoint);
-  });
+/**
+* Adds a TS/JS file as an entrypoint to the project. This file will be bundled
+* along with the other entrypoints.
+*
+* If you're publishing the module to NPM, you should probably pre-build the
+* entrypoint and use `addPublicAssets` instead to copy pre-bundled assets into
+* the output directory. This will speed up project builds since it just has to
+* copy some files instead of bundling them.
+*
+* To extract entrypoint options from a JS/TS file, use
+* `wxt.builder.importEntrypoint` (see example).
+*
+* @param wxt The wxt instance provided by the module's setup function.
+* @param entrypoint The entrypoint to be bundled along with the extension.
+*
+* @example
+* export default defineWxtModule(async (wxt, options) => {
+*   const entrypointPath = "/path/to/my-entrypoint.ts";
+*   addEntrypoint(wxt, {
+*     type: "content-script",
+*     name: "some-name",
+*     inputPath: entrypointPath,
+*     outputDir: wxt.config.outDir,
+*     options: await wxt.builder.importEntrypoint(entrypointPath),
+*   });
+* });
+*/
+function addEntrypoint(wxt, entrypoint) {
+	wxt.hooks.hook("entrypoints:resolved", (_, entrypoints) => {
+		entrypoints.push(entrypoint);
+	});
 }
-export function addPublicAssets(wxt, dir) {
-  wxt.hooks.hook("build:publicAssets", async (wxt2, files) => {
-    const moreFiles = await glob("**/*", { cwd: dir });
-    if (moreFiles.length === 0) {
-      wxt2.logger.warn("No files to copy in", dir);
-      return;
-    }
-    moreFiles.forEach((file) => {
-      files.unshift({ absoluteSrc: resolve(dir, file), relativeDest: file });
-    });
-  });
+/**
+* Copy files inside a directory (as if it were the public directory) into the
+* extension's output directory. The directory itself is not copied, just the
+* files inside it. If a filename matches an existing one, it is ignored.
+*
+* @param wxt The wxt instance provided by the module's setup function.
+* @param dir The directory to copy.
+*
+* @example
+* export default defineWxtModule((wxt, options) => {
+*   addPublicAssets(wxt, "./dist/prebundled");
+* });
+*/
+function addPublicAssets(wxt, dir) {
+	wxt.hooks.hook("build:publicAssets", async (wxt, files) => {
+		const moreFiles = await glob("**/*", { cwd: dir });
+		if (moreFiles.length === 0) {
+			wxt.logger.warn("No files to copy in", dir);
+			return;
+		}
+		moreFiles.forEach((file) => {
+			files.unshift({
+				absoluteSrc: resolve(dir, file),
+				relativeDest: file
+			});
+		});
+	});
 }
-export function addViteConfig(wxt, viteConfig) {
-  wxt.hooks.hook("config:resolved", (wxt2) => {
-    const userVite = wxt2.config.vite;
-    wxt2.config.vite = async (env) => {
-      const fromUser = await userVite(env);
-      const fromModule = viteConfig(env) ?? {};
-      return vite.mergeConfig(fromModule, fromUser);
-    };
-  });
+/**
+* Merge additional vite config for one or more entrypoint "groups" that make
+* up individual builds. Config in the project's `wxt.config.ts` file takes
+* precedence over any config added by this function.
+*
+* @param wxt The wxt instance provided by the module's setup function.
+* @param viteConfig A function that returns the vite config the module is
+adding. Same format as `vite` in `wxt.config.ts`.
+*
+* @example
+* export default defineWxtModule((wxt, options) => {
+*   addViteConfig(wxt, () => ({
+*     build: {
+*       sourceMaps: true,
+*     },
+*   });
+* });
+*/
+function addViteConfig(wxt, viteConfig) {
+	wxt.hooks.hook("config:resolved", (wxt) => {
+		const userVite = wxt.config.vite;
+		wxt.config.vite = async (env) => {
+			const fromUser = await userVite(env);
+			const fromModule = viteConfig(env) ?? {};
+			return vite.mergeConfig(fromModule, fromUser);
+		};
+	});
 }
-export function addWxtPlugin(wxt, plugin) {
-  wxt.hooks.hook("config:resolved", (wxt2) => {
-    wxt2.config.plugins.push(plugin);
-  });
+/**
+* Add a runtime plugin to the project. In each entrypoint, before executing
+* the `main` function, plugins are executed.
+*
+* @param wxt The wxt instance provided by the module's setup function.
+* @param plugin An import from an NPM module, or an absolute file path to the
+*               file to load at runtime.
+*
+* @example
+* export default defineWxtModule((wxt) => {
+*   addWxtPlugin(wxt, "wxt-module-analytics/client-plugin");
+* });
+*/
+function addWxtPlugin(wxt, plugin) {
+	wxt.hooks.hook("config:resolved", (wxt) => {
+		wxt.config.plugins.push(plugin);
+	});
 }
-export function addImportPreset(wxt, preset) {
-  wxt.hooks.hook("config:resolved", (wxt2) => {
-    if (!wxt2.config.imports) return;
-    wxt2.config.imports.presets ??= [];
-    if (wxt2.config.imports.presets.includes(preset)) return;
-    wxt2.config.imports.presets.push(preset);
-  });
+/**
+* Add an Unimport preset ([built-in](https://github.com/unjs/unimport?tab=readme-ov-file#built-in-presets),
+* [custom](https://github.com/unjs/unimport?tab=readme-ov-file#custom-presets),
+* or [auto-scanned](https://github.com/unjs/unimport?tab=readme-ov-file#exports-auto-scan)),
+* to the project's list of auto-imported utilities.
+*
+* Some things to note:
+* - This function will only de-duplicate built-in preset names. It will not
+*   stop you adding duplicate custom or auto-scanned presets.
+* - If the project has disabled imports, this function has no effect.
+*
+* @param wxt The wxt instance provided by the module's setup function.
+* @param preset The preset to add to the project.
+*
+* @example
+* export default defineWxtModule((wxt) => {
+*   // Built-in preset:
+*   addImportPreset(wxt, "vue");
+*   // Custom preset:
+*   addImportPreset(wxt, {
+*     from: "vue",
+*     imports: ["ref", "reactive", ...],
+*   });
+*   // Auto-scanned preset:
+*   addImportPreset(wxt, { package: "vue" });
+* });
+*/
+function addImportPreset(wxt, preset) {
+	wxt.hooks.hook("config:resolved", (wxt) => {
+		if (!wxt.config.imports) return;
+		wxt.config.imports.presets ??= [];
+		if (wxt.config.imports.presets.includes(preset)) return;
+		wxt.config.imports.presets.push(preset);
+	});
 }
-export function addAlias(wxt, alias, path) {
-  wxt.hooks.hook("config:resolved", (wxt2) => {
-    const target = resolve(wxt2.config.root, path);
-    if (wxt2.config.alias[alias] != null && wxt2.config.alias[alias] !== target) {
-      wxt2.logger.warn(
-        `Skipped adding alias (${alias} => ${target}) because an alias with the same name already exists: ${alias} => ${wxt2.config.alias[alias]}`
-      );
-      return;
-    }
-    wxt2.config.alias[alias] = target;
-  });
+/**
+* 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);
+* });
+*/
+function addAlias(wxt, alias, path) {
+	wxt.hooks.hook("config:resolved", (wxt) => {
+		const target = resolve(wxt.config.root, path);
+		if (wxt.config.alias[alias] != null && wxt.config.alias[alias] !== target) {
+			wxt.logger.warn(`Skipped adding alias (${alias} => ${target}) because an alias with the same name already exists: ${alias} => ${wxt.config.alias[alias]}`);
+			return;
+		}
+		wxt.config.alias[alias] = target;
+	});
 }
+
+//#endregion
+export { addAlias, addEntrypoint, addImportPreset, addPublicAssets, addViteConfig, addWxtPlugin, defineWxtModule };

package/dist/testing/fake-browser.d.mts

@@ -0,0 +1,2 @@
+import { FakeBrowser, fakeBrowser } from "@webext-core/fake-browser";
+export { type FakeBrowser, fakeBrowser };

package/dist/testing/fake-browser.mjs

@@ -1 +1,3 @@
-export { fakeBrowser } from "@webext-core/fake-browser";
+import { fakeBrowser } from "@webext-core/fake-browser";
+
+export { fakeBrowser };

package/dist/testing/index.d.mts

@@ -0,0 +1,3 @@
+import { FakeBrowser, fakeBrowser } from "./fake-browser.mjs";
+import { WxtVitest } from "./wxt-vitest-plugin.mjs";
+export { FakeBrowser, WxtVitest, fakeBrowser };

package/dist/testing/index.mjs

@@ -1,2 +1,4 @@
-export * from "./fake-browser.mjs";
-export * from "./wxt-vitest-plugin.mjs";
+import { fakeBrowser } from "./fake-browser.mjs";
+import { WxtVitest } from "./wxt-vitest-plugin.mjs";
+
+export { WxtVitest, fakeBrowser };

package/dist/testing/{wxt-vitest-plugin.d.ts → wxt-vitest-plugin.d.mts}

@@ -1,11 +1,7 @@
-/**
- * Contains a Vitest plugin that configures your test environment to work with
- * WXT projects.
- *
- * @module wxt/testing/vitest
- */
-import type * as vite from 'vite';
-import { InlineConfig } from '../types';
+import { InlineConfig } from "../types.mjs";
+import * as vite from "vite";
+
+//#region src/testing/wxt-vitest-plugin.d.ts
 /**
  * Vite plugin that configures Vitest with everything required to test a WXT extension, based on the `<root>/wxt.config.ts`
  *
@@ -21,4 +17,6 @@ import { InlineConfig } from '../types';
  *
  * @param inlineConfig Customize WXT's config for testing. Any config specified here overrides the config from your `wxt.config.ts` file.
  */
-export declare function WxtVitest(inlineConfig?: InlineConfig): Promise<vite.PluginOption[]>;
+declare function WxtVitest(inlineConfig?: InlineConfig): Promise<vite.PluginOption[]>;
+//#endregion
+export { WxtVitest };

package/dist/testing/wxt-vitest-plugin.mjs

@@ -1,21 +1,40 @@
-import {
-  download,
-  tsconfigPaths,
-  globals,
-  extensionApiMock,
-  resolveAppConfig
-} from "../core/builders/vite/plugins/index.mjs";
-import UnimportPlugin from "unimport/unplugin";
+import { download } from "../core/builders/vite/plugins/download.mjs";
+import { tsconfigPaths } from "../core/builders/vite/plugins/tsconfigPaths.mjs";
+import { globals } from "../core/builders/vite/plugins/globals.mjs";
+import { extensionApiMock } from "../core/builders/vite/plugins/extensionApiMock.mjs";
+import { resolveAppConfig } from "../core/builders/vite/plugins/resolveAppConfig.mjs";
+import "../core/builders/vite/plugins/index.mjs";
 import { registerWxt, wxt } from "../core/wxt.mjs";
-export async function WxtVitest(inlineConfig) {
-  await registerWxt("serve", inlineConfig ?? {});
-  const plugins = [
-    globals(wxt.config),
-    download(wxt.config),
-    tsconfigPaths(wxt.config),
-    resolveAppConfig(wxt.config),
-    extensionApiMock(wxt.config)
-  ];
-  plugins.push(UnimportPlugin.vite(wxt.config.imports));
-  return plugins;
+import UnimportPlugin from "unimport/unplugin";
+
+//#region src/testing/wxt-vitest-plugin.ts
+/**
+* Vite plugin that configures Vitest with everything required to test a WXT extension, based on the `<root>/wxt.config.ts`
+*
+* ```ts
+* // vitest.config.ts
+* import { defineConfig } from 'vitest/config';
+* import { WxtVitest } from 'wxt/testing/vitest-plugin';
+*
+* export default defineConfig({
+*   plugins: [WxtVitest()],
+* });
+* ```
+*
+* @param inlineConfig Customize WXT's config for testing. Any config specified here overrides the config from your `wxt.config.ts` file.
+*/
+async function WxtVitest(inlineConfig) {
+	await registerWxt("serve", inlineConfig ?? {});
+	const plugins = [
+		globals(wxt.config),
+		download(wxt.config),
+		tsconfigPaths(wxt.config),
+		resolveAppConfig(wxt.config),
+		extensionApiMock(wxt.config)
+	];
+	plugins.push(UnimportPlugin.vite(wxt.config.imports));
+	return plugins;
 }
+
+//#endregion
+export { WxtVitest };