wxt 0.20.13 → 0.20.14

package/dist/core/runners/index.mjs

@@ -1,12 +1,17 @@
+import { wxt } from "../wxt.mjs";
 import { createWslRunner } from "./wsl.mjs";
 import { createWebExtRunner } from "./web-ext.mjs";
 import { createSafariRunner } from "./safari.mjs";
 import { createManualRunner } from "./manual.mjs";
 import { isWsl } from "../utils/wsl.mjs";
-import { wxt } from "../wxt.mjs";
-export async function createExtensionRunner() {
-  if (wxt.config.browser === "safari") return createSafariRunner();
-  if (await isWsl()) return createWslRunner();
-  if (wxt.config.runnerConfig.config?.disabled) return createManualRunner();
-  return createWebExtRunner();
+
+//#region src/core/runners/index.ts
+async function createExtensionRunner() {
+	if (wxt.config.browser === "safari") return createSafariRunner();
+	if (await isWsl()) return createWslRunner();
+	if (wxt.config.runnerConfig.config?.disabled) return createManualRunner();
+	return createWebExtRunner();
 }
+
+//#endregion
+export { createExtensionRunner };

package/dist/core/runners/manual.mjs

@@ -1,16 +1,18 @@
-import { relative } from "node:path";
 import { wxt } from "../wxt.mjs";
-export function createManualRunner() {
-  return {
-    async openBrowser() {
-      wxt.logger.info(
-        `Load "${relative(
-          process.cwd(),
-          wxt.config.outDir
-        )}" as an unpacked extension manually`
-      );
-    },
-    async closeBrowser() {
-    }
-  };
+import { relative } from "node:path";
+
+//#region src/core/runners/manual.ts
+/**
+* The manual runner tells the user to load the unpacked extension manually.
+*/
+function createManualRunner() {
+	return {
+		async openBrowser() {
+			wxt.logger.info(`Load "${relative(process.cwd(), wxt.config.outDir)}" as an unpacked extension manually`);
+		},
+		async closeBrowser() {}
+	};
 }
+
+//#endregion
+export { createManualRunner };

package/dist/core/runners/safari.mjs

@@ -1,16 +1,18 @@
-import { relative } from "node:path";
 import { wxt } from "../wxt.mjs";
-export function createSafariRunner() {
-  return {
-    async openBrowser() {
-      wxt.logger.warn(
-        `Cannot Safari using web-ext. Load "${relative(
-          process.cwd(),
-          wxt.config.outDir
-        )}" as an unpacked extension manually`
-      );
-    },
-    async closeBrowser() {
-    }
-  };
+import { relative } from "node:path";
+
+//#region src/core/runners/safari.ts
+/**
+* The Safari runner just logs a warning message because `web-ext` doesn't work with Safari.
+*/
+function createSafariRunner() {
+	return {
+		async openBrowser() {
+			wxt.logger.warn(`Cannot Safari using web-ext. Load "${relative(process.cwd(), wxt.config.outDir)}" as an unpacked extension manually`);
+		},
+		async closeBrowser() {}
+	};
 }
+
+//#endregion
+export { createSafariRunner };

package/dist/core/runners/web-ext.mjs

@@ -1,88 +1,67 @@
 import { formatDuration } from "../utils/time.mjs";
-import defu from "defu";
 import { wxt } from "../wxt.mjs";
-export function createWebExtRunner() {
-  let runner;
-  return {
-    canOpen() {
-      return true;
-    },
-    async openBrowser() {
-      const startTime = Date.now();
-      if (wxt.config.browser === "firefox" && wxt.config.manifestVersion === 3) {
-        throw Error(
-          "Dev mode does not support Firefox MV3. For alternatives, see https://github.com/wxt-dev/wxt/issues/230#issuecomment-1806881653"
-        );
-      }
-      const webExtLogger = await import("web-ext-run/util/logger");
-      webExtLogger.consoleStream.write = ({ level, msg, name }) => {
-        if (level >= ERROR_LOG_LEVEL) wxt.logger.error(name, msg);
-        if (level >= WARN_LOG_LEVEL) wxt.logger.warn(msg);
-      };
-      const wxtUserConfig = wxt.config.runnerConfig.config;
-      const userConfig = {
-        browserConsole: wxtUserConfig?.openConsole,
-        devtools: wxtUserConfig?.openDevtools,
-        startUrl: wxtUserConfig?.startUrls,
-        keepProfileChanges: wxtUserConfig?.keepProfileChanges,
-        chromiumPort: wxtUserConfig?.chromiumPort,
-        ...wxt.config.browser === "firefox" ? {
-          firefox: wxtUserConfig?.binaries?.firefox,
-          firefoxProfile: wxtUserConfig?.firefoxProfile,
-          prefs: wxtUserConfig?.firefoxPrefs,
-          args: wxtUserConfig?.firefoxArgs
-        } : {
-          chromiumBinary: wxtUserConfig?.binaries?.[wxt.config.browser],
-          chromiumProfile: wxtUserConfig?.chromiumProfile,
-          chromiumPref: defu(
-            wxtUserConfig?.chromiumPref,
-            DEFAULT_CHROMIUM_PREFS
-          ),
-          args: [
-            "--unsafely-disable-devtools-self-xss-warnings",
-            ...wxtUserConfig?.chromiumArgs ?? []
-          ]
-        }
-      };
-      const finalConfig = {
-        ...userConfig,
-        target: wxt.config.browser === "firefox" ? "firefox-desktop" : "chromium",
-        sourceDir: wxt.config.outDir,
-        // Don't add a "Reload Manager" extension alongside dev extension, WXT
-        // already handles reloads intenrally.
-        noReloadManagerExtension: true,
-        // WXT handles reloads, so disable auto-reload behaviors in web-ext
-        noReload: true,
-        noInput: true
-      };
-      const options = {
-        // Don't call `process.exit(0)` after starting web-ext
-        shouldExitProgram: false
-      };
-      wxt.logger.debug("web-ext config:", finalConfig);
-      wxt.logger.debug("web-ext options:", options);
-      const webExt = await import("web-ext-run");
-      runner = await webExt.default.cmd.run(finalConfig, options);
-      const duration = Date.now() - startTime;
-      wxt.logger.success(`Opened browser in ${formatDuration(duration)}`);
-    },
-    async closeBrowser() {
-      return await runner?.exit();
-    }
-  };
+import defu from "defu";
+
+//#region src/core/runners/web-ext.ts
+/**
+* Create an `ExtensionRunner` backed by `web-ext`.
+*/
+function createWebExtRunner() {
+	let runner;
+	return {
+		canOpen() {
+			return true;
+		},
+		async openBrowser() {
+			const startTime = Date.now();
+			if (wxt.config.browser === "firefox" && wxt.config.manifestVersion === 3) throw Error("Dev mode does not support Firefox MV3. For alternatives, see https://github.com/wxt-dev/wxt/issues/230#issuecomment-1806881653");
+			const webExtLogger = await import("web-ext-run/util/logger");
+			webExtLogger.consoleStream.write = ({ level, msg, name }) => {
+				if (level >= ERROR_LOG_LEVEL) wxt.logger.error(name, msg);
+				if (level >= WARN_LOG_LEVEL) wxt.logger.warn(msg);
+			};
+			const wxtUserConfig = wxt.config.runnerConfig.config;
+			const finalConfig = {
+				browserConsole: wxtUserConfig?.openConsole,
+				devtools: wxtUserConfig?.openDevtools,
+				startUrl: wxtUserConfig?.startUrls,
+				keepProfileChanges: wxtUserConfig?.keepProfileChanges,
+				chromiumPort: wxtUserConfig?.chromiumPort,
+				...wxt.config.browser === "firefox" ? {
+					firefox: wxtUserConfig?.binaries?.firefox,
+					firefoxProfile: wxtUserConfig?.firefoxProfile,
+					pref: wxtUserConfig?.firefoxPref,
+					args: wxtUserConfig?.firefoxArgs
+				} : {
+					chromiumBinary: wxtUserConfig?.binaries?.[wxt.config.browser],
+					chromiumProfile: wxtUserConfig?.chromiumProfile,
+					chromiumPref: defu(wxtUserConfig?.chromiumPref, DEFAULT_CHROMIUM_PREFS),
+					args: ["--unsafely-disable-devtools-self-xss-warnings", ...wxtUserConfig?.chromiumArgs ?? []]
+				},
+				target: wxt.config.browser === "firefox" ? "firefox-desktop" : "chromium",
+				sourceDir: wxt.config.outDir,
+				noReloadManagerExtension: true,
+				noReload: true,
+				noInput: true
+			};
+			const options = { shouldExitProgram: false };
+			wxt.logger.debug("web-ext config:", finalConfig);
+			wxt.logger.debug("web-ext options:", options);
+			runner = await (await import("web-ext-run")).default.cmd.run(finalConfig, options);
+			const duration = Date.now() - startTime;
+			wxt.logger.success(`Opened browser in ${formatDuration(duration)}`);
+		},
+		async closeBrowser() {
+			return await runner?.exit();
+		}
+	};
 }
 const WARN_LOG_LEVEL = 40;
 const ERROR_LOG_LEVEL = 50;
-const DEFAULT_CHROMIUM_PREFS = {
-  devtools: {
-    synced_preferences_sync_disabled: {
-      // Remove content scripts from sourcemap debugger ignore list so stack traces
-      // 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
-    }
-  }
-};
+const DEFAULT_CHROMIUM_PREFS = { devtools: { synced_preferences_sync_disabled: {
+	skipContentScripts: false,
+	"skip-content-scripts": false
+} } };
+
+//#endregion
+export { createWebExtRunner };

package/dist/core/runners/wsl.mjs

@@ -1,16 +1,18 @@
-import { relative } from "node:path";
 import { wxt } from "../wxt.mjs";
-export function createWslRunner() {
-  return {
-    async openBrowser() {
-      wxt.logger.warn(
-        `Cannot open browser when using WSL. Load "${relative(
-          process.cwd(),
-          wxt.config.outDir
-        )}" as an unpacked extension manually`
-      );
-    },
-    async closeBrowser() {
-    }
-  };
+import { relative } from "node:path";
+
+//#region src/core/runners/wsl.ts
+/**
+* The WSL runner just logs a warning message because `web-ext` doesn't work in WSL.
+*/
+function createWslRunner() {
+	return {
+		async openBrowser() {
+			wxt.logger.warn(`Cannot open browser when using WSL. Load "${relative(process.cwd(), wxt.config.outDir)}" as an unpacked extension manually`);
+		},
+		async closeBrowser() {}
+	};
 }
+
+//#endregion
+export { createWslRunner };

package/dist/core/utils/arrays.mjs

@@ -1,16 +1,27 @@
-export function every(array, predicate) {
-  for (let i = 0; i < array.length; i++)
-    if (!predicate(array[i], i)) return false;
-  return true;
+//#region src/core/utils/arrays.ts
+/**
+* Checks if `predicate` returns truthy for all elements of the array.
+*/
+function every(array, predicate) {
+	for (let i = 0; i < array.length; i++) if (!predicate(array[i], i)) return false;
+	return true;
 }
-export function some(array, predicate) {
-  for (let i = 0; i < array.length; i++)
-    if (predicate(array[i], i)) return true;
-  return false;
+/**
+* Returns true when any of the predicates return true;
+*/
+function some(array, predicate) {
+	for (let i = 0; i < array.length; i++) if (predicate(array[i], i)) return true;
+	return false;
 }
-export function toArray(a) {
-  return Array.isArray(a) ? a : [a];
+/**
+* Convert an item or array to an array.
+*/
+function toArray(a) {
+	return Array.isArray(a) ? a : [a];
 }
-export function filterTruthy(array) {
-  return array.filter((item) => !!item);
+function filterTruthy(array) {
+	return array.filter((item) => !!item);
 }
+
+//#endregion
+export { every, filterTruthy, some, toArray };

package/dist/core/utils/building/build-entrypoints.mjs

@@ -1,47 +1,51 @@
+import { toArray } from "../arrays.mjs";
+import { wxt } from "../../wxt.mjs";
 import { getPublicFiles } from "../fs.mjs";
 import fs from "fs-extra";
 import { dirname, resolve } from "path";
 import pc from "picocolors";
-import { wxt } from "../../wxt.mjs";
-import { toArray } from "../arrays.mjs";
-export async function buildEntrypoints(groups, spinner) {
-  const steps = [];
-  for (let i = 0; i < groups.length; i++) {
-    const group = groups[i];
-    const groupNames = toArray(group).map((e) => e.name);
-    const groupNameColored = groupNames.join(pc.dim(", "));
-    spinner.text = pc.dim(`[${i + 1}/${groups.length}]`) + ` ${groupNameColored}`;
-    try {
-      steps.push(await wxt.builder.build(group));
-    } catch (err) {
-      spinner.stop().clear();
-      wxt.logger.error(err);
-      throw Error(`Failed to build ${groupNames.join(", ")}`, { cause: err });
-    }
-  }
-  const publicAssets = await copyPublicDirectory();
-  return { publicAssets, steps };
+
+//#region src/core/utils/building/build-entrypoints.ts
+async function buildEntrypoints(groups, spinner) {
+	const steps = [];
+	for (let i = 0; i < groups.length; i++) {
+		const group = groups[i];
+		const groupNames = toArray(group).map((e) => e.name);
+		const groupNameColored = groupNames.join(pc.dim(", "));
+		spinner.text = pc.dim(`[${i + 1}/${groups.length}]`) + ` ${groupNameColored}`;
+		try {
+			steps.push(await wxt.builder.build(group));
+		} catch (err) {
+			spinner.stop().clear();
+			wxt.logger.error(err);
+			throw Error(`Failed to build ${groupNames.join(", ")}`, { cause: err });
+		}
+	}
+	return {
+		publicAssets: await copyPublicDirectory(),
+		steps
+	};
 }
 async function copyPublicDirectory() {
-  const files = (await getPublicFiles()).map((file) => ({
-    absoluteSrc: resolve(wxt.config.publicDir, file),
-    relativeDest: file
-  }));
-  await wxt.hooks.callHook("build:publicAssets", wxt, files);
-  if (files.length === 0) return [];
-  const publicAssets = [];
-  for (const file of files) {
-    const absoluteDest = resolve(wxt.config.outDir, file.relativeDest);
-    await fs.ensureDir(dirname(absoluteDest));
-    if ("absoluteSrc" in file) {
-      await fs.copyFile(file.absoluteSrc, absoluteDest);
-    } else {
-      await fs.writeFile(absoluteDest, file.contents, "utf8");
-    }
-    publicAssets.push({
-      type: "asset",
-      fileName: file.relativeDest
-    });
-  }
-  return publicAssets;
+	const files = (await getPublicFiles()).map((file) => ({
+		absoluteSrc: resolve(wxt.config.publicDir, file),
+		relativeDest: file
+	}));
+	await wxt.hooks.callHook("build:publicAssets", wxt, files);
+	if (files.length === 0) return [];
+	const publicAssets = [];
+	for (const file of files) {
+		const absoluteDest = resolve(wxt.config.outDir, file.relativeDest);
+		await fs.ensureDir(dirname(absoluteDest));
+		if ("absoluteSrc" in file) await fs.copyFile(file.absoluteSrc, absoluteDest);
+		else await fs.writeFile(absoluteDest, file.contents, "utf8");
+		publicAssets.push({
+			type: "asset",
+			fileName: file.relativeDest
+		});
+	}
+	return publicAssets;
 }
+
+//#endregion
+export { buildEntrypoints };

package/dist/core/utils/building/detect-dev-changes.mjs

@@ -1,109 +1,88 @@
-import { every, some } from "../../utils/arrays.mjs";
-import { normalizePath } from "../../utils/paths.mjs";
+import { normalizePath } from "../paths.mjs";
+import { every, some } from "../arrays.mjs";
 import { wxt } from "../../wxt.mjs";
-export function detectDevChanges(changedFiles, currentOutput) {
-  const isConfigChange = some(
-    changedFiles,
-    (file) => file === wxt.config.userConfigMetadata.configFile
-  );
-  if (isConfigChange) return { type: "full-restart" };
-  const isWxtModuleChange = some(
-    changedFiles,
-    (file) => file.startsWith(wxt.config.modulesDir)
-  );
-  if (isWxtModuleChange) return { type: "full-restart" };
-  const isRunnerChange = some(
-    changedFiles,
-    (file) => file === wxt.config.runnerConfig.configFile
-  );
-  if (isRunnerChange) return { type: "browser-restart" };
-  const changedSteps = new Set(
-    changedFiles.flatMap(
-      (changedFile) => findEffectedSteps(changedFile, currentOutput)
-    )
-  );
-  if (changedSteps.size === 0) {
-    const hasPublicChange = some(
-      changedFiles,
-      (file) => file.startsWith(wxt.config.publicDir)
-    );
-    if (hasPublicChange) {
-      return {
-        type: "extension-reload",
-        rebuildGroups: [],
-        cachedOutput: currentOutput
-      };
-    } else {
-      return { type: "no-change" };
-    }
-  }
-  const unchangedOutput = {
-    manifest: currentOutput.manifest,
-    steps: [],
-    publicAssets: [...currentOutput.publicAssets]
-  };
-  const changedOutput = {
-    manifest: currentOutput.manifest,
-    steps: [],
-    publicAssets: []
-  };
-  for (const step of currentOutput.steps) {
-    if (changedSteps.has(step)) {
-      changedOutput.steps.push(step);
-    } else {
-      unchangedOutput.steps.push(step);
-    }
-  }
-  const isOnlyHtmlChanges = changedFiles.length > 0 && every(changedFiles, (file) => file.endsWith(".html"));
-  if (isOnlyHtmlChanges) {
-    return {
-      type: "html-reload",
-      cachedOutput: unchangedOutput,
-      rebuildGroups: changedOutput.steps.map((step) => step.entrypoints)
-    };
-  }
-  const isOnlyContentScripts = changedOutput.steps.length > 0 && every(
-    changedOutput.steps.flatMap((step) => step.entrypoints),
-    (entry) => entry.type === "content-script"
-  );
-  if (isOnlyContentScripts) {
-    return {
-      type: "content-script-reload",
-      cachedOutput: unchangedOutput,
-      changedSteps: changedOutput.steps,
-      rebuildGroups: changedOutput.steps.map((step) => step.entrypoints)
-    };
-  }
-  return {
-    type: "extension-reload",
-    cachedOutput: unchangedOutput,
-    rebuildGroups: changedOutput.steps.map((step) => step.entrypoints)
-  };
+
+//#region src/core/utils/building/detect-dev-changes.ts
+/**
+* Compare the changed files vs the build output and determine what kind of reload needs to happen:
+*
+* - Do nothing
+*   - CSS or JS file associated with an HTML page is changed - this is handled automatically by the
+*     dev server
+*   - Change isn't used by any of the entrypoints
+* - Reload Content script
+*   - CSS or JS file associated with a content script
+*   - Background script will be told to reload the content script
+* - Reload HTML file
+*   - HTML file itself is saved - HMR doesn't handle this because the HTML pages are pre-rendered
+*   - Chrome is OK reloading the page when the HTML file is changed without reloading the whole
+*     extension. Not sure about firefox, this might need to change to an extension reload
+* - Reload extension
+*   - Background script is changed
+*   - Manifest is different
+* - Restart browser
+*   - web-ext.config.ts (runner config changes)
+* - Full dev server restart
+*   - wxt.config.ts (main config file)
+*   - modules/* (any file related to WXT modules)
+*   - .env (environment variable changed could effect build)
+*/
+function detectDevChanges(changedFiles, currentOutput) {
+	if (some(changedFiles, (file) => file === wxt.config.userConfigMetadata.configFile)) return { type: "full-restart" };
+	if (some(changedFiles, (file) => file.startsWith(wxt.config.modulesDir))) return { type: "full-restart" };
+	if (some(changedFiles, (file) => file === wxt.config.runnerConfig.configFile)) return { type: "browser-restart" };
+	const changedSteps = new Set(changedFiles.flatMap((changedFile) => findEffectedSteps(changedFile, currentOutput)));
+	if (changedSteps.size === 0) if (some(changedFiles, (file) => file.startsWith(wxt.config.publicDir))) return {
+		type: "extension-reload",
+		rebuildGroups: [],
+		cachedOutput: currentOutput
+	};
+	else return { type: "no-change" };
+	const unchangedOutput = {
+		manifest: currentOutput.manifest,
+		steps: [],
+		publicAssets: [...currentOutput.publicAssets]
+	};
+	const changedOutput = {
+		manifest: currentOutput.manifest,
+		steps: [],
+		publicAssets: []
+	};
+	for (const step of currentOutput.steps) if (changedSteps.has(step)) changedOutput.steps.push(step);
+	else unchangedOutput.steps.push(step);
+	if (changedFiles.length > 0 && every(changedFiles, (file) => file.endsWith(".html"))) return {
+		type: "html-reload",
+		cachedOutput: unchangedOutput,
+		rebuildGroups: changedOutput.steps.map((step) => step.entrypoints)
+	};
+	if (changedOutput.steps.length > 0 && every(changedOutput.steps.flatMap((step) => step.entrypoints), (entry) => entry.type === "content-script")) return {
+		type: "content-script-reload",
+		cachedOutput: unchangedOutput,
+		changedSteps: changedOutput.steps,
+		rebuildGroups: changedOutput.steps.map((step) => step.entrypoints)
+	};
+	return {
+		type: "extension-reload",
+		cachedOutput: unchangedOutput,
+		rebuildGroups: changedOutput.steps.map((step) => step.entrypoints)
+	};
 }
+/**
+* For a single change, return all the step of the build output that were effected by it.
+*/
 function findEffectedSteps(changedFile, currentOutput) {
-  const changes = [];
-  const changedPath = normalizePath(changedFile);
-  const isChunkEffected = (chunk) => {
-    switch (chunk.type) {
-      // If it's an HTML file with the same path, is is effected because HTML files need to be re-rendered
-      // - fileName is normalized, relative bundle path, "<entrypoint-name>.html"
-      case "asset": {
-        return changedPath.replace("/index.html", ".html").endsWith(chunk.fileName);
-      }
-      // If it's a chunk that depends on the changed file, it is effected
-      // - moduleIds are absolute, normalized paths
-      case "chunk": {
-        const modulePaths = chunk.moduleIds.map((path) => path.split("?")[0]);
-        return modulePaths.includes(changedPath);
-      }
-      default: {
-        return false;
-      }
-    }
-  };
-  for (const step of currentOutput.steps) {
-    const effectedChunk = step.chunks.find((chunk) => isChunkEffected(chunk));
-    if (effectedChunk) changes.push(step);
-  }
-  return changes;
+	const changes = [];
+	const changedPath = normalizePath(changedFile);
+	const isChunkEffected = (chunk) => {
+		switch (chunk.type) {
+			case "asset": return changedPath.replace("/index.html", ".html").endsWith(chunk.fileName);
+			case "chunk": return chunk.moduleIds.map((path) => path.split("?")[0]).includes(changedPath);
+			default: return false;
+		}
+	};
+	for (const step of currentOutput.steps) if (step.chunks.find((chunk) => isChunkEffected(chunk))) changes.push(step);
+	return changes;
 }
+
+//#endregion
+export { detectDevChanges };