wxt 0.8.2 → 0.8.3

package/dist/testing.d.cts

@@ -0,0 +1,292 @@
+export { FakeBrowser, fakeBrowser } from '@webext-core/fake-browser';
+import * as vite from 'vite';
+import { Manifest } from 'webextension-polyfill';
+import { UnimportOptions } from 'unimport';
+import { LogLevel } from 'consola';
+import { PluginVisualizerOptions } from 'rollup-plugin-visualizer';
+
+interface InlineConfig {
+    /**
+     * Your project's root directory containing the `package.json` used to fill out the
+     * `manifest.json`.
+     *
+     * @default process.cwd()
+     */
+    root?: string;
+    /**
+     * Directory containing all source code. Set to `"src"` to move all source code to a `src/`
+     * directory.
+     *
+     * @default config.root
+     */
+    srcDir?: string;
+    /**
+     * Directory containing files that will be copied to the output directory as-is.
+     *
+     * @default "${config.root}/public"
+     */
+    publicDir?: string;
+    /**
+     * @default "${config.srcDir}/entrypoints"
+     */
+    entrypointsDir?: string;
+    /**
+     * > Only available when using the JS API. Not available in `wxt.config.ts` files
+     *
+     * Path to `wxt.config.ts` file or `false` to disable config file discovery.
+     *
+     * @default "wxt.config.ts"
+     */
+    configFile?: string | false;
+    /**
+     * Set to `true` to show debug logs. Overriden by the command line `--debug` option.
+     *
+     * @default false
+     */
+    debug?: boolean;
+    /**
+     * Explicitly set a mode to run in. This will override the default mode for each command, and can
+     * be overridden by the command line `--mode` option.
+     */
+    mode?: string;
+    /**
+     * Customize auto-import options. Set to `false` to disable auto-imports.
+     *
+     * For example, to add a directory to auto-import from, you can use:
+     *
+     * ```ts
+     * export default defineConfig({
+     *   imports: {
+     *     dirs: ["some-directory"]
+     *   }
+     * })
+     * ```
+     */
+    imports?: Partial<UnimportOptions> | false;
+    /**
+     * Explicitly set a browser to build for. This will override the default browser for each command,
+     * and can be overridden by the command line `--browser` option.
+     *
+     * @default
+     * "chrome"
+     */
+    browser?: TargetBrowser;
+    /**
+     * Explicitly set a manifest version to target. This will override the default manifest version
+     * for each command, and can be overridden by the command line `--mv2` or `--mv3` option.
+     */
+    manifestVersion?: TargetManifestVersion;
+    /**
+     * Override the logger used.
+     *
+     * @default
+     * consola
+     */
+    logger?: Logger;
+    /**
+     * Return custom Vite options from a function. See
+     * <https://vitejs.dev/config/shared-options.html>.
+     *
+     * [`root`](#root), [`configFile`](#configfile), and [`mode`](#mode) should be set in WXT's config
+     * instead of Vite's.
+     *
+     * This is a function because any vite plugins added need to be recreated for each individual
+     * build step, incase they have internal state causing them to fail when reused.
+     */
+    vite?: (env: ConfigEnv) => WxtViteConfig | Promise<WxtViteConfig>;
+    /**
+     * Customize the `manifest.json` output. Can be an object, promise, or function that returns an
+     * object or promise.
+     */
+    manifest?: UserManifest | Promise<UserManifest> | UserManifestFn;
+    /**
+     * 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 when generating the sources ZIP.
+         *
+         * @default config.root
+         */
+        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[];
+    };
+    /**
+     * Transform the final manifest before it's written to the file system. Edit the `manifest`
+     * parameter directly, do not return a new object. Return values are ignored.
+     *
+     * @example
+     * defineConfig({
+     *   // Add a CSS-only content script.
+     *   transformManifest(manifest) {
+     *     manifest.content_scripts.push({
+     *       matches: ["*://google.com/*"],
+     *       css: ["content-scripts/some-example.css"],
+     *     });
+     *   }
+     * })
+     */
+    transformManifest?: (manifest: Manifest.WebExtensionManifest) => void;
+    analysis?: {
+        /**
+         * Explicitly include bundle analysis when running `wxt build`. This can be overridden by the
+         * command line `--analysis` option.
+         *
+         * @default false
+         */
+        enabled?: boolean;
+        /**
+         * When running `wxt build --analyze` or setting `analysis.enabled` to true, customize how the
+         * bundle will be visualized. See
+         * [`rollup-plugin-visualizer`](https://github.com/btd/rollup-plugin-visualizer#how-to-use-generated-files)
+         * for more details.
+         *
+         * @default "treemap"
+         */
+        template?: PluginVisualizerOptions['template'];
+    };
+}
+type TargetBrowser = string;
+type TargetManifestVersion = 2 | 3;
+interface Logger {
+    debug(...args: any[]): void;
+    log(...args: any[]): void;
+    info(...args: any[]): void;
+    warn(...args: any[]): void;
+    error(...args: any[]): void;
+    fatal(...args: any[]): void;
+    success(...args: any[]): void;
+    level: LogLevel;
+}
+/**
+ * Manifest customization available in the `wxt.config.ts` file. You cannot configure entrypoints
+ * here, they are configured inline.
+ */
+type UserManifest = Partial<Omit<Manifest.WebExtensionManifest, 'action' | 'background' | 'browser_action' | 'chrome_url_overrides' | 'devtools_page' | 'manifest_version' | 'options_page' | 'options_ui' | 'sandbox' | 'page_action' | 'popup' | 'sidepanel' | 'sidebar_action'>>;
+type UserManifestFn = (env: ConfigEnv) => UserManifest | Promise<UserManifest>;
+interface ConfigEnv {
+    mode: string;
+    command: 'build' | 'serve';
+    /**
+     * Browser passed in from the CLI
+     */
+    browser: TargetBrowser;
+    /**
+     * Manifest version passed in from the CLI
+     */
+    manifestVersion: 2 | 3;
+}
+/**
+ * Configure how the browser starts up.
+ */
+interface ExtensionRunnerConfig {
+    /**
+     * Whether or not to open the browser with the extension installed in dev mode.
+     *
+     * @default false
+     */
+    disabled?: boolean;
+    /**
+     * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#browser-console
+     */
+    openConsole?: boolean;
+    /**
+     * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#devtools
+     */
+    openDevtools?: boolean;
+    /**
+     * List of browser names and the binary that should be used to open the browser.
+     *
+     * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#chromium-binary
+     * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#firefox
+     */
+    binaries?: Record<string, string>;
+    /**
+     * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#firefox-profile
+     */
+    firefoxProfile?: string;
+    /**
+     * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#chromium-profile
+     */
+    chromiumProfile?: string;
+    /**
+     * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#pref
+     */
+    firefoxPrefs?: Record<string, string>;
+    /**
+     * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#args
+     */
+    firefoxArgs?: string[];
+    /**
+     * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#args
+     */
+    chromiumArgs?: string[];
+    /**
+     * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#start-url
+     */
+    startUrls?: string[];
+}
+type WxtViteConfig = Omit<vite.UserConfig, 'root' | 'configFile' | 'mode'>;
+
+/**
+ * Vite plugin that configures Vitest with everything required to test a WXT extension, based on the `<root>/wxt.config.ts`
+ *
+ * ```ts
+ * // vitest.config.ts
+ * import { defineConfig } from 'vitest/config';
+ * import { AutoImport } from 'wxt/testing';
+ *
+ * export default defineConfig({
+ *   plugins: [AutoImport()],
+ * });
+ * ```
+ *
+ * @param inlineConfig Customize WXT's config for testing. Any config specified here overrides the config from your `wxt.config.ts` file.
+ */
+declare function WxtVitest(inlineConfig?: InlineConfig): vite.PluginOption;
+
+export { WxtVitest };

