wxt 0.2.3 → 0.2.5

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'>;
@@ -353,7 +404,7 @@ interface ExtensionRunnerConfig {
 
 type EntrypointGroup = Entrypoint | Entrypoint[];
 
-var version = "0.2.3";
+var version = "0.2.5";
 
 declare function defineConfig(config: UserConfig): UserConfig;
 

package/dist/index.js

@@ -223,7 +223,7 @@ function getUnimportOptions(config) {
     ],
     presets: [{ package: "wxt/client" }],
     warn: config.logger.warn,
-    dirs: ["components", "composables", "hooks", "utils"]
+    dirs: ["./components/*", "./composables/*", "./hooks/*", "./utils/*"]
   };
   return mergeConfig(
     defaultOptions,
@@ -297,6 +297,26 @@ function tsconfigPaths(config) {
   });
 }
 
+// src/core/vite-plugins/noopBackground.ts
+function noopBackground() {
+  const virtualModuleId = VIRTUAL_NOOP_BACKGROUND_MODULE_ID;
+  const resolvedVirtualModuleId = "\0" + virtualModuleId;
+  return {
+    name: "wxt:noop-background",
+    resolveId(id) {
+      if (id === virtualModuleId)
+        return resolvedVirtualModuleId;
+    },
+    load(id) {
+      if (id === resolvedVirtualModuleId) {
+        return `import { defineBackground } from 'wxt/client';
+export default defineBackground(() => void 0)`;
+      }
+    }
+  };
+}
+var VIRTUAL_NOOP_BACKGROUND_MODULE_ID = "virtual:user-background";
+
 // src/core/utils/createFsCache.ts
 import fs3, { ensureDir as ensureDir2 } from "fs-extra";
 import { dirname as dirname3, resolve as resolve5 } from "path";
@@ -430,7 +450,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;
@@ -450,6 +490,7 @@ async function getInternalConfig(config, command) {
   );
   finalConfig.vite.plugins.push(devServerGlobals(finalConfig));
   finalConfig.vite.plugins.push(tsconfigPaths(finalConfig));
