wxt 0.2.0 → 0.2.2

package/dist/client.d.ts

@@ -1,9 +1,50 @@
+import { Manifest } from 'webextension-polyfill';
+
 interface ContentScriptDefinition {
-    matches: string[];
-    runAt?: 'document_start' | 'document_end' | 'document_idle';
-    matchAboutBlank?: boolean;
+    matches: Manifest.ContentScript['matches'];
+    /**
+     * See https://developer.chrome.com/docs/extensions/mv3/content_scripts/
+     * @default "documentIdle"
+     */
+    runAt?: Manifest.ContentScript['run_at'];
+    /**
+     * See https://developer.chrome.com/docs/extensions/mv3/content_scripts/
+     * @default false
+     */
+    matchAboutBlank?: Manifest.ContentScript['match_about_blank'];
+    /**
+     * See https://developer.chrome.com/docs/extensions/mv3/content_scripts/
+     * @default []
+     */
+    excludeMatches?: Manifest.ContentScript['exclude_matches'];
+    /**
+     * See https://developer.chrome.com/docs/extensions/mv3/content_scripts/
+     * @default []
+     */
+    includeGlobs?: Manifest.ContentScript['include_globs'];
+    /**
+     * See https://developer.chrome.com/docs/extensions/mv3/content_scripts/
+     * @default []
+     */
+    excludeGlobs?: Manifest.ContentScript['exclude_globs'];
+    /**
+     * See https://developer.chrome.com/docs/extensions/mv3/content_scripts/
+     * @default false
+     */
+    allFrames?: Manifest.ContentScript['all_frames'];
+    /**
+     * See https://developer.chrome.com/docs/extensions/mv3/content_scripts/
+     * @default false
+     */
     matchOriginAsFallback?: boolean;
+    /**
+     * See https://developer.chrome.com/docs/extensions/mv3/content_scripts/
+     * @default "ISOLATED"
+     */
     world?: 'ISOLATED' | 'MAIN';
+    /**
+     * Main function executed when the content script is loaded.
+     */
     main(): void | Promise<void>;
 }
 interface BackgroundScriptDefintition {

package/dist/index.cjs

@@ -337,32 +337,15 @@ function tsconfigPaths(config) {
   });
 }
 
-// src/core/vite-plugins/hmrLogger.ts
-var import_path4 = require("path");
-var import_picocolors = __toESM(require("picocolors"), 1);
-function hmrLogger(config) {
-  return {
-    name: "wxt:hmr-logger",
-    apply: "serve",
-    handleHotUpdate(ctx) {
-      if (ctx.file.startsWith(config.srcDir) && !ctx.file.startsWith(config.wxtDir) && !ctx.file.endsWith(".html")) {
-        config.logger.info(
-          "Hot reload: " + import_picocolors.default.dim((0, import_path4.relative)(process.cwd(), ctx.file))
-        );
-      }
-    }
-  };
-}
-
 // src/core/utils/createFsCache.ts
 var import_fs_extra3 = __toESM(require("fs-extra"), 1);
