wxt 0.2.2 → 0.2.4

package/dist/index.d.ts

@@ -91,6 +91,57 @@ interface InlineConfig {
      * Custom runner options. Options set here can be overridden in a `web-ext.config.ts` file.
      */
     runner?: ExtensionRunnerConfig;
+    zip?: {
+        /**
+         * Configure the filename output when zipping files.
+         *
+         * Available template variables:
+         *
+         * - `{{name}}` - The project's name converted to kebab-case
+         * - `{{version}} - The version_name or version from the manifest
+         * - `{{browser}} - The target browser from the `--browser` CLI flag
+         * - `{{manifestVersion}}` - Either "2" or "3"
+         *
+         * @default "{{name}}-{{version}}-{{browser}}.zip"
+         */
+        artifactTemplate?: string;
+        /**
+         * Configure the filename output when zipping files.
+         *
+         * Available template variables:
+         *
+         * - `{{name}}` - The project's name converted to kebab-case
+         * - `{{version}} - The version_name or version from the manifest
+         * - `{{browser}} - The target browser from the `--browser` CLI flag
+         * - `{{manifestVersion}}` - Either "2" or "3"
+         *
+         * @default "{{name}}-{{version}}-sources.zip"
+         */
+        sourcesTemplate?: string;
+        /**
+         * Override the artifactTemplate's `{{name}}` template variable. Defaults to the package.json's
+         * name, or if that doesn't exist, the current working directories name.
+         */
+        name?: string;
+        /**
+         * Root directory to ZIP. The ZIP can be uploaded to the Firefox Addon Store as your source
+         * code. Defaults to the `config.root` directory.
+         */
+        sourcesRoot?: string;
+        /**
+         * [Minimatch](https://www.npmjs.com/package/minimatch) patterns of files to exclude when
+         * creating a ZIP of all your source code for Firfox. Patterns are relative to your
+         * `config.zip.sourcesRoot`.
+         *
+         * Hidden files, node_modules, and tests are ignored by default.
+         *
+         * @example
+         * [
+         *   "coverage", // Ignore the coverage directory in the `sourcesRoot`
+         * ]
+         */
+        ignoredSources?: string[];
+    };
 }
 interface WxtInlineViteConfig extends Omit<vite.InlineConfig, 'root' | 'configFile' | 'mode' | 'build'> {
     build?: Omit<vite.BuildOptions, 'outDir'>;
@@ -275,10 +326,10 @@ interface BackgroundScriptDefintition {
     main(): void;
 }
 /**
- * Manifest customization available in the `wxt.config.ts` file. Any missing fields like "name"
- * and "version" are managed automatically, and don't need to be listed here.
+ * Manifest customization available in the `wxt.config.ts` file. You cannot configure entrypoints
+ * here, they are configured inline.
  */
-type UserManifest = Omit<Manifest.WebExtensionManifest, 'action' | 'background' | 'browser_action' | 'chrome_url_overrides' | 'content_scripts' | 'description' | 'devtools_page' | 'manifest_version' | 'name' | 'options_page' | 'options_ui' | 'sandbox' | 'page_action' | 'popup' | 'short_name' | 'sidepanel' | 'sidebar_action' | 'version' | 'version_name'>;
+type UserManifest = Partial<Omit<Manifest.WebExtensionManifest, 'action' | 'background' | 'browser_action' | 'chrome_url_overrides' | 'content_scripts' | 'devtools_page' | 'manifest_version' | 'options_page' | 'options_ui' | 'sandbox' | 'page_action' | 'popup' | 'sidepanel' | 'sidebar_action'>>;
 type UserManifestFn = (env: ConfigEnv) => UserManifest | Promise<UserManifest>;
 interface ConfigEnv {
     mode: string;
@@ -353,7 +404,7 @@ interface ExtensionRunnerConfig {
 
 type EntrypointGroup = Entrypoint | Entrypoint[];
 
-var version = "0.2.2";
+var version = "0.2.4";
 
 declare function defineConfig(config: UserConfig): UserConfig;
 

package/dist/index.js

@@ -430,7 +430,27 @@ async function getInternalConfig(config, command) {
     wxtDir,
     typesDir,
     fsCache: createFsCache(wxtDir),
-    manifest
+    manifest,
+    zip: {
+      sourcesTemplate: "{{name}}-{{version}}-sources.zip",
+      artifactTemplate: "{{name}}-{{version}}-{{browser}}.zip",
+      sourcesRoot: root,
+      ...userConfig.zip,
+      ...config.zip,
+      ignoredSources: [
+        "**/node_modules",
+        // WXT files
+        "**/web-ext.config.ts",
+        // Hidden files
+        "**/.*",
+        // Tests
+        "**/__tests__/**",
+        "**/*.+(test|spec).?(c|m)+(j|t)s?(x)",
+        // User config
+        ...userConfig.zip?.ignoredSources ?? [],
+        ...config.zip?.ignoredSources ?? []
+      ]
+    }
   };
   finalConfig.vite.root = root;
   finalConfig.vite.configFile = false;
@@ -558,7 +578,7 @@ function findEffectedSteps(changedFile, currentOutput) {
 // src/index.ts
 import { Mutex } from "async-mutex";
 import { consola as consola2 } from "consola";
-import { relative as relative6 } from "node:path";
+import { relative as relative5 } from "node:path";
 
 // src/core/build/buildEntrypoints.ts
 import * as vite2 from "vite";
@@ -850,15 +870,15 @@ async function getOptionsEntrypoint(config, path5) {
   const { document } = parseHTML2(content);
   const openInTabContent = document.querySelector("meta[name='manifest.open_in_tab']")?.getAttribute("content");
   if (openInTabContent) {
-    options.openInTab = Boolean(openInTabContent);
+    options.openInTab = openInTabContent === "true";
   }
   const chromeStyleContent = document.querySelector("meta[name='manifest.chrome_style']")?.getAttribute("content");
   if (chromeStyleContent) {
-    options.chromeStyle = Boolean(chromeStyleContent);
+    options.chromeStyle = chromeStyleContent === "true";
   }
   const browserStyleContent = document.querySelector("meta[name='manifest.browser_style']")?.getAttribute("content");
   if (browserStyleContent) {
-    options.browserStyle = Boolean(browserStyleContent);
+    options.browserStyle = browserStyleContent === "true";
   }
   return {
     type: "options",
@@ -1049,8 +1069,8 @@ async function writeTsConfigFile(mainReference, config) {
 }
 
 // src/core/utils/manifest.ts
-import fs9 from "fs-extra";
-import { resolve as resolve11 } from "path";
+import fs10 from "fs-extra";
+import { resolve as resolve12 } from "path";
 
 // src/core/utils/ContentSecurityPolicy.ts
 var ContentSecurityPolicy = class _ContentSecurityPolicy {
@@ -1133,11 +1153,26 @@ function mapWxtOptionsToContentScript(options) {
   };
 }
 
+// src/core/utils/package.ts
+import { resolve as resolve11 } from "node:path";
+import fs9 from "fs-extra";
+async function getPackageJson(config) {
+  const file = resolve11(config.root, "package.json");
+  try {
+    return await fs9.readJson(file);
+  } catch (err) {
+    config.logger.debug(
+      `Failed to read package.json at: ${file}. Returning undefined.`
+    );
+    return {};
+  }
+}
+
 // src/core/utils/manifest.ts
 async function writeManifest(manifest, output, config) {
   const str = config.mode === "production" ? JSON.stringify(manifest) : JSON.stringify(manifest, null, 2);
-  await fs9.ensureDir(config.outDir);
-  await fs9.writeFile(resolve11(config.outDir, "manifest.json"), str, "utf-8");
+  await fs10.ensureDir(config.outDir);
+  await fs10.writeFile(resolve12(config.outDir, "manifest.json"), str, "utf-8");
   output.publicAssets.unshift({
     type: "asset",
     fileName: "manifest.json",
@@ -1148,30 +1183,34 @@ async function writeManifest(manifest, output, config) {
 }
 async function generateMainfest(entrypoints, buildOutput, config) {
   const pkg = await getPackageJson(config);
-  if (pkg.version == null)
-    throw Error("package.json does not include a version");
-  if (pkg.name == null)
-    throw Error("package.json does not include a name");
-  if (pkg.description == null)
-    throw Error("package.json does not include a description");
-  const manifest = {
-    manifest_version: config.manifestVersion,
-    name: pkg.name,
-    short_name: pkg.shortName,
-    version: simplifyVersion(pkg.version),
-    version_name: config.browser === "firefox" ? void 0 : pkg.version,
-    ...config.manifest
-  };
+  const manifest = Object.assign(
+    {
+      manifest_version: config.manifestVersion,
+      name: pkg?.name,
+      description: pkg?.description,
+      version: pkg?.version && simplifyVersion(pkg.version),
+      // Only add the version name to chromium and if the user hasn't specified a custom version.
+      version_name: config.browser !== "firefox" && !config.manifest.version ? pkg?.version : void 0,
+      short_name: pkg?.shortName
+    },
+    config.manifest
+  );
   addEntrypoints(manifest, entrypoints, buildOutput, config);
   if (config.command === "serve")
     addDevModeCsp(manifest, config);
   if (config.command === "serve")
     addDevModePermissions(manifest, config);
+  if (manifest.name == null)
+    throw Error(
+      "Manifest 'name' is missing. Either:\n1. Set the name in your <root>/package.json\n2. Set a name via the manifest option in your wxt.config.ts"
+    );
+  if (manifest.version == null) {
+    throw Error(
+      "Manifest 'version' is missing. Either:\n1. Add a version in your <root>/package.json\n2. Pass the version via the manifest option in your wxt.config.ts"
+    );
+  }
   return manifest;
 }
-async function getPackageJson(config) {
-  return await fs9.readJson(resolve11(config.root, "package.json"));
-}
 function simplifyVersion(versionName) {
   const version3 = /^((0|[1-9][0-9]{0,8})([.](0|[1-9][0-9]{0,8})){0,3}).*$/.exec(
     versionName
@@ -1415,7 +1454,7 @@ function addHostPermission(manifest, hostPermission) {
 // src/core/build.ts
 import pc2 from "picocolors";
 import * as vite3 from "vite";
-import fs11 from "fs-extra";
+import fs12 from "fs-extra";
 
 // src/core/utils/groupEntrypoints.ts
 function groupEntrypoints(entrypoints) {
@@ -1463,7 +1502,13 @@ function formatDuration(duration) {
 }
 
 // src/core/log/printBuildSummary.ts
-import path4, { relative as relative5, resolve as resolve12 } from "path";
+import { resolve as resolve13 } from "path";
+
+// src/core/log/printFileList.ts
+import path4 from "node:path";
+import pc from "picocolors";
+import fs11 from "fs-extra";
+import { filesize } from "filesize";
 
 // src/core/log/printTable.ts
 function printTable(log, rows, gap = 2) {
@@ -1491,10 +1536,42 @@ function printTable(log, rows, gap = 2) {
   log(str);
 }
 
+// src/core/log/printFileList.ts
+async function printFileList(log, baseDir, files) {
+  let totalSize = 0;
+  const fileRows = await Promise.all(
+    files.map(async (file, i) => {
+      const parts = [
+        path4.relative(process.cwd(), baseDir) + path4.sep,
+        path4.relative(baseDir, file)
+      ];
+      const prefix = i === files.length - 1 ? "  \u2514\u2500" : "  \u251C\u2500";
+      const color = getChunkColor(file);
+      const stats = await fs11.lstat(file);
+      totalSize += stats.size;
+      const size = String(filesize(stats.size));
+      return [
+        `${pc.gray(prefix)} ${pc.dim(parts[0])}${color(parts[1])}`,
+        pc.dim(size)
+      ];
+    })
+  );
+  printTable(log, fileRows);
+  log(`${pc.cyan("\u03A3 Total size:")} ${String(filesize(totalSize))}`);
+}
+var DEFAULT_COLOR = pc.blue;
+var CHUNK_COLORS = {
+  ".js.map": pc.gray,
+  ".html": pc.green,
+  ".css": pc.magenta,
+  ".js": pc.cyan,
+  ".zip": pc.yellow
+};
+function getChunkColor(filename) {
+  return Object.entries(CHUNK_COLORS).find(([key]) => filename.endsWith(key))?.[1] ?? DEFAULT_COLOR;
+}
+
 // src/core/log/printBuildSummary.ts
-import pc from "picocolors";
-import fs10 from "fs-extra";
-import { filesize } from "filesize";
 async function printBuildSummary(output, config) {
   const chunks = [
     ...output.steps.flatMap((step) => step.chunks),
@@ -1507,28 +1584,8 @@ async function printBuildSummary(output, config) {
       return diff;
     return l.fileName.localeCompare(r.fileName);
   });
-  let totalSize = 0;
-  const chunkRows = await Promise.all(
-    chunks.map(async (chunk, i) => {
-      const file = [
-        relative5(process.cwd(), config.outDir) + path4.sep,
-        chunk.fileName
-      ];
-      const prefix = i === chunks.length - 1 ? "  \u2514\u2500" : "  \u251C\u2500";
-      const color = getChunkColor(chunk.fileName);
-      const stats = await fs10.lstat(resolve12(config.outDir, chunk.fileName));
-      totalSize += stats.size;
-      const size = String(filesize(stats.size));
-      return [
-        `${pc.gray(prefix)} ${pc.dim(file[0])}${color(file[1])}`,
-        pc.dim(size)
-      ];
-    })
-  );
-  printTable(config.logger.log, chunkRows);
-  config.logger.log(
-    `${pc.cyan("\u03A3 Total size:")} ${String(filesize(totalSize))}`
-  );
+  const files = chunks.map((chunk) => resolve13(config.outDir, chunk.fileName));
+  await printFileList(config.logger.log, config.outDir, files);
 }
 var DEFAULT_SORT_WEIGHT = 100;
 var CHUNK_SORT_WEIGHTS = {
@@ -1543,16 +1600,6 @@ function getChunkSortWeight(filename) {
     ([key]) => filename.endsWith(key)
   )?.[1] ?? DEFAULT_SORT_WEIGHT;
 }
-var DEFAULT_COLOR = pc.blue;
-var CHUNK_COLORS = {
-  ".js.map": pc.gray,
-  ".html": pc.green,
-  ".css": pc.magenta,
-  ".js": pc.cyan
-};
-function getChunkColor(filename) {
-  return Object.entries(CHUNK_COLORS).find(([key]) => filename.endsWith(key))?.[1] ?? DEFAULT_COLOR;
-}
 
 // src/core/build.ts
 async function buildInternal(config) {
@@ -1564,8 +1611,8 @@ async function buildInternal(config) {
     )}`
   );
   const startTime = Date.now();
-  await fs11.rm(config.outDir, { recursive: true, force: true });
-  await fs11.ensureDir(config.outDir);
+  await fs12.rm(config.outDir, { recursive: true, force: true });
+  await fs12.ensureDir(config.outDir);
   const entrypoints = await findEntrypoints(config);
   const groups = groupEntrypoints(entrypoints);
   const { output } = await rebuild(config, groups);
@@ -1612,29 +1659,6 @@ async function rebuild(config, entrypointGroups, existingOutput = {
 // src/core/server.ts
 import * as vite4 from "vite";
 
-// src/core/utils/findOpenPort.ts
-import net from "node:net";
-function findOpenPort(startPort, endPort) {
-  return findOpenPortRecursive(startPort, startPort, endPort);
-}
-function findOpenPortRecursive(port, startPort, endPort) {
-  return new Promise((resolve13, reject) => {
-    if (port > endPort)
-      return reject(
-        Error(`Could not find open port between ${startPort}-${endPort}`)
-      );
-    const server = net.createServer();
-    server.listen(port, () => {
-      server.once("close", () => resolve13(port));
-      server.close();
-    });
-    server.on(
-      "error",
-      () => resolve13(findOpenPortRecursive(port + 1, startPort, endPort))
-    );
-  });
-}
-
 // src/core/runners/createWebExtRunner.ts
 function createWebExtRunner() {
   let runner;
@@ -1694,7 +1718,8 @@ var ERROR_LOG_LEVEL = 50;
 
 // src/core/server.ts
 async function getServerInfo() {
-  const port = await findOpenPort(3e3, 3010);
+  const { default: getPort, portNumbers } = await import("get-port");
+  const port = await getPort({ port: portNumbers(3e3, 3010) });
   const hostname = "localhost";
   const origin = `http://${hostname}:${port}`;
   const serverConfig = {
@@ -1778,7 +1803,7 @@ function reloadHtmlPages(groups, server, config) {
 }
 
 // package.json
-var version2 = "0.2.2";
+var version2 = "0.2.4";
 
 // src/core/utils/defineConfig.ts
 function defineConfig(config) {
@@ -1822,11 +1847,11 @@ async function createServer2(config) {
       if (changes.type === "no-change")
         return;
       internalConfig.logger.info(
-        `Changed: ${Array.from(new Set(fileChanges.map((change) => change[1]))).map((file) => pc3.dim(relative6(internalConfig.root, file))).join(", ")}`
+        `Changed: ${Array.from(new Set(fileChanges.map((change) => change[1]))).map((file) => pc3.dim(relative5(internalConfig.root, file))).join(", ")}`
       );
       const rebuiltNames = changes.rebuildGroups.flat().map((entry) => {
         return pc3.cyan(
-          relative6(internalConfig.outDir, getEntrypointOutputFile(entry, ""))
+          relative5(internalConfig.outDir, getEntrypointOutputFile(entry, ""))
         );
       }).join(pc3.dim(", "));
       internalConfig = await getLatestInternalConfig();