chore(release): v0.6.4

GitHub actions windows fails every once in a while due to a timeout, this should reduce those errors

CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## v0.6.4
+
+[compare changes](https://github.com/wxt-dev/wxt/compare/v0.6.3...v0.6.4)
+
+### 🩹 Fixes
+
+- **content-scripts:** Don't throw an error when including `include` or `exclude` options on a content script ([455e7f3](https://github.com/wxt-dev/wxt/commit/455e7f3))
+- Use `execaCommand` instead of `node:child_process` ([#130](https://github.com/wxt-dev/wxt/pull/130))
+
+### 🏡 Chore
+
+- **templates:** Add `.wxt` directory to gitignore ([#129](https://github.com/wxt-dev/wxt/pull/129))
+- Increase E2E test timeout ([5482b2f](https://github.com/wxt-dev/wxt/commit/5482b2f))
+
+## v0.6.3
+
+[compare changes](https://github.com/wxt-dev/wxt/compare/v0.6.2...v0.6.3)
+
+### 🚀 Enhancements
+
+- **client:** Add `block` and `addEventListener` utils to `ContentScriptContext` ([#128](https://github.com/wxt-dev/wxt/pull/128))
+
 ## v0.6.2
 
 [compare changes](https://github.com/wxt-dev/wxt/compare/v0.6.1...v0.6.2)
@@ -14,10 +36,6 @@
 - Fix import typo ([4c43072](https://github.com/wxt-dev/wxt/commit/4c43072))
 - Update vite docs to use function ([e0929a6](https://github.com/wxt-dev/wxt/commit/e0929a6))
 
-### ❤️ Contributors
-
-- Aaron <aaronklinker1@gmail.com>
-
 ## v0.6.1
 
 [compare changes](https://github.com/wxt-dev/wxt/compare/v0.6.0...v0.6.1)
@@ -34,11 +52,6 @@
 
 - Load extension details from CWS ([8e0a189](https://github.com/wxt-dev/wxt/commit/8e0a189))
 
-### ❤️ Contributors
-
-- Aaron <aaronklinker1@gmail.com>
-- Aaron Klinker <aaronklinker1@gmail.com>
-
 ## v0.6.0
 
 [compare changes](https://github.com/wxt-dev/wxt/compare/v0.5.6...v0.6.0)
@@ -57,10 +70,6 @@
 
 - ⚠️  The `vite` config option must now be a function. If you were using an object before, change it from `vite: { ... }` to `vite: () => ({ ... })`. ([#121](https://github.com/wxt-dev/wxt/pull/121))
 
-### ❤️ Contributors
-
-- Aaron Klinker ([@aklinker1](https://github.com/aklinker1))
-
 ## v0.5.6
 
 [compare changes](https://github.com/wxt-dev/wxt/compare/v0.5.5...v0.5.6)
@@ -69,10 +78,6 @@
 
 - Add `ContentScriptContext` util for stopping invalidated content scripts ([#120](https://github.com/wxt-dev/wxt/pull/120))
 
-### ❤️ Contributors
-
-- Aaron Klinker ([@aklinker1](https://github.com/aklinker1))
-
 ## v0.5.5
 
 [compare changes](https://github.com/wxt-dev/wxt/compare/v0.5.4...v0.5.5)
@@ -81,10 +86,6 @@
 
 - Automatically replace vite's `process.env.NODE_ENV` output in lib mode with the mode ([92039b8](https://github.com/wxt-dev/wxt/commit/92039b8))
 
-### ❤️ Contributors
-
-- Aaron Klinker ([@aklinker1](https://github.com/aklinker1))
-
 ## v0.5.4
 
 [compare changes](https://github.com/wxt-dev/wxt/compare/v0.5.3...v0.5.4)
@@ -94,10 +95,6 @@
 - Recognize `background/index.ts` as an entrypoint ([419fab8](https://github.com/wxt-dev/wxt/commit/419fab8))
 - Don't warn about deep entrypoint subdirectories not being recognized ([87e8df9](https://github.com/wxt-dev/wxt/commit/87e8df9))
 
-### ❤️ Contributors
-
-- Aaron Klinker ([@aklinker1](https://github.com/aklinker1))
-
 ## v0.5.3
 
 [compare changes](https://github.com/wxt-dev/wxt/compare/v0.5.2...v0.5.3)
@@ -110,10 +107,6 @@
 
 - Refactor how config is resolved ([#118](https://github.com/wxt-dev/wxt/pull/118))
 
-### ❤️ Contributors
-
-- Aaron Klinker ([@aklinker1](https://github.com/aklinker1))
-
 ## v0.5.2
 
 [compare changes](https://github.com/wxt-dev/wxt/compare/v0.5.1...v0.5.2)
@@ -122,10 +115,6 @@
 
 - Import client utils when getting entrypoint config ([#117](https://github.com/wxt-dev/wxt/pull/117))
 
-### ❤️ Contributors
-
-- Aaron Klinker ([@aklinker1](https://github.com/aklinker1))
-
 ## v0.5.1
 
 [compare changes](https://github.com/wxt-dev/wxt/compare/v0.5.0...v0.5.1)
@@ -139,10 +128,6 @@
 
 - Allow any string for target browser ([b4de93d](https://github.com/wxt-dev/wxt/commit/b4de93d))
 
-### ❤️ Contributors
-
-- Aaron Klinker ([@aklinker1](https://github.com/aklinker1))
-
 ## v0.5.0
 
 [compare changes](https://github.com/wxt-dev/wxt/compare/v0.4.1...v0.5.0)
@@ -172,10 +157,6 @@
 
 - ⚠️  Change default `publicDir` to `<srcDir>/public` ([5f15f9c](https://github.com/wxt-dev/wxt/commit/5f15f9c))
 
-### ❤️ Contributors
-
-- Aaron Klinker ([@aklinker1](https://github.com/aklinker1))
-
 ## v0.4.1
 
 [compare changes](https://github.com/wxt-dev/wxt/compare/v0.4.0...v0.4.1)
@@ -188,10 +169,6 @@
 
 - **init:** Don't show `cd .` when initializing the current directory ([e086374](https://github.com/wxt-dev/wxt/commit/e086374))
 
-### ❤️ Contributors
-
-- Aaron Klinker ([@aklinker1](https://github.com/aklinker1))
-
 ## v0.4.0
 
 [compare changes](https://github.com/wxt-dev/wxt/compare/v0.3.2...v0.4.0)
@@ -241,10 +218,6 @@
 
 - ⚠️  Use relative path aliases inside `.wxt/tsconfig.json` ([#102](https://github.com/wxt-dev/wxt/pull/102))
 
-### ❤️ Contributors
-
-- Aaron Klinker ([@aklinker1](https://github.com/aklinker1))
-
 ## v0.3.2
 
 [compare changes](https://github.com/wxt-dev/wxt/compare/v0.3.1...v0.3.2)
@@ -274,10 +247,6 @@
 - List vite version when validating project templates ([ef140dc](https://github.com/wxt-dev/wxt/commit/ef140dc))
 - Validate templates using tarball to avoid version conflicts within the `wxt/node_modules` directory ([edfa075](https://github.com/wxt-dev/wxt/commit/edfa075))
 
-### ❤️  Contributors
-
-- Aaron Klinker ([@aklinker1](https://github.com/aklinker1))
-
 ## v0.3.1
 
 [compare changes](https://github.com/wxt-dev/wxt/compare/v0.3.0...v0.3.1)
@@ -309,9 +278,8 @@
 - Speed up demo validation ([3a9fd39](https://github.com/wxt-dev/wxt/commit/3a9fd39))
 - Fix flakey failure when validating templates ([25677ba](https://github.com/wxt-dev/wxt/commit/25677ba))
 
-### ❤️  Contributors
+### ❤️ Contributors
 
-- Aaron Klinker ([@aklinker1](https://github.com/aklinker1))
 - BeanWei ([@BeanWei](https://github.com/BeanWei))
 
 ## v0.3.0
@@ -345,10 +313,6 @@
 - ⚠️  Add type safety to `browser.runtime.getURL` ([58a84ec](https://github.com/wxt-dev/wxt/commit/58a84ec))
 - ⚠️  Change default `publicDir` to `<rootDir>/public` ([19c0948](https://github.com/wxt-dev/wxt/commit/19c0948))
 
-### ❤️  Contributors
-
-- Aaron Klinker ([@aklinker1](https://github.com/aklinker1))
-
 ## v0.2.5
 
 [compare changes](https://github.com/wxt-dev/wxt/compare/v0.2.4...v0.2.5)
@@ -371,10 +335,6 @@
 
 - Validate project templates ([9ac756f](https://github.com/wxt-dev/wxt/commit/9ac756f))
 
-### ❤️ Contributors
-
-- Aaron Klinker ([@aklinker1](https://github.com/aklinker1))
-
 ## v0.2.4
 
 [compare changes](https://github.com/wxt-dev/wxt/compare/v0.2.3...v0.2.4)
@@ -383,10 +343,6 @@
 
 - Add `wxt zip` command ([#47](https://github.com/wxt-dev/wxt/pull/47))
 
-### ❤️ Contributors
-
-- Aaron Klinker ([@aklinker1](https://github.com/aklinker1))
-
 ## v0.2.3
 
 [compare changes](https://github.com/wxt-dev/wxt/compare/v0.2.2...v0.2.3)
@@ -397,10 +353,6 @@
 - Read boolean maniest options from meta tags correctly ([495c5c8](https://github.com/wxt-dev/wxt/commit/495c5c8))
 - Some fields cannot be overridden from `config.manifest` ([#46](https://github.com/wxt-dev/wxt/pull/46))
 
-### ❤️ Contributors
-
-- Aaron Klinker ([@aklinker1](https://github.com/aklinker1))
-
 ## v0.2.2
 
 [compare changes](https://github.com/wxt-dev/wxt/compare/v0.2.1...v0.2.2)
@@ -409,10 +361,6 @@
 
 - Register content scripts correctly in dev mode ([2fb5a54](https://github.com/wxt-dev/wxt/commit/2fb5a54))
 
-### ❤️ Contributors
-
-- Aaron Klinker ([@aklinker1](https://github.com/aklinker1))
-
 ## v0.2.1
 
 [compare changes](https://github.com/wxt-dev/wxt/compare/v0.2.0...v0.2.1)
@@ -425,10 +373,6 @@
 
 - Remove HMR log ([90fa6bf](https://github.com/wxt-dev/wxt/commit/90fa6bf))
 
-### ❤️ Contributors
-
-- Aaron Klinker ([@aklinker1](https://github.com/aklinker1))
-
 ## v0.2.0
 
 [compare changes](https://github.com/wxt-dev/wxt/compare/v0.1.6...v0.2.0)
@@ -453,10 +397,6 @@
 
 - ⚠️ Rename `defineBackgroundScript` to `defineBackground` ([5b48ae9](https://github.com/wxt-dev/wxt/commit/5b48ae9))
 
-### ❤️ Contributors
-
-- Aaron Klinker ([@aklinker1](https://github.com/aklinker1))
-
 ## v0.1.6
 
 [compare changes](https://github.com/wxt-dev/wxt/compare/v0.1.5...v0.1.6)
@@ -471,10 +411,6 @@
 - React and Vue starter templates ([#33](https://github.com/wxt-dev/wxt/pull/33))
 - Svelte template ([#34](https://github.com/wxt-dev/wxt/pull/34))
 
-### ❤️ Contributors
-
-- Aaron Klinker ([@aklinker1](https://github.com/aklinker1))
-
 ## v0.1.5
 
 [compare changes](https://github.com/wxt-dev/wxt/compare/v0.1.4...v0.1.5)
@@ -483,10 +419,6 @@
 
 - Include `vite/client` types ([371be99](https://github.com/wxt-dev/wxt/commit/371be99))
 
-### ❤️ Contributors
-
-- Aaron Klinker ([@aklinker1](https://github.com/aklinker1))
-
 ## v0.1.4
 
 [compare changes](https://github.com/wxt-dev/wxt/compare/v0.1.3...v0.1.4)
@@ -504,10 +436,6 @@
 
 - Update prettier ignore ([68611ae](https://github.com/wxt-dev/wxt/commit/68611ae))
 
-### ❤️ Contributors
-
-- Aaron Klinker ([@aklinker1](https://github.com/aklinker1))
-
 ## v0.1.3
 
 [compare changes](https://github.com/wxt-dev/wxt/compare/v0.1.2...v0.1.3)
@@ -529,10 +457,6 @@
 
 - Upgrade to pnpm 8 ([0ce7c9d](https://github.com/wxt-dev/wxt/commit/0ce7c9d))
 
-### ❤️ Contributors
-
-- Aaron Klinker ([@aklinker1](https://github.com/aklinker1))
-
 ## v0.1.2
 
 [compare changes](https://github.com/wxt-dev/wxt/compare/v0.1.1...v0.1.2)
@@ -551,10 +475,6 @@
 
 - Change `config.vite` to `UserConfig` ([ef6001e](https://github.com/wxt-dev/wxt/commit/ef6001e))
 
-### ❤️ Contributors
-
-- Aaron Klinker ([@aklinker1](https://github.com/aklinker1))
-
 ## v0.1.1
 
 [compare changes](https://github.com/wxt-dev/wxt/compare/v0.1.0...v0.1.1)
@@ -564,10 +484,6 @@
 - Allow dashes in entrypoint names ([2e51e73](https://github.com/wxt-dev/wxt/commit/2e51e73))
 - Unable to read entrypoint options ([#28](https://github.com/wxt-dev/wxt/pull/28))
 
-### ❤️ Contributors
-
-- Aaron Klinker ([@aklinker1](https://github.com/aklinker1))
-
 ## v0.1.0
 
 Initial release of WXT. Full support for production builds and initial toolkit for development:
@@ -591,10 +507,6 @@ Initial release of WXT. Full support for production builds and initial toolkit f
 
 - Create github release ([b7c078f](https://github.com/wxt-dev/wxt/commit/b7c078f))
 
-### ❤️ Contributors
-
-- Aaron Klinker ([@aklinker1](https://github.com/aklinker1))
-
 ## v0.0.2
 
 [compare changes](https://github.com/wxt-dev/wxt/compare/v0.0.1...v0.0.2)
@@ -625,10 +537,6 @@ Initial release of WXT. Full support for production builds and initial toolkit f
 - Rename `templates` to `virtual-modules` ([#24](https://github.com/wxt-dev/wxt/pull/24))
 - Update cli screenshot ([54eb118](https://github.com/wxt-dev/wxt/commit/54eb118))
 
-### ❤️ Contributors
-
-- Aaron Klinker ([@aklinker1](https://github.com/aklinker1))
-
 ## v0.0.1
 
 [compare changes](https://github.com/wxt-dev/wxt/compare/v0.0.0...v0.0.1)
@@ -698,7 +606,3 @@ Initial release of WXT. Full support for production builds and initial toolkit f
 
 - Create validation workflow ([#12](https://github.com/wxt-dev/wxt/pull/12))
 - Create release workflow ([#13](https://github.com/wxt-dev/wxt/pull/13))
-
-### ❤️ Contributors
-
-- Aaron Klinker ([@aklinker1](https://github.com/aklinker1))

e2e/tests/init.test.ts

@@ -40,5 +40,5 @@ describe('Init command', () => {
         "wxt.config.ts",
       ]
     `);
-  }, 30e3);
+  });
 });

e2e/utils.ts

@@ -1,7 +1,7 @@
 import { dirname, join, relative, resolve } from 'path';
 import fs from 'fs-extra';
 import glob from 'fast-glob';
-import { execSync } from 'child_process';
+import { execaCommand } from 'execa';
 import { InlineConfig, UserConfig, build } from '../src';
 import { normalizePath } from '../src/core/utils/paths';
 
@@ -72,8 +72,8 @@ export class TestProject {
       await fs.ensureDir(fileDir);
       await fs.writeFile(filePath, content ?? '', 'utf-8');
     }
-    execSync('npm i --ignore-scripts', { cwd: this.root });
 
+    await execaCommand('npm i --ignore-scripts', { cwd: this.root });
     await build({ ...config, root: this.root });
   }
 

package.json

@@ -1,7 +1,7 @@
 {
   "name": "wxt",
   "type": "module",
-  "version": "0.6.2",
+  "version": "0.6.4",
   "description": "Next gen framework for developing web extensions",
   "engines": {
     "node": ">=18.16.0",
@@ -126,6 +126,11 @@
   "lint-staged": {
     "*": "prettier --write"
   },
+  "changelog": {
+    "excludeAuthors": [
+      "aaronklinker1@gmail.com"
+    ]
+  },
   "pnpm": {
     "peerDependencyRules": {
       "ignoreMissing": [

src/client/utils/ContentScriptContext.ts

@@ -54,6 +54,23 @@ export class ContentScriptContext extends AbortController {
     return () => this.signal.removeEventListener('abort', cb);
   }
 
+  /**
+   * Return a promise that never resolves. Useful if you have an async function that shouldn't run
+   * after the context is expired.
+   *
+   * @example
+   * const getValueFromStorage = async () => {
+   *   if (ctx.isInvalid) return ctx.block();
+   *
+   *   // ...
+   * }
+   */
+  block<T>(): Promise<T> {
+    return new Promise(() => {
+      // noop
+    });
+  }
+
   /**
    * Wrapper around `window.setInterval` that automatically clears the interval when invalidated.
    */
@@ -105,6 +122,29 @@ export class ContentScriptContext extends AbortController {
     return id;
   }
 
+  /**
+   * Call `target.addEventListener` and remove the event listener when the context is invalidated.
+   *
+   * @example
+   * ctx.addEventListener(window, "mousemove", () => {
+   *   // ...
+   * });
+   * ctx.addEventListener(document, "visibilitychange", () => {
+   *   // ...
+   * });
+   */
+  addEventListener(
+    target: any,
+    type: string,
+    handler: (event: Event) => void,
+    options?: AddEventListenerOptions,
+  ) {
+    target.addEventListener?.(type, handler, options);
+    this.onInvalidated(
+      () => target.removeEventListener?.(type, handler, options),
+    );
+  }
+
   /**
    * Abort the abort controller and execute all `onInvalidated` listeners.
    */

src/core/build.ts

@@ -11,7 +11,7 @@ import fs from 'fs-extra';
 import { groupEntrypoints } from './utils/groupEntrypoints';
 import { formatDuration } from './utils/formatDuration';
 import { printBuildSummary } from './log/printBuildSummary';
-import { execSync } from 'node:child_process';
+import { execaCommand } from 'execa';
 import glob from 'fast-glob';
 import { unnormalizePath } from './utils/paths';
 
@@ -135,7 +135,7 @@ async function combineAnalysisStats(config: InternalConfig): Promise<void> {
   });
   const absolutePaths = unixFiles.map(unnormalizePath);
 
-  execSync(
+  await execaCommand(
     `rollup-plugin-visualizer ${absolutePaths.join(' ')} --template ${
       config.analysis.template
     }`,

src/core/server.ts

@@ -101,8 +101,10 @@ export function reloadContentScripts(
       const js = [getEntrypointBundlePath(entry, config.outDir, '.js')];
       const css = getContentScriptCssFiles([entry], server.currentOutput);
 
+      const { include: _1, exclude: _2, ...options } = entry.options;
+
       server.reloadContentScript({
-        ...entry.options,
+        ...options,
         js,
         css,
       });

templates/react/_gitignore

@@ -10,6 +10,7 @@ lerna-debug.log*
 node_modules
 .output
 stats.html
+.wxt
 
 # Editor directories and files
 .vscode/*

templates/solid/_gitignore

@@ -10,6 +10,7 @@ lerna-debug.log*
 node_modules
 .output
 stats.html
+.wxt
 
 # Editor directories and files
 .vscode/*

templates/svelte/_gitignore

@@ -10,6 +10,7 @@ lerna-debug.log*
 node_modules
 .output
 stats.html
+.wxt
 
 # Editor directories and files
 .vscode/*

templates/vanilla/_gitignore

@@ -10,6 +10,7 @@ lerna-debug.log*
 node_modules
 .output
 stats.html
+.wxt
 
 # Editor directories and files
 .vscode/*

templates/vue/_gitignore

@@ -10,6 +10,7 @@ lerna-debug.log*
 node_modules
 .output
 stats.html
+.wxt
 
 # Editor directories and files
 .vscode/*

vitest.workspace.ts

@@ -33,7 +33,7 @@ export default defineWorkspace([
       name: 'e2e',
       dir: 'e2e',
       singleThread: true,
-      testTimeout: 60e3,
+      testTimeout: 120e3,
     },
     plugins: [testSeed()],
   },