wxt 0.20.13 → 0.20.15

package/dist/core/generate-wxt-dir.mjs

@@ -1,53 +1,49 @@
-import fs from "fs-extra";
-import { dirname, relative, resolve } from "node:path";
+import { normalizePath } from "./utils/paths.mjs";
+import "./utils/index.mjs";
 import { getEntrypointBundlePath, isHtmlEntrypoint } from "./utils/entrypoints.mjs";
 import { getEntrypointGlobals, getGlobals } from "./utils/globals.mjs";
-import { normalizePath } from "./utils/paths.mjs";
-import path from "node:path";
-import { parseI18nMessages } from "./utils/i18n.mjs";
-import { writeFileIfDifferent, getPublicFiles } from "./utils/fs.mjs";
 import { wxt } from "./wxt.mjs";
-export async function generateWxtDir(entrypoints) {
-  await fs.ensureDir(wxt.config.typesDir);
-  const entries = [
-    // Hard-coded entries
-    { module: "wxt/vite-builder-env" }
-  ];
-  wxt.config.userModules.forEach((module) => {
-    if (module.type === "node_module") entries.push({ module: module.id });
-  });
-  entries.push(await getPathsDeclarationEntry(entrypoints));
-  entries.push(await getI18nDeclarationEntry());
-  entries.push(await getGlobalsDeclarationEntry());
-  entries.push(await getTsConfigEntry());
-  await wxt.hooks.callHook("prepare:types", wxt, entries);
-  entries.push(getMainDeclarationEntry(entries));
-  const absoluteFileEntries = entries.filter((entry) => "path" in entry).map((entry) => ({
-    ...entry,
-    path: resolve(wxt.config.wxtDir, entry.path)
-  }));
-  await Promise.all(
-    absoluteFileEntries.map(async (file) => {
-      await fs.ensureDir(dirname(file.path));
-      await writeFileIfDifferent(file.path, file.text);
-    })
-  );
+import { getPublicFiles, writeFileIfDifferent } from "./utils/fs.mjs";
+import { parseI18nMessages } from "./utils/i18n.mjs";
+import fs from "fs-extra";
+import path, { dirname, relative, resolve } from "node:path";
+
+//#region src/core/generate-wxt-dir.ts
+/**
+* Generate and write all the files inside the `InternalConfig.typesDir` directory.
+*/
+async function generateWxtDir(entrypoints) {
+	await fs.ensureDir(wxt.config.typesDir);
+	const entries = [{ module: "wxt/vite-builder-env" }];
+	wxt.config.userModules.forEach((module) => {
+		if (module.type === "node_module") entries.push({ module: module.id });
+	});
+	entries.push(await getPathsDeclarationEntry(entrypoints));
+	entries.push(await getI18nDeclarationEntry());
+	entries.push(await getGlobalsDeclarationEntry());
+	entries.push(await getTsConfigEntry());
+	await wxt.hooks.callHook("prepare:types", wxt, entries);
+	entries.push(getMainDeclarationEntry(entries));
+	const absoluteFileEntries = entries.filter((entry) => "path" in entry).map((entry) => ({
+		...entry,
+		path: resolve(wxt.config.wxtDir, entry.path)
+	}));
+	await Promise.all(absoluteFileEntries.map(async (file) => {
+		await fs.ensureDir(dirname(file.path));
+		await writeFileIfDifferent(file.path, file.text);
+	}));
 }
 async function getPathsDeclarationEntry(entrypoints) {
-  const paths = entrypoints.map(
-    (entry) => getEntrypointBundlePath(
-      entry,
-      wxt.config.outDir,
-      isHtmlEntrypoint(entry) ? ".html" : ".js"
-    )
-  ).concat(await getPublicFiles());
-  await wxt.hooks.callHook("prepare:publicPaths", wxt, paths);
-  const unions = [
-    `    | ""`,
-    `    | "/"`,
-    ...paths.map(normalizePath).sort().map((path2) => `    | "/${path2}"`)
-  ].join("\n");
-  const template = `// Generated by wxt
+	const paths = entrypoints.map((entry) => getEntrypointBundlePath(entry, wxt.config.outDir, isHtmlEntrypoint(entry) ? ".html" : ".js")).concat(await getPublicFiles());
+	await wxt.hooks.callHook("prepare:publicPaths", wxt, paths);
+	const unions = [
+		`    | ""`,
+		`    | "/"`,
+		...paths.map(normalizePath).sort().map((path) => `    | "/${path}"`)
+	].join("\n");
+	return {
+		path: "types/paths.d.ts",
+		text: `// Generated by wxt
 import "wxt/browser";
 
 declare module "wxt/browser" {
@@ -59,16 +55,13 @@ declare module "wxt/browser" {
     getURL(path: \`\${HtmlPublicPath}\${string}\`): string;
   }
 }
-`;
-  return {
-    path: "types/paths.d.ts",
-    text: template.replace("{{ union }}", unions || "    | never"),
-    tsReference: true
-  };
+`.replace("{{ union }}", unions || "    | never"),
+		tsReference: true
+	};
 }
 async function getI18nDeclarationEntry() {
-  const defaultLocale = wxt.config.manifest.default_locale;
-  const template = `// Generated by wxt
+	const defaultLocale = wxt.config.manifest.default_locale;
+	const template = `// Generated by wxt
 import "wxt/browser";
 
 declare module "wxt/browser" {
@@ -87,105 +80,71 @@ declare module "wxt/browser" {
   }
 }
 `;
-  const defaultLocalePath = path.resolve(
-    wxt.config.publicDir,
-    "_locales",
-    defaultLocale ?? "",
-    "messages.json"
-  );
-  let messages;
-  if (await fs.exists(defaultLocalePath)) {
-    const content = JSON.parse(await fs.readFile(defaultLocalePath, "utf-8"));
-    messages = parseI18nMessages(content);
-  } else {
-    messages = parseI18nMessages({});
-  }
-  const renderGetMessageOverload = (keyType, description, translation) => {
-    const commentLines = [];
-    if (description) commentLines.push(...description.split("\n"));
-    if (translation) {
-      if (commentLines.length > 0) commentLines.push("");
-      commentLines.push(`"${translation}"`);
-    }
-    const comment = commentLines.length > 0 ? `/**
-${commentLines.map((line) => `     * ${line}`.trimEnd()).join("\n")}
-     */
-    ` : "";
-    return `    ${comment}getMessage(
+	const defaultLocalePath = path.resolve(wxt.config.publicDir, "_locales", defaultLocale ?? "", "messages.json");
+	let messages;
+	if (await fs.pathExists(defaultLocalePath)) messages = parseI18nMessages(JSON.parse(await fs.readFile(defaultLocalePath, "utf-8")));
+	else messages = parseI18nMessages({});
+	const renderGetMessageOverload = (keyType, description, translation) => {
+		const commentLines = [];
+		if (description) commentLines.push(...description.split("\n"));
+		if (translation) {
+			if (commentLines.length > 0) commentLines.push("");
+			commentLines.push(`"${translation}"`);
+		}
+		return `    ${commentLines.length > 0 ? `/**\n${commentLines.map((line) => `     * ${line}`.trimEnd()).join("\n")}\n     */\n    ` : ""}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 concatenations
-    // ie: browser.i18n.getMessage(`some_enum_${enumValue}`)
-    renderGetMessageOverload(
-      messages.map((message) => `"${message.name}"`).join(" | ")
-    )
-  ];
-  return {
-    path: "types/i18n.d.ts",
-    text: template.replace("{{ overrides }}", overrides.join("\n")),
-    tsReference: true
-  };
+	};
+	const overrides = [...messages.map((message) => renderGetMessageOverload(`"${message.name}"`, message.description, message.message)), renderGetMessageOverload(messages.map((message) => `"${message.name}"`).join(" | "))];
+	return {
+		path: "types/i18n.d.ts",
+		text: template.replace("{{ overrides }}", overrides.join("\n")),
+		tsReference: true
+	};
 }
 async function getGlobalsDeclarationEntry() {
-  const globals = [...getGlobals(wxt.config), ...getEntrypointGlobals("")];
-  return {
-    path: "types/globals.d.ts",
-    text: [
-      "// Generated by wxt",
-      "interface ImportMetaEnv {",
-      ...globals.map((global) => `  readonly ${global.name}: ${global.type};`),
-      "}",
-      "interface ImportMeta {",
-      "  readonly env: ImportMetaEnv",
-      "}",
-      ""
-    ].join("\n"),
-    tsReference: true
-  };
+	return {
+		path: "types/globals.d.ts",
+		text: [
+			"// Generated by wxt",
+			"interface ImportMetaEnv {",
+			...[...getGlobals(wxt.config), ...getEntrypointGlobals("")].map((global) => `  readonly ${global.name}: ${global.type};`),
+			"}",
+			"interface ImportMeta {",
+			"  readonly env: ImportMetaEnv",
+			"}",
+			""
+		].join("\n"),
+		tsReference: true
+	};
 }
 function getMainDeclarationEntry(references) {
-  const lines = ["// Generated by wxt"];
-  references.forEach((ref) => {
-    if ("module" in ref) {
-      return lines.push(`/// <reference types="${ref.module}" />`);
-    } else if (ref.tsReference) {
-      const absolutePath = resolve(wxt.config.wxtDir, ref.path);
-      const relativePath = relative(wxt.config.wxtDir, absolutePath);
-      lines.push(`/// <reference path="./${normalizePath(relativePath)}" />`);
-    }
-  });
-  return {
-    path: "wxt.d.ts",
-    text: lines.join("\n") + "\n"
-  };
+	const lines = ["// Generated by wxt"];
+	references.forEach((ref) => {
+		if ("module" in ref) return lines.push(`/// <reference types="${ref.module}" />`);
+		else if (ref.tsReference) {
+			const absolutePath = resolve(wxt.config.wxtDir, ref.path);
+			const relativePath = relative(wxt.config.wxtDir, absolutePath);
+			lines.push(`/// <reference path="./${normalizePath(relativePath)}" />`);
+		}
+	});
+	return {
+		path: "wxt.d.ts",
+		text: lines.join("\n") + "\n"
+	};
 }
 async function getTsConfigEntry() {
-  const dir = wxt.config.wxtDir;
-  const getTsconfigPath = (path2) => {
-    const res = normalizePath(relative(dir, path2));
-    if (res.startsWith(".") || res.startsWith("/")) return res;
-    return "./" + res;
-  };
-  const paths = Object.entries(wxt.config.alias).flatMap(([alias, absolutePath]) => {
-    const aliasPath = getTsconfigPath(absolutePath);
-    return [
-      `"${alias}": ["${aliasPath}"]`,
-      `"${alias}/*": ["${aliasPath}/*"]`
-    ];
-  }).map((line) => `      ${line}`).join(",\n");
-  const text = `{
+	const dir = wxt.config.wxtDir;
+	const getTsconfigPath = (path) => {
+		const res = normalizePath(relative(dir, path));
+		if (res.startsWith(".") || res.startsWith("/")) return res;
+		return "./" + res;
+	};
+	return {
+		path: "tsconfig.json",
+		text: `{
   "compilerOptions": {
     "target": "ESNext",
     "module": "ESNext",
@@ -197,7 +156,10 @@ async function getTsConfigEntry() {
     "strict": true,
     "skipLibCheck": true,
     "paths": {
-${paths}
+${Object.entries(wxt.config.alias).flatMap(([alias, absolutePath]) => {
+			const aliasPath = getTsconfigPath(absolutePath);
+			return [`"${alias}": ["${aliasPath}"]`, `"${alias}/*": ["${aliasPath}/*"]`];
+		}).map((line) => `      ${line}`).join(",\n")}
     }
   },
   "include": [
@@ -205,9 +167,9 @@ ${paths}
     "./wxt.d.ts"
   ],
   "exclude": ["${getTsconfigPath(wxt.config.outBaseDir)}"]
-}`;
-  return {
-    path: "tsconfig.json",
-    text
-  };
+}`
+	};
 }
+
+//#endregion
+export { generateWxtDir };

package/dist/core/index.d.mts

@@ -0,0 +1,9 @@
+import { build } from "./build.mjs";
+import { clean } from "./clean.mjs";
+import { defineConfig } from "./define-config.mjs";
+import { defineRunnerConfig, defineWebExtConfig } from "./define-web-ext-config.mjs";
+import { createServer } from "./create-server.mjs";
+import { initialize } from "./initialize.mjs";
+import { prepare } from "./prepare.mjs";
+import { zip } from "./zip.mjs";
+import { normalizePath } from "./utils/paths.mjs";

package/dist/core/index.mjs

@@ -1,8 +1,12 @@
-export * from "./build.mjs";
-export * from "./clean.mjs";
-export * from "./define-config.mjs";
-export * from "./define-web-ext-config.mjs";
-export * from "./create-server.mjs";
-export * from "./initialize.mjs";
-export * from "./prepare.mjs";
-export * from "./zip.mjs";
+import { normalizePath } from "./utils/paths.mjs";
+import "./utils/index.mjs";
+import { build } from "./build.mjs";
+import { clean } from "./clean.mjs";
+import { defineConfig } from "./define-config.mjs";
+import { defineRunnerConfig, defineWebExtConfig } from "./define-web-ext-config.mjs";
+import { createServer } from "./create-server.mjs";
+import { initialize } from "./initialize.mjs";
+import { prepare } from "./prepare.mjs";
+import { zip } from "./zip.mjs";
+
+export {  };

package/dist/core/initialize.d.mts

@@ -0,0 +1,8 @@
+//#region src/core/initialize.d.ts
+declare function initialize(options: {
+  directory: string;
+  template: string;
+  packageManager: string;
+}): Promise<void>;
+//#endregion
+export { initialize };

package/dist/core/initialize.mjs

@@ -1,140 +1,126 @@
-import prompts from "prompts";
-import { consola } from "consola";
-import { downloadTemplate } from "giget";
 import fs from "fs-extra";
 import path from "node:path";
+import { consola as consola$1 } from "consola";
 import pc from "picocolors";
-export async function initialize(options) {
-  consola.info("Initializing new project");
-  const templates = await listTemplates();
-  const defaultTemplate = templates.find(
-    (template) => template.name === options.template?.toLowerCase().trim()
-  );
-  const input = await prompts(
-    [
-      {
-        name: "directory",
-        type: () => options.directory == null ? "text" : void 0,
-        message: "Project Directory",
-        initial: options.directory
-      },
-      {
-        name: "template",
-        type: () => defaultTemplate == null ? "select" : void 0,
-        message: "Choose a template",
-        choices: templates.map((template) => ({
-          title: TEMPLATE_COLORS[template.name]?.(template.name) ?? template.name,
-          value: template
-        }))
-      },
-      {
-        name: "packageManager",
-        type: () => options.packageManager == null ? "select" : void 0,
-        message: "Package Manager",
-        choices: [
-          { title: pc.red("npm"), value: "npm" },
-          { title: pc.yellow("pnpm"), value: "pnpm" },
-          { title: pc.cyan("yarn"), value: "yarn" },
-          { title: pc.magenta("bun"), value: "bun" }
-        ]
-      }
-    ],
-    {
-      onCancel: () => process.exit(1)
-    }
-  );
-  input.directory ??= options.directory;
-  input.template ??= defaultTemplate;
-  input.packageManager ??= options.packageManager;
-  const isExists = await fs.pathExists(input.directory);
-  if (isExists) {
-    const isEmpty = (await fs.readdir(input.directory)).filter((dir) => dir !== ".git").length === 0;
-    if (!isEmpty) {
-      consola.error(
-        `The directory ${path.resolve(input.directory)} is not empty. Aborted.`
-      );
-      process.exit(1);
-    }
-  }
-  await cloneProject(input);
-  const cdPath = path.relative(process.cwd(), path.resolve(input.directory));
-  console.log();
-  consola.log(
-    `\u2728 WXT project created with the ${TEMPLATE_COLORS[input.template.name]?.(input.template.name) ?? input.template.name} template.`
-  );
-  console.log();
-  consola.log("Next steps:");
-  let step = 0;
-  if (cdPath !== "") consola.log(`  ${++step}.`, pc.cyan(`cd ${cdPath}`));
-  consola.log(`  ${++step}.`, pc.cyan(`${input.packageManager} install`));
-  console.log();
+import prompts from "prompts";
+import { downloadTemplate } from "giget";
+
+//#region src/core/initialize.ts
+async function initialize(options) {
+	consola$1.info("Initializing new project");
+	const templates = await listTemplates();
+	const defaultTemplate = templates.find((template) => template.name === options.template?.toLowerCase().trim());
+	const input = await prompts([
+		{
+			name: "directory",
+			type: () => options.directory == null ? "text" : void 0,
+			message: "Project Directory",
+			initial: options.directory
+		},
+		{
+			name: "template",
+			type: () => defaultTemplate == null ? "select" : void 0,
+			message: "Choose a template",
+			choices: templates.map((template) => ({
+				title: TEMPLATE_COLORS[template.name]?.(template.name) ?? template.name,
+				value: template
+			}))
+		},
+		{
+			name: "packageManager",
+			type: () => options.packageManager == null ? "select" : void 0,
+			message: "Package Manager",
+			choices: [
+				{
+					title: pc.red("npm"),
+					value: "npm"
+				},
+				{
+					title: pc.yellow("pnpm"),
+					value: "pnpm"
+				},
+				{
+					title: pc.cyan("yarn"),
+					value: "yarn"
+				},
+				{
+					title: pc.magenta("bun"),
+					value: "bun"
+				}
+			]
+		}
+	], { onCancel: () => process.exit(1) });
+	input.directory ??= options.directory;
+	input.template ??= defaultTemplate;
+	input.packageManager ??= options.packageManager;
+	if (await fs.pathExists(input.directory)) {
+		if (!((await fs.readdir(input.directory)).filter((dir) => dir !== ".git").length === 0)) {
+			consola$1.error(`The directory ${path.resolve(input.directory)} is not empty. Aborted.`);
+			process.exit(1);
+		}
+	}
+	await cloneProject(input);
+	const cdPath = path.relative(process.cwd(), path.resolve(input.directory));
+	console.log();
+	consola$1.log(`✨ WXT project created with the ${TEMPLATE_COLORS[input.template.name]?.(input.template.name) ?? input.template.name} template.`);
+	console.log();
+	consola$1.log("Next steps:");
+	let step = 0;
+	if (cdPath !== "") consola$1.log(`  ${++step}.`, pc.cyan(`cd ${cdPath}`));
+	consola$1.log(`  ${++step}.`, pc.cyan(`${input.packageManager} install`));
+	console.log();
 }
 async function listTemplates() {
-  const templates = await listTemplatesUngh().catch((err) => {
-    consola.debug("Failed to load templates via ungh:", err);
-    return listTemplatesGithub();
-  });
-  return templates.sort((l, r) => {
-    const lWeight = TEMPLATE_SORT_WEIGHT[l.name] ?? Number.MAX_SAFE_INTEGER;
-    const rWeight = TEMPLATE_SORT_WEIGHT[r.name] ?? Number.MAX_SAFE_INTEGER;
-    const diff = lWeight - rWeight;
-    if (diff !== 0) return diff;
-    return l.name.localeCompare(r.name);
-  });
+	return (await listTemplatesUngh().catch((err) => {
+		consola$1.debug("Failed to load templates via ungh:", err);
+		return listTemplatesGithub();
+	})).sort((l, r) => {
+		const diff = (TEMPLATE_SORT_WEIGHT[l.name] ?? Number.MAX_SAFE_INTEGER) - (TEMPLATE_SORT_WEIGHT[r.name] ?? Number.MAX_SAFE_INTEGER);
+		if (diff !== 0) return diff;
+		return l.name.localeCompare(r.name);
+	});
 }
 async function listTemplatesUngh() {
-  const res = await fetch("https://ungh.cc/repos/wxt-dev/wxt/files/main");
-  if (res.status !== 200)
-    throw Error(
-      `Request failed with status ${res.status} ${res.statusText}: ${await res.text()}`
-    );
-  const data = await res.json();
-  return data.files.map((item) => item.path.match(/templates\/(.+)\/package\.json/)?.[1]).filter((name) => name != null).map((name) => ({ name, path: `templates/${name}` }));
+	const res = await fetch("https://ungh.cc/repos/wxt-dev/wxt/files/main");
+	if (res.status !== 200) throw Error(`Request failed with status ${res.status} ${res.statusText}: ${await res.text()}`);
+	return (await res.json()).files.map((item) => item.path.match(/templates\/(.+)\/package\.json/)?.[1]).filter((name) => name != null).map((name) => ({
+		name,
+		path: `templates/${name}`
+	}));
 }
 async function listTemplatesGithub() {
-  const res = await fetch(
-    `https://api.github.com/repos/${REPO}/contents/templates`,
-    { headers: { Accept: "application/vnd.github+json" } }
-  );
-  if (res.status !== 200)
-    throw Error(
-      `Request failed with status ${res.status} ${res.statusText}: ${await res.text()}`
-    );
-  return await res.json();
+	const res = await fetch(`https://api.github.com/repos/${REPO}/contents/templates`, { headers: { Accept: "application/vnd.github+json" } });
+	if (res.status !== 200) throw Error(`Request failed with status ${res.status} ${res.statusText}: ${await res.text()}`);
+	return await res.json();
 }
-async function cloneProject({
-  directory,
-  template
-}) {
-  const { default: ora } = await import("ora");
-  const spinner = ora("Downloading template").start();
-  try {
-    await downloadTemplate(`gh:${REPO}/${template.path}`, {
-      dir: directory,
-      force: true
-    });
-    await fs.move(
-      path.join(directory, "_gitignore"),
-      path.join(directory, ".gitignore")
-    ).catch(
-      (err) => consola.warn("Failed to move _gitignore to .gitignore:", err)
-    );
-    spinner.succeed();
-  } catch (err) {
-    spinner.fail();
-    throw Error(`Failed to setup new project: ${JSON.stringify(err, null, 2)}`);
-  }
+async function cloneProject({ directory, template }) {
+	const { default: ora } = await import("ora");
+	const spinner = ora("Downloading template").start();
+	try {
+		await downloadTemplate(`gh:${REPO}/${template.path}`, {
+			dir: directory,
+			force: true
+		});
+		await fs.move(path.join(directory, "_gitignore"), path.join(directory, ".gitignore")).catch((err) => consola$1.warn("Failed to move _gitignore to .gitignore:", err));
+		spinner.succeed();
+	} catch (err) {
+		spinner.fail();
+		throw Error(`Failed to setup new project: ${JSON.stringify(err, null, 2)}`);
+	}
 }
 const TEMPLATE_COLORS = {
-  vanilla: pc.blue,
-  vue: pc.green,
-  react: pc.cyan,
-  svelte: pc.red,
-  solid: pc.blue
+	vanilla: pc.blue,
+	vue: pc.green,
+	react: pc.cyan,
+	svelte: pc.red,
+	solid: pc.blue
 };
 const TEMPLATE_SORT_WEIGHT = {
-  vanilla: 0,
-  vue: 1,
-  react: 2
+	vanilla: 0,
+	vue: 1,
+	react: 2
 };
 const REPO = "wxt-dev/wxt";
+
+//#endregion
+export { initialize };