+  finalConfig.vite.plugins.push(noopBackground());
   finalConfig.vite.define ??= {};
   getGlobals(finalConfig).forEach((global) => {
     finalConfig.vite.define[global.name] = JSON.stringify(global.value);
@@ -558,7 +599,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";
@@ -704,6 +745,16 @@ import { createUnimport as createUnimport2 } from "unimport";
 import fs6 from "fs-extra";
 import { resolve as resolve8 } from "path";
 import transform from "jiti/dist/babel";
+
+// src/core/utils/strings.ts
+function removeImportStatements(text) {
+  return text.replace(
+    /(import\s?[{\w][\s\S]*?from\s?["'][\s\S]*?["'];?|import\s?["'][\s\S]*?["'];?)/gm,
+    ""
+  );
+}
+
+// src/core/utils/importTsFile.ts
 async function importTsFile(path5, config) {
   config.logger.debug("Loading file metadata:", path5);
   const unimport2 = createUnimport2({
@@ -714,7 +765,7 @@ async function importTsFile(path5, config) {
   });
   await unimport2.init();
   const text = await fs6.readFile(path5, "utf-8");
-  const textNoImports = text.replace(/import.*[\n;]/gm, "");
+  const textNoImports = removeImportStatements(text);
   const { code } = await unimport2.injectImports(textNoImports);
   config.logger.debug(
     ["Text:", text, "No imports:", textNoImports, "Code:", code].join("\n")
@@ -754,6 +805,7 @@ async function findEntrypoints(config) {
   const pathGlobs = Object.keys(PATH_GLOB_TO_TYPE_MAP);
   const existingNames = {};
   const entrypoints = [];
+  let hasBackground = false;
   await Promise.all(
     relativePaths.map(async (relativePath) => {
       const path5 = resolve9(config.entrypointsDir, relativePath);
@@ -783,6 +835,7 @@ ${JSON.stringify(
           break;
         case "background":
           entrypoint = await getBackgroundEntrypoint(config, path5);
+          hasBackground = true;
           break;
         case "content-script":
           entrypoint = await getContentScriptEntrypoint(
@@ -812,6 +865,11 @@ ${JSON.stringify(
       existingNames[entrypoint.name] = entrypoint;
     })
   );
+  if (config.command === "serve" && !hasBackground) {
+    entrypoints.push(
+      await getBackgroundEntrypoint(config, VIRTUAL_NOOP_BACKGROUND_MODULE_ID)
+    );
+  }
   return entrypoints;
 }
 async function getPopupEntrypoint(config, path5) {
@@ -869,9 +927,17 @@ async function getOptionsEntrypoint(config, path5) {
   };
 }
 async function getBackgroundEntrypoint(config, path5) {
-  const { main: _, ...options } = await importTsFile(path5, config);
-  if (options == null) {
-    throw Error("Background script does not have a default export");
+  let options = {};
+  if (path5 !== VIRTUAL_NOOP_BACKGROUND_MODULE_ID) {
+    const defaultExport = await importTsFile(
+      path5,
+      config
+    );
+    if (defaultExport == null) {
+      throw Error("Background script does not have a default export");
+    }
+    const { main: _, ...moduleOptions } = defaultExport;
+    options = moduleOptions;
   }
   return {
     type: "background",
@@ -915,6 +981,7 @@ var PATH_GLOB_TO_TYPE_MAP = {
   "devtools.html": "devtools",
   "devtools/index.html": "devtools",
   "background.ts": "background",
+  [VIRTUAL_NOOP_BACKGROUND_MODULE_ID]: "background",
   "content.ts?(x)": "content-script",
   "content/index.ts?(x)": "content-script",
   "*.content.ts?(x)": "content-script",
@@ -1049,8 +1116,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 +1200,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",
@@ -1176,17 +1258,6 @@ async function generateMainfest(entrypoints, buildOutput, config) {
   }
   return manifest;
 }
-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 {};
-  }
-}
 function simplifyVersion(versionName) {
   const version3 = /^((0|[1-9][0-9]{0,8})([.](0|[1-9][0-9]{0,8})){0,3}).*$/.exec(
     versionName
@@ -1430,7 +1501,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) {
@@ -1478,7 +1549,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) {
@@ -1506,10 +1583,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),
@@ -1522,28 +1631,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 = {
@@ -1558,16 +1647,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) {
@@ -1579,11 +1658,11 @@ 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);
+  const { output } = await rebuild(config, groups, void 0);
   config.logger.success(
     `Built extension in ${formatDuration(Date.now() - startTime)}`
   );
@@ -1595,7 +1674,11 @@ async function rebuild(config, entrypointGroups, existingOutput = {
   publicAssets: []
 }) {
   const allEntrypoints = await findEntrypoints(config);
-  await generateTypesDir(allEntrypoints, config);
+  await generateTypesDir(allEntrypoints, config).catch((err) => {
+    config.logger.warn("Failed to update .wxt directory:", err);
+    if (config.command === "build")
+      throw err;
+  });
   const newOutput = await buildEntrypoints(entrypointGroups, config);
   const mergedOutput = {
     steps: [...existingOutput.steps, ...newOutput.steps],
@@ -1771,7 +1854,7 @@ function reloadHtmlPages(groups, server, config) {
 }
 
 // package.json
-var version2 = "0.2.3";
+var version2 = "0.2.5";
 
 // src/core/utils/defineConfig.ts
 function defineConfig(config) {
@@ -1811,15 +1894,17 @@ async function createServer2(config) {
     changeQueue.push([event, path5]);
     await fileChangedMutex.runExclusive(async () => {
       const fileChanges = changeQueue.splice(0, changeQueue.length);
+      if (fileChanges.length === 0)
+        return;
       const changes = detectDevChanges(fileChanges, server.currentOutput);
       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();