wxt 0.4.1 → 0.5.1

package/dist/index.d.cts

@@ -31,7 +31,7 @@ interface InlineConfig {
     /**
      * > 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.
+     * Path to `wxt.config.ts` file or `false` to disable config file discovery.
      *
      * @default "wxt.config.ts"
      */
@@ -56,9 +56,19 @@ interface InlineConfig {
      */
     mode?: string;
     /**
-     * Customize auto-import options.
+     * 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>;
+    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.
@@ -80,7 +90,9 @@ interface InlineConfig {
      */
     logger?: Logger;
     /**
-     * Custom Vite options.
+     * Custom Vite options, see <https://vitejs.dev/config/shared-options.html>.
+     *
+     * [`root`](#root), [`configFile`](#configfile), and [`mode`](#mode) should be set in WXT's config.
      */
     vite?: Omit<vite.UserConfig, 'root' | 'configFile' | 'mode'>;
     /**
@@ -88,10 +100,6 @@ interface InlineConfig {
      * object or promise.
      */
     manifest?: UserManifest | Promise<UserManifest> | UserManifestFn;
-    /**
-     * Custom server options.
-     */
-    server?: WxtDevServer;
     /**
      * Custom runner options. Options set here can be overridden in a `web-ext.config.ts` file.
      */
@@ -205,7 +213,7 @@ interface WxtDevServer extends vite.ViteDevServer {
      */
     reloadContentScript: (contentScript: Omit<Scripting.RegisteredContentScript, 'id'>) => void;
 }
-type TargetBrowser = 'chrome' | 'firefox' | 'safari' | 'edge' | 'opera';
+type TargetBrowser = string;
 type TargetManifestVersion = 2 | 3;
 type UserConfig = Omit<InlineConfig, 'configFile'>;
 interface Logger {
@@ -218,6 +226,10 @@ interface Logger {
     success(...args: any[]): void;
     level: LogLevel;
 }
+interface BaseEntrypointOptions {
+    include?: TargetBrowser[];
+    exclude?: TargetBrowser[];
+}
 interface BaseEntrypoint {
     /**
      * The entrypoint's name. This is the filename or dirname without the type suffix.
@@ -245,6 +257,7 @@ interface BaseEntrypoint {
      * subdirectory of it.
      */
     outputDir: string;
+    options: BaseEntrypointOptions;
 }
 interface GenericEntrypoint extends BaseEntrypoint {
     type: 'sandbox' | 'bookmarks' | 'history' | 'newtab' | 'sidepanel' | 'devtools' | 'unlisted-page' | 'unlisted-script' | 'unlisted-style' | 'content-script-style';
@@ -254,11 +267,11 @@ interface BackgroundEntrypoint extends BaseEntrypoint {
     options: {
         persistent?: boolean;
         type?: 'module';
-    };
+    } & BaseEntrypointOptions;
 }
 interface ContentScriptEntrypoint extends BaseEntrypoint {
     type: 'content-script';
-    options: Omit<ContentScriptDefinition, 'main'>;
+    options: Omit<ContentScriptDefinition, 'main'> & BaseEntrypointOptions;
 }
 interface PopupEntrypoint extends BaseEntrypoint {
     type: 'popup';
@@ -269,7 +282,7 @@ interface PopupEntrypoint extends BaseEntrypoint {
         mv2Key?: 'browser_action' | 'page_action';
         defaultIcon?: Record<string, string>;
         defaultTitle?: string;
-    };
+    } & BaseEntrypointOptions;
 }
 interface OptionsEntrypoint extends BaseEntrypoint {
     type: 'options';
@@ -277,11 +290,11 @@ interface OptionsEntrypoint extends BaseEntrypoint {
         openInTab?: boolean;
         browserStyle?: boolean;
         chromeStyle?: boolean;
-    };
+    } & BaseEntrypointOptions;
 }
 type Entrypoint = GenericEntrypoint | BackgroundEntrypoint | ContentScriptEntrypoint | PopupEntrypoint | OptionsEntrypoint;
 type OnContentScriptStopped = (cb: () => void) => void;
-interface ContentScriptDefinition {
+interface ContentScriptDefinition extends ExcludableEntrypoint {
     matches: Manifest.ContentScript['matches'];
     /**
      * See https://developer.chrome.com/docs/extensions/mv3/content_scripts/
@@ -328,10 +341,26 @@ interface ContentScriptDefinition {
      */
     main(): void | Promise<void>;
 }
-interface BackgroundScriptDefintition {
+interface BackgroundScriptDefintition extends ExcludableEntrypoint {
     type?: 'module';
     main(): void;
 }
+interface ExcludableEntrypoint {
+    /**
+     * List of target browsers to include this entrypoint in. Defaults to being included in all
+     * builds. Cannot be used with `exclude`. You must choose one of the two options.
+     *
+     * @default undefined
+     */
+    include?: TargetBrowser[];
+    /**
+     * List of target browsers to exclude this entrypoint from. Cannot be used with `include`. You
+     * must choose one of the two options.
+     *
+     * @default undefined
+     */
+    exclude?: TargetBrowser[];
+}
 /**
  * Manifest customization available in the `wxt.config.ts` file. You cannot configure entrypoints
  * here, they are configured inline.
@@ -364,25 +393,11 @@ interface ExtensionRunnerConfig {
     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?: {
-        /**
-         * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#chromium-binary
-         */
-        chrome?: string;
-        /**
-         * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#chromium-binary
-         */
-        edge?: string;
-        /**
-         * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#chromium-binary
-         */
-        opera?: string;
-        /**
-         * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#firefox
-         */
-        firefox?: 'firefox' | 'beta' | 'nightly' | 'deved' | 'firefoxdeveloperedition' | string;
-    };
+    binaries?: Record<string, string>;
     /**
      * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#firefox-profile
      */
@@ -418,7 +433,7 @@ type EntrypointGroup = Entrypoint | Entrypoint[];
  */
 declare function clean(root?: string): Promise<void>;
 
-var version = "0.4.1";
+var version = "0.5.1";
 
 declare function defineConfig(config: UserConfig): UserConfig;
 
@@ -434,4 +449,4 @@ declare function build(config: InlineConfig): Promise<BuildOutput>;
  */
 declare function createServer(config?: InlineConfig): Promise<WxtDevServer>;
 
-export { BackgroundEntrypoint, BackgroundScriptDefintition, BaseEntrypoint, BuildOutput, BuildStepOutput, ConfigEnv, ContentScriptDefinition, ContentScriptEntrypoint, Entrypoint, ExtensionRunnerConfig, GenericEntrypoint, InlineConfig, Logger, OnContentScriptStopped, OptionsEntrypoint, PopupEntrypoint, TargetBrowser, TargetManifestVersion, UserConfig, UserManifest, UserManifestFn, WxtDevServer, WxtInlineViteConfig, build, clean, createServer, defineConfig, defineRunnerConfig, version };
+export { BackgroundEntrypoint, BackgroundScriptDefintition, BaseEntrypoint, BaseEntrypointOptions, BuildOutput, BuildStepOutput, ConfigEnv, ContentScriptDefinition, ContentScriptEntrypoint, Entrypoint, ExcludableEntrypoint, ExtensionRunnerConfig, GenericEntrypoint, InlineConfig, Logger, OnContentScriptStopped, OptionsEntrypoint, PopupEntrypoint, TargetBrowser, TargetManifestVersion, UserConfig, UserManifest, UserManifestFn, WxtDevServer, WxtInlineViteConfig, build, clean, createServer, defineConfig, defineRunnerConfig, version };

package/dist/index.d.ts

@@ -31,7 +31,7 @@ interface InlineConfig {
     /**
      * > 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.
+     * Path to `wxt.config.ts` file or `false` to disable config file discovery.
      *
      * @default "wxt.config.ts"
      */
@@ -56,9 +56,19 @@ interface InlineConfig {
      */
     mode?: string;
     /**
-     * Customize auto-import options.
+     * 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>;
+    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.
@@ -80,7 +90,9 @@ interface InlineConfig {
      */
     logger?: Logger;
     /**
-     * Custom Vite options.
+     * Custom Vite options, see <https://vitejs.dev/config/shared-options.html>.
+     *
+     * [`root`](#root), [`configFile`](#configfile), and [`mode`](#mode) should be set in WXT's config.
      */
     vite?: Omit<vite.UserConfig, 'root' | 'configFile' | 'mode'>;
     /**
@@ -88,10 +100,6 @@ interface InlineConfig {
      * object or promise.
      */
     manifest?: UserManifest | Promise<UserManifest> | UserManifestFn;
-    /**
-     * Custom server options.
-     */
-    server?: WxtDevServer;
     /**
      * Custom runner options. Options set here can be overridden in a `web-ext.config.ts` file.
      */
@@ -205,7 +213,7 @@ interface WxtDevServer extends vite.ViteDevServer {
      */
     reloadContentScript: (contentScript: Omit<Scripting.RegisteredContentScript, 'id'>) => void;
 }
-type TargetBrowser = 'chrome' | 'firefox' | 'safari' | 'edge' | 'opera';
+type TargetBrowser = string;
 type TargetManifestVersion = 2 | 3;
 type UserConfig = Omit<InlineConfig, 'configFile'>;
 interface Logger {
@@ -218,6 +226,10 @@ interface Logger {
     success(...args: any[]): void;
     level: LogLevel;
 }
+interface BaseEntrypointOptions {
+    include?: TargetBrowser[];
+    exclude?: TargetBrowser[];
+}
 interface BaseEntrypoint {
     /**
      * The entrypoint's name. This is the filename or dirname without the type suffix.
@@ -245,6 +257,7 @@ interface BaseEntrypoint {
      * subdirectory of it.
      */
     outputDir: string;
+    options: BaseEntrypointOptions;
 }
 interface GenericEntrypoint extends BaseEntrypoint {
     type: 'sandbox' | 'bookmarks' | 'history' | 'newtab' | 'sidepanel' | 'devtools' | 'unlisted-page' | 'unlisted-script' | 'unlisted-style' | 'content-script-style';
@@ -254,11 +267,11 @@ interface BackgroundEntrypoint extends BaseEntrypoint {
     options: {
         persistent?: boolean;
         type?: 'module';
-    };
+    } & BaseEntrypointOptions;
 }
 interface ContentScriptEntrypoint extends BaseEntrypoint {
     type: 'content-script';
-    options: Omit<ContentScriptDefinition, 'main'>;
+    options: Omit<ContentScriptDefinition, 'main'> & BaseEntrypointOptions;
 }
 interface PopupEntrypoint extends BaseEntrypoint {
     type: 'popup';
@@ -269,7 +282,7 @@ interface PopupEntrypoint extends BaseEntrypoint {
         mv2Key?: 'browser_action' | 'page_action';
         defaultIcon?: Record<string, string>;
         defaultTitle?: string;
-    };
+    } & BaseEntrypointOptions;
 }
 interface OptionsEntrypoint extends BaseEntrypoint {
     type: 'options';
@@ -277,11 +290,11 @@ interface OptionsEntrypoint extends BaseEntrypoint {
         openInTab?: boolean;
         browserStyle?: boolean;
         chromeStyle?: boolean;
-    };
+    } & BaseEntrypointOptions;
 }
 type Entrypoint = GenericEntrypoint | BackgroundEntrypoint | ContentScriptEntrypoint | PopupEntrypoint | OptionsEntrypoint;
 type OnContentScriptStopped = (cb: () => void) => void;
-interface ContentScriptDefinition {
+interface ContentScriptDefinition extends ExcludableEntrypoint {
     matches: Manifest.ContentScript['matches'];
     /**
      * See https://developer.chrome.com/docs/extensions/mv3/content_scripts/
@@ -328,10 +341,26 @@ interface ContentScriptDefinition {
      */
     main(): void | Promise<void>;
 }
-interface BackgroundScriptDefintition {
+interface BackgroundScriptDefintition extends ExcludableEntrypoint {
     type?: 'module';
     main(): void;
 }
+interface ExcludableEntrypoint {
+    /**
+     * List of target browsers to include this entrypoint in. Defaults to being included in all
+     * builds. Cannot be used with `exclude`. You must choose one of the two options.
+     *
+     * @default undefined
+     */
+    include?: TargetBrowser[];
+    /**
+     * List of target browsers to exclude this entrypoint from. Cannot be used with `include`. You
+     * must choose one of the two options.
+     *
+     * @default undefined
+     */
+    exclude?: TargetBrowser[];
+}
 /**
  * Manifest customization available in the `wxt.config.ts` file. You cannot configure entrypoints
  * here, they are configured inline.
@@ -364,25 +393,11 @@ interface ExtensionRunnerConfig {
     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?: {
-        /**
-         * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#chromium-binary
-         */
-        chrome?: string;
-        /**
-         * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#chromium-binary
-         */
-        edge?: string;
-        /**
-         * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#chromium-binary
-         */
-        opera?: string;
-        /**
-         * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#firefox
-         */
-        firefox?: 'firefox' | 'beta' | 'nightly' | 'deved' | 'firefoxdeveloperedition' | string;
-    };
+    binaries?: Record<string, string>;
     /**
      * @see https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#firefox-profile
      */
@@ -418,7 +433,7 @@ type EntrypointGroup = Entrypoint | Entrypoint[];
  */
 declare function clean(root?: string): Promise<void>;
 
-var version = "0.4.1";
+var version = "0.5.1";
 
 declare function defineConfig(config: UserConfig): UserConfig;
 
@@ -434,4 +449,4 @@ declare function build(config: InlineConfig): Promise<BuildOutput>;
  */
 declare function createServer(config?: InlineConfig): Promise<WxtDevServer>;
 
-export { BackgroundEntrypoint, BackgroundScriptDefintition, BaseEntrypoint, BuildOutput, BuildStepOutput, ConfigEnv, ContentScriptDefinition, ContentScriptEntrypoint, Entrypoint, ExtensionRunnerConfig, GenericEntrypoint, InlineConfig, Logger, OnContentScriptStopped, OptionsEntrypoint, PopupEntrypoint, TargetBrowser, TargetManifestVersion, UserConfig, UserManifest, UserManifestFn, WxtDevServer, WxtInlineViteConfig, build, clean, createServer, defineConfig, defineRunnerConfig, version };
+export { BackgroundEntrypoint, BackgroundScriptDefintition, BaseEntrypoint, BaseEntrypointOptions, BuildOutput, BuildStepOutput, ConfigEnv, ContentScriptDefinition, ContentScriptEntrypoint, Entrypoint, ExcludableEntrypoint, ExtensionRunnerConfig, GenericEntrypoint, InlineConfig, Logger, OnContentScriptStopped, OptionsEntrypoint, PopupEntrypoint, TargetBrowser, TargetManifestVersion, UserConfig, UserManifest, UserManifestFn, WxtDevServer, WxtInlineViteConfig, build, clean, createServer, defineConfig, defineRunnerConfig, version };