Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: use target from webExtConfig if browser option is undefined #232

Merged
merged 4 commits into from
Dec 31, 2024
Merged

fix: use target from webExtConfig if browser option is undefined #232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
284992d
fix(types): add `WebExtConfig` type, omit `reload` option, deprecate …
aleclarson Dec 30, 2024
be7b4f4
fix: use `target` from webExtConfig if `browser` option is undefined
aleclarson Dec 30, 2024
eb12cb1
Merge branch 'main' into fix/webextconfig-target
aleclarson Dec 30, 2024
1c20eb0
allow any `browser` string
aleclarson Dec 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions packages/vite-plugin-web-extension/src/extension-runner/web-ext-runner.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,12 @@ export function createWebExtRunner(

const initialConfig = await loadConfig({ pluginOptions, logger, paths });
const target =
pluginOptions.browser === null || pluginOptions.browser === "firefox"
? null
: "chromium";
pluginOptions.browser === "chrome"
? "chromium"
: pluginOptions.browser === null ||
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we should deprecate the browser: null setting. It's a bit cryptic 😅

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Huh, yeah, wonder what I was thinking lol. Let's leave it for now.

pluginOptions.browser === "firefox"
? "firefox-desktop"
: initialConfig.target ?? "chromium";

const sourceDir = paths.outDir;
const config = {
Expand Down
4 changes: 2 additions & 2 deletions packages/vite-plugin-web-extension/src/options.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ export interface UserOptions {
*
* @default "chrome"
*/
browser?: string;
browser?: 'chrome' | 'firefox' | (string & {}) | null;
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is a TypeScript trick that provides auto-completion for some values while still allowing any string

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting, didn't know this worked... I've only used branded types with a property inside the {}. I've always had to use a function overload to get this behavior before, very good to know!


/**
* Do not validate your manifest to make sure it can be loaded by browsers.
Expand Down Expand Up @@ -119,7 +119,7 @@ export interface ResolvedOptions {
additionalInputs: string[];
disableAutoLaunch: boolean;
watchFilePaths: string[];
browser?: string;
browser?: 'chrome' | 'firefox' | (string & {}) | null;
skipManifestValidation: boolean;
printSummary: boolean;
htmlViteConfig?: vite.InlineConfig;
Expand Down