-var import_path5 = require("path");
+var import_path4 = require("path");
 function createFsCache(wxtDir) {
-  const getPath = (key) => (0, import_path5.resolve)(wxtDir, "cache", encodeURIComponent(key));
+  const getPath = (key) => (0, import_path4.resolve)(wxtDir, "cache", encodeURIComponent(key));
   return {
     async set(key, value) {
       const path5 = getPath(key);
-      await (0, import_fs_extra3.ensureDir)((0, import_path5.dirname)(path5));
+      await (0, import_fs_extra3.ensureDir)((0, import_path4.dirname)(path5));
       await import_fs_extra3.default.writeFile(path5, value, "utf-8");
     },
     async get(key) {
@@ -507,7 +490,6 @@ async function getInternalConfig(config, command) {
   );
   finalConfig.vite.plugins.push(devServerGlobals(finalConfig));
   finalConfig.vite.plugins.push(tsconfigPaths(finalConfig));
-  finalConfig.vite.plugins.push(hmrLogger(finalConfig));
   finalConfig.vite.define ??= {};
   getGlobals(finalConfig).forEach((global) => {
     finalConfig.vite.define[global.name] = JSON.stringify(global.value);
@@ -519,7 +501,7 @@ async function resolveManifestConfig(env, manifest) {
 }
 
 // src/index.ts
-var import_picocolors4 = __toESM(require("picocolors"), 1);
+var import_picocolors3 = __toESM(require("picocolors"), 1);
 var vite5 = __toESM(require("vite"), 1);
 
 // src/core/utils/arrays.ts
@@ -623,11 +605,11 @@ var vite2 = __toESM(require("vite"), 1);
 
 // src/core/utils/removeEmptyDirs.ts
 var import_fs_extra4 = __toESM(require("fs-extra"), 1);
-var import_path6 = __toESM(require("path"), 1);
+var import_path5 = __toESM(require("path"), 1);
 async function removeEmptyDirs(dir) {
   const files = await import_fs_extra4.default.readdir(dir);
   for (const file of files) {
-    const filePath = import_path6.default.join(dir, file);
+    const filePath = import_path5.default.join(dir, file);
     const stats = await import_fs_extra4.default.stat(filePath);
     if (stats.isDirectory()) {
       await removeEmptyDirs(filePath);
@@ -642,7 +624,7 @@ async function removeEmptyDirs(dir) {
 // src/core/build/buildEntrypoints.ts
 var import_fast_glob = __toESM(require("fast-glob"), 1);
 var import_fs_extra5 = __toESM(require("fs-extra"), 1);
-var import_path7 = require("path");
+var import_path6 = require("path");
 async function buildEntrypoints(groups, config) {
   const steps = [];
   for (const group of groups) {
@@ -734,9 +716,9 @@ async function copyPublicDirectory(config) {
     return publicAssets;
   const files = await (0, import_fast_glob.default)("**/*", { cwd: config.publicDir });
   for (const file of files) {
-    const srcPath = (0, import_path7.resolve)(config.publicDir, file);
-    const outPath = (0, import_path7.resolve)(config.outDir, file);
-    await import_fs_extra5.default.ensureDir((0, import_path7.dirname)(outPath));
+    const srcPath = (0, import_path6.resolve)(config.publicDir, file);
+    const outPath = (0, import_path6.resolve)(config.outDir, file);
+    await import_fs_extra5.default.ensureDir((0, import_path6.dirname)(outPath));
     await import_fs_extra5.default.copyFile(srcPath, outPath);
     publicAssets.push({
       type: "asset",
@@ -750,7 +732,7 @@ async function copyPublicDirectory(config) {
 }
 
 // src/core/build/findEntrypoints.ts
-var import_path9 = require("path");
+var import_path8 = require("path");
 var import_fs_extra7 = __toESM(require("fs-extra"), 1);
 var import_picomatch = __toESM(require("picomatch"), 1);
 var import_linkedom2 = require("linkedom");
@@ -760,7 +742,7 @@ var import_json5 = __toESM(require("json5"), 1);
 var import_jiti = __toESM(require("jiti"), 1);
 var import_unimport2 = require("unimport");
 var import_fs_extra6 = __toESM(require("fs-extra"), 1);
-var import_path8 = require("path");
+var import_path7 = require("path");
 var import_babel = __toESM(require("jiti/dist/babel"), 1);
 async function importTsFile(path5, config) {
   config.logger.debug("Loading file metadata:", path5);
@@ -782,7 +764,7 @@ async function importTsFile(path5, config) {
     esmResolve: true,
     interopDefault: true,
     alias: {
-      "webextension-polyfill": (0, import_path8.resolve)(
+      "webextension-polyfill": (0, import_path7.resolve)(
         config.root,
         "node_modules/wxt/dist/virtual-modules/fake-browser.js"
       )
@@ -814,7 +796,7 @@ async function findEntrypoints(config) {
   const entrypoints = [];
   await Promise.all(
     relativePaths.map(async (relativePath) => {
-      const path5 = (0, import_path9.resolve)(config.entrypointsDir, relativePath);
+      const path5 = (0, import_path8.resolve)(config.entrypointsDir, relativePath);
       const matchingGlob = pathGlobs.find(
         (glob3) => import_picomatch.default.isMatch(relativePath, glob3)
       );
@@ -861,8 +843,8 @@ ${JSON.stringify(
       if (withSameName) {
         throw Error(
           `Multiple entrypoints with the name "${entrypoint.name}" detected, but only one is allowed: ${[
-            (0, import_path9.relative)(config.root, withSameName.inputPath),
-            (0, import_path9.relative)(config.root, entrypoint.inputPath)
+            (0, import_path8.relative)(config.root, withSameName.inputPath),
+            (0, import_path8.relative)(config.root, entrypoint.inputPath)
           ].join(", ")}`
         );
       }
@@ -951,7 +933,7 @@ async function getContentScriptEntrypoint(config, name, path5) {
     type: "content-script",
     name: getEntrypointName(config.entrypointsDir, path5),
     inputPath: path5,
-    outputDir: (0, import_path9.resolve)(config.outDir, "content-scripts"),
+    outputDir: (0, import_path8.resolve)(config.outDir, "content-scripts"),
     options
   };
 }
@@ -991,7 +973,7 @@ var PATH_GLOB_TO_TYPE_MAP = {
 // src/core/build/generateTypesDir.ts
 var import_unimport3 = require("unimport");
 var import_fs_extra8 = __toESM(require("fs-extra"), 1);
-var import_path10 = require("path");
+var import_path9 = require("path");
 async function generateTypesDir(entrypoints, config) {
   await import_fs_extra8.default.ensureDir(config.typesDir);
   const references = [];
@@ -1002,7 +984,7 @@ async function generateTypesDir(entrypoints, config) {
   await writeTsConfigFile(mainReference, config);
 }
 async function writeImportsDeclarationFile(config) {
-  const filePath = (0, import_path10.resolve)(config.typesDir, "imports.d.ts");
+  const filePath = (0, import_path9.resolve)(config.typesDir, "imports.d.ts");
   const unimport2 = (0, import_unimport3.createUnimport)(getUnimportOptions(config));
   await unimport2.scanImportsFromDir(void 0, { cwd: config.srcDir });
   await import_fs_extra8.default.writeFile(
@@ -1014,7 +996,7 @@ async function writeImportsDeclarationFile(config) {
   return filePath;
 }
 async function writePathsDeclarationFile(entrypoints, config) {
-  const filePath = (0, import_path10.resolve)(config.typesDir, "paths.d.ts");
+  const filePath = (0, import_path9.resolve)(config.typesDir, "paths.d.ts");
   const unions = entrypoints.map((entry) => {
     const path5 = getEntrypointBundlePath(
       entry,
@@ -1034,7 +1016,7 @@ async function writePathsDeclarationFile(entrypoints, config) {
   return filePath;
 }
 async function writeGlobalsDeclarationFile(config) {
-  const filePath = (0, import_path10.resolve)(config.typesDir, "globals.d.ts");
+  const filePath = (0, import_path9.resolve)(config.typesDir, "globals.d.ts");
   const globals = getGlobals(config);
   await import_fs_extra8.default.writeFile(
     filePath,
@@ -1051,14 +1033,14 @@ async function writeGlobalsDeclarationFile(config) {
 }
 async function writeMainDeclarationFile(references, config) {
   const dir = config.wxtDir;
-  const filePath = (0, import_path10.resolve)(dir, "wxt.d.ts");
+  const filePath = (0, import_path9.resolve)(dir, "wxt.d.ts");
   await import_fs_extra8.default.writeFile(
     filePath,
     [
       "// Generated by wxt",
       `/// <reference types="vite/client" />`,
       ...references.map(
-        (ref) => `/// <reference types="./${(0, import_path10.relative)(dir, ref)}" />`
+        (ref) => `/// <reference types="./${(0, import_path9.relative)(dir, ref)}" />`
       )
     ].join("\n") + "\n"
   );
@@ -1067,7 +1049,7 @@ async function writeMainDeclarationFile(references, config) {
 async function writeTsConfigFile(mainReference, config) {
   const dir = config.wxtDir;
   await import_fs_extra8.default.writeFile(
-    (0, import_path10.resolve)(dir, "tsconfig.json"),
+    (0, import_path9.resolve)(dir, "tsconfig.json"),
     `{
   "compilerOptions": {
     "target": "ESNext",
@@ -1085,30 +1067,30 @@ async function writeTsConfigFile(mainReference, config) {
     "skipLibCheck": true,
 
     /* Aliases */
-    "baseUrl": "${(0, import_path10.relative)(dir, config.root)}",
+    "baseUrl": "${(0, import_path9.relative)(dir, config.root)}",
     "paths": {
       "@@": ["."],
       "@@/*": ["./*"],
       "~~": ["."],
       "~~/*": ["./*"],
-      "@": ["${(0, import_path10.relative)(config.root, config.srcDir)}"],
-      "@/*": ["${(0, import_path10.relative)(config.root, config.srcDir)}/*"],
-      "~": ["${(0, import_path10.relative)(config.root, config.srcDir)}"],
-      "~/*": ["${(0, import_path10.relative)(config.root, config.srcDir)}/*"]
+      "@": ["${(0, import_path9.relative)(config.root, config.srcDir)}"],
+      "@/*": ["${(0, import_path9.relative)(config.root, config.srcDir)}/*"],
+      "~": ["${(0, import_path9.relative)(config.root, config.srcDir)}"],
+      "~/*": ["${(0, import_path9.relative)(config.root, config.srcDir)}/*"]
     }
   },
   "include": [
-    "${(0, import_path10.relative)(dir, config.root)}/**/*",
-    "./${(0, import_path10.relative)(dir, mainReference)}"
+    "${(0, import_path9.relative)(dir, config.root)}/**/*",
+    "./${(0, import_path9.relative)(dir, mainReference)}"
   ],
-  "exclude": ["${(0, import_path10.relative)(dir, config.outBaseDir)}"]
+  "exclude": ["${(0, import_path9.relative)(dir, config.outBaseDir)}"]
 }`
   );
 }
 
 // src/core/utils/manifest.ts
 var import_fs_extra9 = __toESM(require("fs-extra"), 1);
-var import_path11 = require("path");
+var import_path10 = require("path");
 
 // src/core/utils/ContentSecurityPolicy.ts
 var ContentSecurityPolicy = class _ContentSecurityPolicy {
@@ -1153,11 +1135,49 @@ var ContentSecurityPolicy = class _ContentSecurityPolicy {
   }
 };
 
+// src/core/utils/content-scripts.ts
+function hashContentScriptOptions(options) {
+  const withDefaults = {
+    excludeGlobs: [],
+    excludeMatches: [],
+    includeGlobs: [],
+    matchAboutBlank: false,
+    matchOriginAsFallback: false,
+    runAt: "document_idle",
+    allFrames: false,
+    world: "ISOLATED",
+    // TODO: strip undefined fields from options object to improve content script grouping.
+    ...options
+  };
+  return JSON.stringify(
+    Object.entries(withDefaults).map(([key, value]) => {
+      if (Array.isArray(value))
+        return [key, value.sort()];
+      else
+        return [key, value];
+    }).sort((l, r) => l[0].localeCompare(r[0]))
+  );
+}
+function mapWxtOptionsToContentScript(options) {
+  return {
+    matches: options.matches,
+    all_frames: options.allFrames,
+    match_about_blank: options.matchAboutBlank,
+    exclude_globs: options.excludeGlobs,
+    exclude_matches: options.excludeMatches,
+    include_globs: options.includeGlobs,
+    run_at: options.runAt,
+    // @ts-expect-error: untyped chrome options
+    match_origin_as_fallback: options.matchOriginAsFallback,
+    world: options.world
+  };
+}
+
 // 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 import_fs_extra9.default.ensureDir(config.outDir);
-  await import_fs_extra9.default.writeFile((0, import_path11.resolve)(config.outDir, "manifest.json"), str, "utf-8");
+  await import_fs_extra9.default.writeFile((0, import_path10.resolve)(config.outDir, "manifest.json"), str, "utf-8");
   output.publicAssets.unshift({
     type: "asset",
     fileName: "manifest.json",
@@ -1190,7 +1210,7 @@ async function generateMainfest(entrypoints, buildOutput, config) {
   return manifest;
 }
 async function getPackageJson(config) {
-  return await import_fs_extra9.default.readJson((0, import_path11.resolve)(config.root, "package.json"));
+  return await import_fs_extra9.default.readJson((0, import_path10.resolve)(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(
@@ -1355,7 +1375,7 @@ function addEntrypoints(manifest, entrypoints, buildOutput, config) {
       );
     } else {
       const hashToEntrypointsMap = contentScripts.reduce((map, script) => {
-        const hash = JSON.stringify(script.options);
+        const hash = hashContentScriptOptions(script.options);
         if (map.has(hash))
           map.get(hash)?.push(script);
         else
@@ -1364,7 +1384,7 @@ function addEntrypoints(manifest, entrypoints, buildOutput, config) {
       }, /* @__PURE__ */ new Map());
       manifest.content_scripts = Array.from(hashToEntrypointsMap.entries()).map(
         ([, scripts]) => ({
-          ...scripts[0].options,
+          ...mapWxtOptionsToContentScript(scripts[0].options),
           // TOOD: Sorting css and js arrays here so we get consistent test results... but we
           // shouldn't have to. Where is the inconsistency coming from?
           css: getContentScriptCssFiles(scripts, buildOutput)?.sort(),
@@ -1433,7 +1453,7 @@ function addHostPermission(manifest, hostPermission) {
 }
 
 // src/core/build.ts
-var import_picocolors3 = __toESM(require("picocolors"), 1);
+var import_picocolors2 = __toESM(require("picocolors"), 1);
 var vite3 = __toESM(require("vite"), 1);
 var import_fs_extra11 = __toESM(require("fs-extra"), 1);
 
@@ -1483,7 +1503,7 @@ function formatDuration(duration) {
 }
 
 // src/core/log/printBuildSummary.ts
-var import_path12 = __toESM(require("path"), 1);
+var import_path11 = __toESM(require("path"), 1);
 
 // src/core/log/printTable.ts
 function printTable(log, rows, gap = 2) {
@@ -1512,7 +1532,7 @@ function printTable(log, rows, gap = 2) {
 }
 
 // src/core/log/printBuildSummary.ts
-var import_picocolors2 = __toESM(require("picocolors"), 1);
+var import_picocolors = __toESM(require("picocolors"), 1);
 var import_fs_extra10 = __toESM(require("fs-extra"), 1);
 var import_filesize = require("filesize");
 async function printBuildSummary(output, config) {
@@ -1531,23 +1551,23 @@ async function printBuildSummary(output, config) {
   const chunkRows = await Promise.all(
     chunks.map(async (chunk, i) => {
       const file = [
-        (0, import_path12.relative)(process.cwd(), config.outDir) + import_path12.default.sep,
+        (0, import_path11.relative)(process.cwd(), config.outDir) + import_path11.default.sep,
         chunk.fileName
       ];
       const prefix = i === chunks.length - 1 ? "  \u2514\u2500" : "  \u251C\u2500";
       const color = getChunkColor(chunk.fileName);
-      const stats = await import_fs_extra10.default.lstat((0, import_path12.resolve)(config.outDir, chunk.fileName));
+      const stats = await import_fs_extra10.default.lstat((0, import_path11.resolve)(config.outDir, chunk.fileName));
       totalSize += stats.size;
       const size = String((0, import_filesize.filesize)(stats.size));
       return [
-        `${import_picocolors2.default.gray(prefix)} ${import_picocolors2.default.dim(file[0])}${color(file[1])}`,
-        import_picocolors2.default.dim(size)
+        `${import_picocolors.default.gray(prefix)} ${import_picocolors.default.dim(file[0])}${color(file[1])}`,
+        import_picocolors.default.dim(size)
       ];
     })
   );
   printTable(config.logger.log, chunkRows);
   config.logger.log(
-    `${import_picocolors2.default.cyan("\u03A3 Total size:")} ${String((0, import_filesize.filesize)(totalSize))}`
+    `${import_picocolors.default.cyan("\u03A3 Total size:")} ${String((0, import_filesize.filesize)(totalSize))}`
   );
 }
 var DEFAULT_SORT_WEIGHT = 100;
@@ -1563,12 +1583,12 @@ function getChunkSortWeight(filename) {
     ([key]) => filename.endsWith(key)
   )?.[1] ?? DEFAULT_SORT_WEIGHT;
 }
-var DEFAULT_COLOR = import_picocolors2.default.blue;
+var DEFAULT_COLOR = import_picocolors.default.blue;
 var CHUNK_COLORS = {
-  ".js.map": import_picocolors2.default.gray,
-  ".html": import_picocolors2.default.green,
-  ".css": import_picocolors2.default.magenta,
-  ".js": import_picocolors2.default.cyan
+  ".js.map": import_picocolors.default.gray,
+  ".html": import_picocolors.default.green,
+  ".css": import_picocolors.default.magenta,
+  ".js": import_picocolors.default.cyan
 };
 function getChunkColor(filename) {
   return Object.entries(CHUNK_COLORS).find(([key]) => filename.endsWith(key))?.[1] ?? DEFAULT_COLOR;
@@ -1579,7 +1599,7 @@ async function buildInternal(config) {
   const verb = config.command === "serve" ? "Pre-rendering" : "Building";
   const target = `${config.browser}-mv${config.manifestVersion}`;
   config.logger.info(
-    `${verb} ${import_picocolors3.default.cyan(target)} for ${import_picocolors3.default.cyan(config.mode)} with ${import_picocolors3.default.green(
+    `${verb} ${import_picocolors2.default.cyan(target)} for ${import_picocolors2.default.cyan(config.mode)} with ${import_picocolors2.default.green(
       `Vite ${vite3.version}`
     )}`
   );
@@ -1781,9 +1801,9 @@ function reloadContentScripts(steps, config, server) {
       const js = [getEntrypointBundlePath(entry, config.outDir, ".js")];
       const css = getContentScriptCssFiles([entry], server.currentOutput);
       server.reloadContentScript({
+        ...entry.options,
         js,
-        css,
-        ...entry.options
+        css
       });
     });
   } else {
@@ -1798,7 +1818,7 @@ function reloadHtmlPages(groups, server, config) {
 }
 
 // package.json
-var version2 = "0.2.0";
+var version2 = "0.2.2";
 
 // src/core/utils/defineConfig.ts
 function defineConfig(config) {
@@ -1842,13 +1862,13 @@ 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) => import_picocolors4.default.dim((0, import_node_path4.relative)(internalConfig.root, file))).join(", ")}`
+        `Changed: ${Array.from(new Set(fileChanges.map((change) => change[1]))).map((file) => import_picocolors3.default.dim((0, import_node_path4.relative)(internalConfig.root, file))).join(", ")}`
       );
       const rebuiltNames = changes.rebuildGroups.flat().map((entry) => {
-        return import_picocolors4.default.cyan(
+        return import_picocolors3.default.cyan(
           (0, import_node_path4.relative)(internalConfig.outDir, getEntrypointOutputFile(entry, ""))
         );
-      }).join(import_picocolors4.default.dim(", "));
+      }).join(import_picocolors3.default.dim(", "));
       internalConfig = await getLatestInternalConfig();
       internalConfig.server = server;
       const { output: newOutput } = await rebuild(