Rename things

wxt-dev · Nov 16, 2024 · 960ef39 · 960ef39
1 parent 7c693e8
commit 960ef39
Show file tree

Hide file tree

Showing 7 changed files with 40 additions and 174 deletions.
diff --git a/docs/guide/essentials/config/browser-startup.md b/docs/guide/essentials/config/browser-startup.md
@@ -4,7 +4,7 @@ outline: deep
 
 # Browser Startup
 
-> See the [API Reference](/api/reference/wxt/interfaces/ExtensionRunnerConfig) for a full list of config.
+> See the [API Reference](/api/reference/wxt/interfaces/WebExtRunnerConfig) for a full list of config.
 
 During development WXT uses [`web-ext` by Mozilla](https://www.npmjs.com/package/web-ext) to automatically open a browser window with your extension installed.
 
@@ -15,9 +15,9 @@ You can configure browser startup in 3 places:
 1. `<rootDir>/web-ext.config.ts`: Ignored from version control, this file lets you configure your own options for a specific project without affecting other developers
 
    ```ts
-   import { defineRunnerConfig } from 'wxt';
+   import { defineWebExtConfig } from 'wxt';
 
-   export default defineRunnerConfig({
+   export default defineWebExtConfig({
      // ...
    });
    ```
@@ -32,7 +32,7 @@ You can configure browser startup in 3 places:
 To set or customize the browser opened during development:
 
 ```ts
-export default defineRunnerConfig({
+export default defineWebExtConfig({
   binaries: {
     chrome: '/path/to/chrome-beta', // Use Chrome Beta instead of regular Chrome
     firefox: 'firefoxdeveloperedition', // Use Firefox Developer Edition instead of regular Firefox
@@ -52,15 +52,15 @@ To persist data, set the `--user-data-dir` flag:
 :::code-group
 
 ```ts [Mac/Linux]
-export default defineRunnerConfig({
+export default defineWebExtConfig({
   chromiumArgs: ['--user-data-dir=./.wxt/chrome-data'],
 });
 ```
 
 ```ts [Windows]
 import { resolve } from 'node:path';
 
-export default defineRunnerConfig({
+export default defineWebExtConfig({
   // On Windows, the path must be absolute
   chromiumArgs: [`--user-data-dir="${resolve(".wxt/chrome-data")}"`
 });
@@ -79,7 +79,7 @@ You can use any directory you'd like for `--user-data-dir`, the examples above c
 If you prefer to load the extension into your browser manually, you can disable the auto-open behavior:
 
 ```ts
-export default defineRunnerConfig({
+export default defineWebExtConfig({
   disabled: true,
 });
 ```
diff --git a/packages/wxt/e2e/tests/hooks.test.ts b/packages/wxt/e2e/tests/hooks.test.ts
@@ -155,7 +155,7 @@ describe('Hooks', () => {
 
     const server = await project.startServer({
       hooks,
-      runner: {
+      webExtRunner: {
         disabled: true,
       },
     });

diff --git a/packages/wxt/src/builtin-modules/index.ts b/packages/wxt/src/builtin-modules/index.ts
diff --git a/packages/wxt/src/builtin-modules/unimport.ts b/packages/wxt/src/builtin-modules/unimport.ts
diff --git a/packages/wxt/src/core/define-runner-config.ts b/packages/wxt/src/core/define-runner-config.ts
@@ -1,7 +1,23 @@
-import { ExtensionRunnerConfig } from '../types';
+import consola from 'consola';
+import { WebExtRunnerConfig } from '../types';
 
+/**
+ * @deprecated Use `defineWebExtConfig` instead. Same function, different name.
+ */
 export function defineRunnerConfig(
-  config: ExtensionRunnerConfig,
-): ExtensionRunnerConfig {
+  config: WebExtRunnerConfig,
+): WebExtRunnerConfig {
+  consola.warn(
+    'defineRunnerConfig is deprecated, replace it with defineWebExtConfig',
+  );
+  return config;
+}
+
+/**
+ * Configure how [`web-ext`](https://github.com/mozilla/web-ext) starts the browser during development.
+ */
+export function defineWebExtConfig(
+  config: WebExtRunnerConfig,
+): WebExtRunnerConfig {
   return config;
 }
diff --git a/packages/wxt/src/core/resolve-config.ts b/packages/wxt/src/core/resolve-config.ts
@@ -6,7 +6,7 @@ import {
   ConfigEnv,
   UserManifestFn,
   UserManifest,
-  ExtensionRunnerConfig,
+  WebExtRunnerConfig,
   WxtResolvedUnimportOptions,
   Logger,
   WxtCommand,
@@ -115,13 +115,13 @@ export async function resolveConfig(
   const outDir = path.resolve(outBaseDir, outDirTemplate);
   const reloadCommand = mergedConfig.dev?.reloadCommand ?? 'Alt+R';
 
-  const runnerConfig = await loadConfig<ExtensionRunnerConfig>({
+  const runnerConfig = await loadConfig<WebExtRunnerConfig>({
     name: 'web-ext',
     cwd: root,
     globalRc: true,
     rcFile: '.webextrc',
-    overrides: inlineConfig.runner,
-    defaults: userConfig.runner,
+    overrides: inlineConfig.webExtRunner ?? inlineConfig.runner,
+    defaults: userConfig.webExtRunner ?? userConfig.runner,
   });
   // Make sure alias are absolute
   const alias = Object.fromEntries(

diff --git a/packages/wxt/src/types.ts b/packages/wxt/src/types.ts
@@ -125,9 +125,13 @@ export interface InlineConfig {
    */
   manifest?: UserManifest | Promise<UserManifest> | UserManifestFn;
   /**
-   * Custom runner options. Options set here can be overridden in a `web-ext.config.ts` file.
+   * Configure browser startup. Option set here can be overridden in a `web-ext.config.ts` file.
    */
-  runner?: ExtensionRunnerConfig;
+  webExtRunner?: WebExtRunnerConfig;
+  /**
+   * @deprecated Use `webExtRunner` instead.
+   */
+  runner?: WebExtRunnerConfig;
   zip?: {
     /**
      * Configure the filename output when zipping files.
@@ -908,9 +912,9 @@ export interface ConfigEnv {
 export type WxtCommand = 'build' | 'serve';
 
 /**
- * Configure how the browser starts up.
+ * Options for how [`web-ext`](https://github.com/mozilla/web-ext) starts the browser.
  */
-export interface ExtensionRunnerConfig {
+export interface WebExtRunnerConfig {
   /**
    * Whether or not to open the browser with the extension installed in dev mode.
    *
@@ -1272,7 +1276,7 @@ export interface ResolvedConfig {
   imports: false | WxtResolvedUnimportOptions;
   manifest: UserManifest;
   fsCache: FsCache;
-  runnerConfig: C12ResolvedConfig<ExtensionRunnerConfig>;
+  runnerConfig: C12ResolvedConfig<WebExtRunnerConfig>;
   zip: {
     name?: string;
     artifactTemplate: string;