chore(release): v0.12.2

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## v0.12.2
+
+[compare changes](https://github.com/wxt-dev/wxt/compare/v0.12.1...v0.12.2)
+
+### 🚀 Enhancements
+
+- Support PNPM without hoisting dependencies ([#291](https://github.com/wxt-dev/wxt/pull/291))
+
 ## v0.12.1
 
 [compare changes](https://github.com/wxt-dev/wxt/compare/v0.12.0...v0.12.1)

e2e/tests/auto-imports.test.ts

@@ -17,6 +17,8 @@ describe('Auto Imports', () => {
           export {}
           declare global {
             const ContentScriptContext: typeof import('wxt/client')['ContentScriptContext']
+            const InvalidMatchPattern: typeof import('wxt/sandbox')['InvalidMatchPattern']
+            const MatchPattern: typeof import('wxt/sandbox')['MatchPattern']
             const browser: typeof import('wxt/browser')['browser']
             const builtinDrivers: typeof import('wxt/storage')['builtinDrivers']
             const createContentScriptIframe: typeof import('wxt/client')['createContentScriptIframe']

package.json

@@ -1,7 +1,7 @@
 {
   "name": "wxt",
   "type": "module",
-  "version": "0.12.2-alpha1",
+  "version": "0.12.2",
   "description": "Next gen framework for developing web extensions",
   "engines": {
     "node": ">=18",
@@ -86,7 +86,9 @@
     "lint": "run-p -c -s lint:*",
     "lint:eslint": "echo 'ESLint: TODO'",
     "lint:package": "publint",
-    "compile": "tsc --noEmit",
+    "compile": "run-s -c compile:*",
+    "compile:wxt": "tsc --noEmit",
+    "compile:virtual": "tsc --noEmit -p src/virtual",
     "test": "vitest",
     "test:coverage": "vitest run --coverage",
     "prepare": "simple-git-hooks",

scripts/build.ts

@@ -16,7 +16,7 @@ const startTime = Date.now();
 const outDir = 'dist';
 await fs.rm(path.join(outDir, '*'), { recursive: true, force: true });
 
-const preset: tsup.Options = {
+const preset = {
   dts: true,
   silent: true,
   sourcemap: false,
@@ -26,7 +26,7 @@ const preset: tsup.Options = {
     'virtual:user-content-script-main-world',
     'virtual:user-background',
   ],
-};
+} satisfies tsup.Options;
 
 function spinnerPMap(configs: tsup.Options[]) {
   let completed = 0;
@@ -88,6 +88,7 @@ const config: tsup.Options[] = [
     format: ['esm'],
     splitting: false,
     dts: false,
+    external: [...preset.external, 'wxt'],
   },
   // CJS-only
   {

src/client/content-scripts/content-script-context.ts

@@ -1,6 +1,6 @@
 import { ContentScriptDefinition } from '~/types';
 import { browser } from '~/browser';
-import { logger } from '~/client/utils/logger';
+import { logger } from '~/sandbox/utils/logger';
 import { WxtLocationChangeEvent, getUniqueEventName } from './custom-events';
 import { createLocationWatcher } from './location-watcher';
 

src/client/content-scripts/content-script-ui.ts

@@ -1,6 +1,6 @@
 import { createIsolatedElement } from '@webext-core/isolated-element';
 import { browser } from '~/browser';
-import { logger } from '~/client/utils/logger';
+import { logger } from '~/sandbox/utils/logger';
 import { ContentScriptContext } from './content-script-context';
 import {
   ContentScriptAnchoredOptions,

src/core/initialize.ts

@@ -150,14 +150,6 @@ async function cloneProject({
         consola.warn('Failed to move _gitignore to .gitignore:', err),
       );
 
-    // 3. Add .npmrc for pnpm
-    if (packageManager === 'pnpm') {
-      await fs.writeFile(
-        path.join(directory, '.npmrc'),
-        'shamefully-hoist=true\n',
-      );
-    }
-
     spinner.succeed();
   } catch (err) {
     spinner.fail();

src/sandbox/index.ts

@@ -6,4 +6,4 @@
 export * from './define-unlisted-script';
 export * from './define-background';
 export * from './define-content-script';
-export * from './match-patterns';
+export * from '@webext-core/match-patterns';

src/sandbox/match-patterns.ts

@@ -1 +0,0 @@
-export * from '@webext-core/match-patterns';

src/sandbox/utils/logger.ts

@@ -1,3 +1,5 @@
+/// <reference types="vite/client" />
+
 function print(method: (...args: any[]) => void, ...args: any[]) {
   if (import.meta.env.MODE === 'production') return;
 

src/types/globals.d.ts

@@ -0,0 +1,7 @@
+// Globals defined by the vite-plugins/devServerGlobals.ts and utils/globals.ts
+declare const __COMMAND__: 'build' | 'serve';
+declare const __DEV_SERVER_PROTOCOL__: string;
+declare const __DEV_SERVER_HOSTNAME__: string;
+declare const __DEV_SERVER_PORT__: string;
+declare const __MANIFEST_VERSION__: 2 | 3;
+declare const __ENTRYPOINT__: string;

src/virtual/README.md

@@ -0,0 +1,11 @@
+# WXT Virtual Entrypoints
+
+This folder contains scripts that are either loaded as entrypoints to JS files or included in HTML files, just like a project using WXT might load their own scripts.
+
+While they are bundled and shipped inside WXT, Vite considers them apart of your project's source code, not WXT's. This means they cannot import 3rd party modules directly, otherwise `pnpm i --shamefully-hoist=false` and Yarn PnP will fail.
+
+For this reason, the virtual entrypoints get their own TS project to isolate them from the rest of the project. They can only import from `wxt/*` or utils that don't have any imports from node_modules, like the logger.
+
+When bundling WXT for publishing to NPM, all the `wxt/*` imports are marked as external and resolved when building your application. Other imports are added inline.
+
+See https://github.com/wxt-dev/wxt/issues/286#issuecomment-1858888390 for more details.

src/virtual/background-entrypoint.ts

@@ -1,9 +1,9 @@
 import definition from 'virtual:user-background';
-import { setupWebSocket } from '~/client/utils/setup-web-socket';
-import { logger } from '~/client/utils/logger';
-import { browser } from '~/browser';
-import { keepServiceWorkerAlive } from '~/client/utils/keep-service-worker-alive';
-import { reloadContentScript } from '~/client/utils/reload-content-scripts';
+import { setupWebSocket } from './utils/setup-web-socket';
+import { logger } from '../sandbox/utils/logger';
+import { browser } from 'wxt/browser';
+import { keepServiceWorkerAlive } from './utils/keep-service-worker-alive';
+import { reloadContentScript } from './utils/reload-content-scripts';
 
 if (__COMMAND__ === 'serve') {
   try {

src/virtual/content-script-isolated-world-entrypoint.ts

@@ -1,6 +1,6 @@
 import definition from 'virtual:user-content-script-isolated-world';
-import { logger } from '~/client/utils/logger';
-import { ContentScriptContext } from '~/client/content-scripts/content-script-context';
+import { logger } from '../sandbox/utils/logger';
+import { ContentScriptContext } from 'wxt/client';
 
 (async () => {
   try {

src/virtual/content-script-main-world-entrypoint.ts

@@ -1,5 +1,5 @@
 import definition from 'virtual:user-content-script-main-world';
-import { logger } from '~/client/utils/logger';
+import { logger } from '../sandbox/utils/logger';
 
 (async () => {
   try {

src/virtual/mock-browser.ts

@@ -1,3 +1,3 @@
-import { fakeBrowser as mockBrowser } from '~/testing';
+import { fakeBrowser as mockBrowser } from 'wxt/testing';
 
 export default mockBrowser;

src/virtual/reload-html.ts

@@ -1,7 +1,5 @@
-/// <reference types="vite/client" />
-
-import { logger } from '~/client/utils/logger';
-import { setupWebSocket } from '~/client/utils/setup-web-socket';
+import { logger } from '../sandbox/utils/logger';
+import { setupWebSocket } from './utils/setup-web-socket';
 
 if (__COMMAND__ === 'serve') {
   try {

src/virtual/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "types": ["vite/client", "../types/globals.d.ts"]
+  },
+  "include": ["./*"]
+}

src/virtual/unlisted-script-entrypoint.ts

@@ -1,5 +1,5 @@
 import definition from 'virtual:user-unlisted-script';
-import { logger } from '~/client/utils/logger';
+import { logger } from '../sandbox/utils/logger';
 
 (async () => {
   try {

src/virtual/utils/keep-service-worker-alive.ts

@@ -1,4 +1,4 @@
-import { browser } from '~/browser';
+import { browser } from 'wxt/browser';
 
 /**
  * https://developer.chrome.com/blog/longer-esw-lifetimes/

src/virtual/utils/reload-content-scripts.ts

@@ -1,8 +1,14 @@
-import { browser, Manifest } from '~/browser';
-import { logger } from './logger';
-import { MatchPattern } from '~/sandbox';
+import { browser } from 'wxt/browser';
+import { logger } from '../../sandbox/utils/logger';
+import { MatchPattern } from 'wxt/sandbox';
 
-export function reloadContentScript(contentScript: Manifest.ContentScript) {
+interface ContentScript {
+  matches: string[];
+  js?: string[];
+  css?: string[];
+}
+
+export function reloadContentScript(contentScript: ContentScript) {
   const manifest = browser.runtime.getManifest();
   if (manifest.manifest_version == 2) {
     void reloadContentScriptMv2(contentScript);
@@ -11,9 +17,7 @@ export function reloadContentScript(contentScript: Manifest.ContentScript) {
   }
 }
 
-export async function reloadContentScriptMv3(
-  contentScript: Manifest.ContentScript,
-) {
+export async function reloadContentScriptMv3(contentScript: ContentScript) {
   const id = `wxt:${contentScript.js![0]}`;
   logger.log('Reloading content script:', contentScript);
   const registered = await browser.scripting.getRegisteredContentScripts();
@@ -41,8 +45,6 @@ export async function reloadContentScriptMv3(
   await Promise.all(matchingTabs.map((tab) => browser.tabs.reload(tab.id)));
 }
 
-export async function reloadContentScriptMv2(
-  contentScript: Manifest.ContentScript,
-) {
+export async function reloadContentScriptMv2(contentScript: ContentScript) {
   throw Error('TODO: reloadContentScriptMv2');
 }

src/virtual/utils/setup-web-socket.ts

@@ -1,4 +1,4 @@
-import { logger } from './logger';
+import { logger } from '../../sandbox/utils/logger';
 
 interface WebSocketMessage {
   type: string;

src/virtual/virtual-module-globals.d.ts

@@ -1,34 +1,39 @@
 // Types required to make the virtual modules happy.
 
-declare module '*?raw' {
-  const content: any;
-  export default content;
-}
-
 declare module 'virtual:user-background' {
-  const definition: import('~/types').BackgroundDefinition;
+  const definition: { main: () => void };
   export default definition;
 }
 
 declare module 'virtual:user-content-script-isolated-world' {
-  const definition: import('~/types').ContentScriptIsolatedWorldDefinition;
+  const definition: {
+    main: (
+      ctx: import('wxt/client').ContentScriptContext,
+    ) => void | Promise<void>;
+  };
   export default definition;
 }
 
 declare module 'virtual:user-content-script-main-world' {
-  const definition: import('~/types').ContentScriptMainWorldDefinition;
+  const definition: { main: () => void | Promise<void> };
   export default definition;
 }
 
 declare module 'virtual:user-unlisted-script' {
-  const definition: import('~/types').UnlistedScriptDefinition;
+  const definition: { main: () => void | Promise<void> };
   export default definition;
 }
 
-// Globals defined by the vite-plugins/devServerGlobals.ts and utils/globals.ts
-declare const __COMMAND__: 'build' | 'serve';
-declare const __DEV_SERVER_PROTOCOL__: string;
-declare const __DEV_SERVER_HOSTNAME__: string;
-declare const __DEV_SERVER_PORT__: string;
-declare const __MANIFEST_VERSION__: 2 | 3;
-declare const __ENTRYPOINT__: string;
+declare module 'wxt/browser' {
+  export const browser: import('webextension-polyfill').Browser;
+}
+
+declare module 'wxt/client' {
+  export class ContentScriptContext {
+    constructor(name: string, options: any);
+  }
+}
+
+declare module 'wxt/testing' {
+  export const fakeBrowser: import('webextension-polyfill').Browser;
+}

tsconfig.json

@@ -5,5 +5,5 @@
       "~/*": ["./src/*"]
     }
   },
-  "exclude": ["dist", "demo", "e2e/dist", "templates"]
+  "exclude": ["dist", "demo", "e2e/dist", "templates", "src/virtual"]
 }

vitest.workspace.ts

@@ -20,6 +20,7 @@ const resolve = {
   alias: {
     '~': path.resolve('src'),
     'webextension-polyfill': path.resolve('src/virtual/mock-browser'),
+    'wxt/testing': path.resolve('src/testing'),
   },
 };