Merge remote-tracking branch 'upstream/main' into content-script-optional

Author: eupthere

bun.lock

@@ -78,6 +78,7 @@ words:
   - Noto
   - ntvs
   - nypm
+  - obug
   - ohash
   - oklab
   - oxlint

cspell.yml

@@ -200,6 +200,23 @@ export default defineConfig({
 });
 ```
 
+:::warning
+
+Different browsers support different permissions. You are responsible for passing only the permissions required for each browser:
+
+```ts
+export default defineConfig({
+  manifest: ({ browser }) => ({
+    permissions:
+      browser === 'chrome'
+        ? ['storage', 'favicon', 'declarativeNetRequest']
+        : ['storage', 'webRequest'],
+  }),
+});
+```
+
+:::
+
 ## Host Permissions
 
 > [Chrome docs](https://developer.chrome.com/docs/extensions/develop/concepts/declare-permissions#host-permissions)

docs/guide/essentials/config/manifest.md

@@ -137,6 +137,35 @@ console.log(config.myModule);
 
 This is very useful when [generating runtime code](#generate-runtime-module).
 
+#### Logging
+
+There are two "correct" ways to add console logs to your modules:
+
+1. Use `wxt.logger` for info, warnings, and errors
+2. Install [`obug`](https://www.npmjs.com/package/obug) for debug messages
+
+```ts
+import { defineWxtModule } from 'wxt/modules';
+import { createDebug } from 'obug';
+
+const debug = createDebug('my-module');
+
+export default defineWxtModule({
+  setup(wxt) {
+    wxt.logger.info('Module loaded');
+    debug('Debug details');
+  },
+});
+```
+
+`wxt.logger` is great for formatted, pretty messages that match the rest of WXT's logs.
+
+`obug` makes it easy for devs to enable and filter debug logs when necessary:
+
+```sh
+DEBUG=my-module wxt dev
+```
+
 #### Add custom entrypoint options
 
 Modules can add custom options to entrypoints by augmenting the entrypoint options types. This allows you to add custom configuration that can be accessed during the build process.

docs/guide/essentials/wxt-modules.md

@@ -35,14 +35,16 @@ describe('I18n Types', () => {
   });
 
   describe('With type-safety', () => {
-    const i18n = createI18n<{
+    type MyStructure = {
       simple: { plural: false; substitutions: 0 };
       simpleSub1: { plural: false; substitutions: 1 };
       simpleSub2: { plural: false; substitutions: 2 };
       plural: { plural: true; substitutions: 0 };
       pluralSub1: { plural: true; substitutions: 1 };
       pluralSub2: { plural: true; substitutions: 2 };
-    }>();
+    };
+
+    const i18n = createI18n<MyStructure>();
 
     describe('t', () => {
       it('should only allow passing valid combinations of arguments', () => {

packages/i18n/src/__tests__/types.test.ts

@@ -1,16 +1,11 @@
 /** @module @wxt-dev/i18n */
-import {
-  I18nStructure,
-  DefaultI18nStructure,
-  I18n,
-  Substitution,
-} from './types';
+import { I18nStructure, I18n, Substitution, UntypedI18n } from './types';
 import { browser } from '@wxt-dev/browser';
 
-export function createI18n<
-  T extends I18nStructure = DefaultI18nStructure,
->(): I18n<T> {
-  const t = (key: string, ...args: any[]) => {
+export function createI18n(): UntypedI18n;
+export function createI18n<T extends I18nStructure>(): I18n<T>;
+export function createI18n(): UntypedI18n {
+  const t: UntypedI18n['t'] = (key: string, ...args: unknown[]) => {
     // Resolve args
     let sub: Substitution[] | undefined;
     let count: number | undefined;
@@ -64,5 +59,5 @@ export function createI18n<
     }
   };
 
-  return { t } as I18n<T>;
+  return { t };
 }

packages/i18n/src/index.ts

@@ -3,14 +3,23 @@ export interface I18nFeatures {
   substitutions: SubstitutionCount;
 }
 
-export type I18nStructure = {
-  [K: string]: I18nFeatures;
-};
+export interface UntypedI18n {
+  t: UntypedTFunction;
+}
 
-export type DefaultI18nStructure = {
-  [K: string]: any;
+export type UntypedTFunction = {
+  (key: string): string;
+  (key: string, substitutions: Substitution[]): string;
+  (key: string, n: number): string;
+  (key: string, n: number, substitutions: Substitution[]): string;
 };
 
+export type I18nStructure = Record<string, I18nFeatures>;
+
+export interface I18n<T extends I18nStructure> {
+  t: TFunction<T>;
+}
+
 // prettier-ignore
 export type SubstitutionTuple<T extends SubstitutionCount> =
     T extends 1 ? [$1: Substitution]
@@ -66,10 +75,6 @@ export type TFunction<T extends I18nStructure> = {
   ): string;
 };
 
-export interface I18n<T extends DefaultI18nStructure> {
-  t: TFunction<T>;
-}
-
 export type Substitution = string | number;
 
 type SubstitutionCount = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;

packages/i18n/src/types.ts

@@ -46,5 +46,8 @@
   },
   "files": [
     "dist"
-  ]
+  ],
+  "dependencies": {
+    "obug": "^2.1.1"
+  }
 }

packages/runner/package.json

@@ -25,6 +25,7 @@ describe('Options', () => {
   describe('extensionDir', () => {
     it('should default to the current working directory', async () => {
       const actual = await resolveRunOptions({});
+
       expect(actual).toMatchObject<Partial<ResolvedRunOptions>>({
         extensionDir: process.cwd(),
       });
@@ -34,40 +35,50 @@ describe('Options', () => {
       const actual = await resolveRunOptions({
         extensionDir: './path/to/extension',
       });
+
       expect(actual).toMatchObject<Partial<ResolvedRunOptions>>({
         extensionDir: resolve(process.cwd(), './path/to/extension'),
       });
     });
+
+    it('should use absolute paths as-is', async () => {
+      const actual = await resolveRunOptions({
+        extensionDir: '/abs/path/to/extension2',
+      });
+
+      expect(actual).toMatchObject<Partial<ResolvedRunOptions>>({
+        extensionDir: resolve('/abs/path/to/extension2'),
+      });
+    });
   });
 
   describe('target', () => {
     it('should be "chrome" by default', async () => {
-      const actual = await resolveRunOptions({
-        extensionDir: 'path/to/extension',
-      });
+      const actual = await resolveRunOptions({});
+
       expect(actual).toMatchObject<Partial<ResolvedRunOptions>>({
         target: 'chrome',
       });
     });
 
     it('should be what is passed in', async () => {
       const actual = await resolveRunOptions({
-        extensionDir: 'path/to/extension',
         target: 'custom',
         browserBinaries: {
           custom: '/path/to/custom/browser',
         },
       });
+
       expect(actual).toMatchObject<Partial<ResolvedRunOptions>>({
         target: 'custom',
       });
     });
 
     it('should throw an error if the target binary could not be found', async () => {
       const actual = resolveRunOptions({
-        extensionDir: 'path/to/extension',
         target: 'custom',
       });
+
       await expect(actual).rejects.toThrow('Could not find "custom" binary.');
     });
   });
@@ -83,7 +94,6 @@ describe('Options', () => {
           ? 'C:\\path\\to\\custom\\browser.exe'
           : path;
       const actual = await resolveRunOptions({
-        extensionDir: 'path/to/extension',
         target: 'custom',
         browserBinaries: {
           custom: path,
@@ -98,9 +108,11 @@ describe('Options', () => {
   describe('chromiumArgs', () => {
     it('should log a warning when --user-data-dir is passed in', async () => {
       const warnSpy = vi.spyOn(console, 'warn');
+
       await resolveRunOptions({
         chromiumArgs: ['--user-data-dir=some/custom/path'],
       });
+
       expect(warnSpy).toBeCalledTimes(1);
       expect(warnSpy).toHaveBeenCalledWith(
         expect.stringContaining(
@@ -111,9 +123,11 @@ describe('Options', () => {
 
     it('should log a warning when --remote-debugging-port is passed in', async () => {
       const warnSpy = vi.spyOn(console, 'warn');
+
       await resolveRunOptions({
         chromiumArgs: ['--remote-debugging-port=9222'],
       });
+
       expect(warnSpy).toBeCalledTimes(1);
       expect(warnSpy).toHaveBeenCalledWith(
         expect.stringContaining(
@@ -126,6 +140,7 @@ describe('Options', () => {
       const actual = await resolveRunOptions({
         chromiumArgs: ['--window-size=1920,1080'],
       });
+
       expect(actual.chromiumArgs).toEqual([
         // Defaults
         '--disable-features=Translate,OptimizationHints,MediaRouter,DialMediaRouteProvider,CalculateNativeWinOcclusion,InterestFeedContentSuggestions,CertificateTransparencyComponentUpdater,AutofillServerCommunication,PrivacySandboxSettings4',
@@ -161,9 +176,11 @@ describe('Options', () => {
   describe('firefoxArgs', () => {
     it('should log a warning when --profile is passed in', async () => {
       const warnSpy = vi.spyOn(console, 'warn');
+
       await resolveRunOptions({
         firefoxArgs: ['--profile=some/custom/path'],
       });
+
       expect(warnSpy).toBeCalledTimes(1);
       expect(warnSpy).toHaveBeenCalledWith(
         expect.stringContaining('Custom Firefox --profile argument ignored'),
@@ -172,9 +189,11 @@ describe('Options', () => {
 
     it('should log a warning when --remote-debugging-port is passed in', async () => {
       const warnSpy = vi.spyOn(console, 'warn');
+
       await resolveRunOptions({
         firefoxArgs: ['--remote-debugging-port=9222'],
       });
+
       expect(warnSpy).toBeCalledTimes(1);
       expect(warnSpy).toHaveBeenCalledWith(
         expect.stringContaining(
@@ -187,6 +206,7 @@ describe('Options', () => {
       const actual = await resolveRunOptions({
         firefoxArgs: ['--window-size=1920,1080'],
       });
+
       expect(actual.firefoxArgs).toEqual([
         // Defaults
         '--new-instance',

packages/runner/src/__tests__/options.test.ts

@@ -1,7 +1,7 @@
 import { openWebSocket } from './web-socket';
-import { debug } from './debug';
+import { runnerDebug } from './debug';
 
-const debugBidi = debug.scoped('bidi');
+const debug = runnerDebug.extend('bidi');
 
 export interface BidiConnection extends Disposable {
   send<T>(method: string, params: any, timeout?: number): Promise<T>;
@@ -12,18 +12,18 @@ export async function createBidiConnection(
   baseUrl: string,
 ): Promise<BidiConnection> {
   const url = new URL('/session', baseUrl);
-  debugBidi('Connecting to BiDi server @', url.href);
+  debug('Connecting to BiDi server @', url.href);
 
   const webSocket = await openWebSocket(url.href);
-  debugBidi('Connected');
+  debug('Connected');
 
   let requestId = 0;
 
   return {
     send(method, params, timeout = 10e3) {
       const id = ++requestId;
       const command = { id, method, params };
-      debugBidi('Sending command:', command);
+      debug('Sending command:', command);
 
       return new Promise((resolve, reject) => {
         const cleanup = () => {
@@ -43,7 +43,7 @@ export async function createBidiConnection(
         const onMessage = (event: MessageEvent) => {
           const data = JSON.parse(event.data);
           if (data.id === id) {
-            debugBidi('Received response:', data);
+            debug('Received response:', data);
             cleanup();
             if (data.type === 'success') resolve(data.result);
             else reject(Error(data.message, { cause: data }));
@@ -62,14 +62,14 @@ export async function createBidiConnection(
     },
 
     close() {
-      debugBidi('Closing connection...');
+      debug('Closing connection...');
       webSocket.close();
-      debugBidi('Closed connection');
+      debug('Closed connection');
     },
     [Symbol.dispose]() {
-      debugBidi('Disposing connection...');
+      debug('Disposing connection...');
       webSocket.close();
-      debugBidi('Disposed connection');
+      debug('Disposed connection');
     },
   };
 }