package/dist/testing.d.ts

@@ -0,0 +1,292 @@
+export { FakeBrowser, fakeBrowser } from '@webext-core/fake-browser';
+import * as vite from 'vite';
+import { Manifest } from 'webextension-polyfill';
+import { UnimportOptions } from 'unimport';
+import { LogLevel } from 'consola';
+import { PluginVisualizerOptions } from 'rollup-plugin-visualizer';
+
+interface InlineConfig {
+    /**
+     * Your project's root directory containing the `package.json` used to fill out the
+     * `manifest.json`.
+     *
+     * @default process.cwd()
+     */
+    root?: string;
+    /**
+     * Directory containing all source code. Set to `"src"` to move all source code to a `src/`
+     * directory.
+     *
+     * @default config.root
+     */
+    srcDir?: string;
+    /**
+     * Directory containing files that will be copied to the output directory as-is.
+     *
+     * @default "${config.root}/public"
+     */
+    publicDir?: string;
+    /**
+     * @default "${config.srcDir}/entrypoints"
+     */
+    entrypointsDir?: string;
+    /**
+     * > Only available when using the JS API. Not available in `wxt.config.ts` files
+     *
+     * Path to `wxt.config.ts` file or `false` to disable config file discovery.
+     *
+     * @default "wxt.config.ts"
+     */
+    configFile?: string | false;
+    /**
+     * Set to `true` to show debug logs. Overriden by the command line `--debug` option.
+     *
+     * @default false
+     */
+    debug?: boolean;
+    /**
+     * Explicitly set a mode to run in. This will override the default mode for each command, and can
+     * be overridden by the command line `--mode` option.
+     */
+    mode?: string;
+    /**
+     * Customize auto-import options. Set to `false` to disable auto-imports.
+     *
+     * For example, to add a directory to auto-import from, you can use:
+     *
+     * ```ts
+     * export default defineConfig({
+     *   imports: {
+     *     dirs: ["some-directory"]
+     *   }
+     * })
+     * ```
+     */
+    imports?: Partial<UnimportOptions> | false;
+    /**
+     * Explicitly set a browser to build for. This will override the default browser for each command,
+     * and can be overridden by the command line `--browser` option.
+     *
+     * @default
+     * "chrome"
+     */
+    browser?: TargetBrowser;
+    /**
+     * Explicitly set a manifest version to target. This will override the default manifest version
+     * for each command, and can be overridden by the command line `--mv2` or `--mv3` option.
+     */
+    manifestVersion?: TargetManifestVersion;
+    /**
+     * Override the logger used.
+     *
+     * @default
+     * consola
+     */
+    logger?: Logger;
+    /**
+     * Return custom Vite options from a function. See
+     * <https://vitejs.dev/config/shared-options.html>.
+     *
+     * [`root`](#root), [`configFile`](#configfile), and [`mode`](#mode) should be set in WXT's config
+     * instead of Vite's.
+     *
+     * This is a function because any vite plugins added need to be recreated for each individual
+     * build step, incase they have internal state causing them to fail when reused.
+     */
+    vite?: (env: ConfigEnv) => WxtViteConfig | Promise<WxtViteConfig>;
+    /**
+     * Customize the `manifest.json` output. Can be an object, promise, or function that returns an
+     * object or promise.
+     */
+    manifest?: UserManifest | Promise<UserManifest> | UserManifestFn;
+    /**
+     * 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 when generating the sources ZIP.
+         *
+         * @default config.root
+         */
+        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[];
+    };
+    /**
+     * Transform the final manifest before it's written to the file system. Edit the `manifest`
+     * parameter directly, do not return a new object. Return values are ignored.
+     *
+     * @example
+     * defineConfig({
+     *   // Add a CSS-only content script.
+     *   transformManifest(manifest) {
+     *     manifest.content_scripts.push({
+     *       matches: ["*://google.com/*"],
+     *       css: ["content-scripts/some-example.css"],
+     *     });
+     *   }
+     * })
+     */
+    transformManifest?: (manifest: Manifest.WebExtensionManifest) => void;
+    analysis?: {
+        /**
+         * Explicitly include bundle analysis when running `wxt build`. This can be overridden by the
+         * command line `--analysis` option.
+         *
+         * @default false
+         */
+        enabled?: boolean;
+        /**
+         * When running `wxt build --analyze` or setting `analysis.enabled` to true, customize how the
+         * bundle will be visualized. See
+         * [`rollup-plugin-visualizer`](https://github.com/btd/rollup-plugin-visualizer#how-to-use-generated-files)
+         * for more details.
+         *
+         * @default "treemap"
+         */
+        template?: PluginVisualizerOptions['template'];
+    };
+}
+type TargetBrowser = string;
+type TargetManifestVersion = 2 | 3;
+interface Logger {
+    debug(...args: any[]): void;
+    log(...args: any[]): void;
+    info(...args: any[]): void;
+    warn(...args: any[]): void;
+    error(...args: any[]): void;
+    fatal(...args: any[]): void;
+    success(...args: any[]): void;
+    level: LogLevel;
+}
+/**
+ * Manifest customization available in the `wxt.config.ts` file. You cannot configure entrypoints
+ * here, they are configured inline.
+ */
+type UserManifest = Partial<Omit<Manifest.WebExtensionManifest, 'action' | 'background' | 'browser_action' | 'chrome_url_overrides' | 'devtools_page' | 'manifest_version' | 'options_page' | 'options_ui' | 'sandbox' | 'page_action' | 'popup' | 'sidepanel' | 'sidebar_action'>>;
+type UserManifestFn = (env: ConfigEnv) => UserManifest | Promise<UserManifest>;
+interface ConfigEnv {
+    mode: string;
+    command: 'build' | 'serve';
+    /**
+     * Browser passed in from the CLI
+     */
+    browser: TargetBrowser;
+    /**
+     * Manifest version passed in from the CLI
+     */
+    manifestVersion: 2 | 3;
+}
+/**
+ * Configure how the browser starts up.
+ */
+interface ExtensionRunnerConfig {
+    /**
+     * Whether or not to open the browser with the extension installed in dev mode.
+     *
+     * @default false
+     */
+    disabled?: boolean;
+    /**
+     * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#browser-console
+     */
+    openConsole?: boolean;
+    /**
+     * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#devtools
+     */
+    openDevtools?: boolean;
+    /**
+     * List of browser names and the binary that should be used to open the browser.
+     *
+     * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#chromium-binary
+     * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#firefox
+     */
+    binaries?: Record<string, string>;
+    /**
+     * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#firefox-profile
+     */
+    firefoxProfile?: string;
+    /**
+     * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#chromium-profile
+     */
+    chromiumProfile?: string;
+    /**
+     * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#pref
+     */
+    firefoxPrefs?: Record<string, string>;
+    /**
+     * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#args
+     */
+    firefoxArgs?: string[];
+    /**
+     * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#args
+     */
+    chromiumArgs?: string[];
+    /**
+     * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#start-url
+     */
+    startUrls?: string[];
+}
+type WxtViteConfig = Omit<vite.UserConfig, 'root' | 'configFile' | 'mode'>;
+
+/**
+ * Vite plugin that configures Vitest with everything required to test a WXT extension, based on the `<root>/wxt.config.ts`
+ *
+ * ```ts
+ * // vitest.config.ts
+ * import { defineConfig } from 'vitest/config';
+ * import { AutoImport } from 'wxt/testing';
+ *
+ * export default defineConfig({
+ *   plugins: [AutoImport()],
+ * });
+ * ```
+ *
+ * @param inlineConfig Customize WXT's config for testing. Any config specified here overrides the config from your `wxt.config.ts` file.
+ */
+declare function WxtVitest(inlineConfig?: InlineConfig): vite.PluginOption;
+
+export { WxtVitest };