-
Notifications
You must be signed in to change notification settings - Fork 93
@W-22185056: Add BUILD_VARIANT concept with single "default" variant #327
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.
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
Open
anyoung-tableau
wants to merge
3
commits into
anyoung/tools-web-folder
Choose a base branch
from
anyoung/build-variant
base: anyoung/tools-web-folder
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| import { BuildOptions } from 'esbuild'; | ||
|
|
||
| import { Variant } from './variants'; | ||
|
|
||
| export type GlobalIdentifierName = 'BUILD_VARIANT'; | ||
|
|
||
| type GlobalIdentifier = { | ||
| name: GlobalIdentifierName; | ||
| defaultValue: string; | ||
| action: (value: string) => BuildOptions | undefined; | ||
| }; | ||
|
|
||
| export const globalIdentifiers: ReadonlyArray<GlobalIdentifier> = [ | ||
| { | ||
| name: 'BUILD_VARIANT', | ||
| defaultValue: 'default' satisfies Variant, | ||
| action: (value: string): BuildOptions | undefined => { | ||
| if (value === 'default') { | ||
| return { | ||
| entryPoints: ['./src/index.ts'], | ||
| outfile: './build/index.js', | ||
| }; | ||
| } | ||
|
|
||
| // variant "foo" has an entry point of src/index.foo.ts and an outfile of build/index.foo.js | ||
| return { | ||
| entryPoints: [`./src/index.${value}.ts`], | ||
| outfile: `./build/index.${value}.js`, | ||
| }; | ||
| }, | ||
| }, | ||
| ] as const; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| export const variants = ['default'] as const; | ||
| export type Variant = (typeof variants)[number]; | ||
| export function isVariant(value: unknown): value is Variant { | ||
| return variants.some((variant) => variant === value); | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| interface ImportMeta { | ||
| readonly env: { | ||
| readonly BUILD_VARIANT: string; | ||
| }; | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Design Q: do we want
BUILD_VARIANTto be runtime-readable outside the variant entry points at all?The entry-point swap already gives us a clean build boundary, and exposing
import.meta.env.BUILD_VARIANTmore broadly seems like it could invite shared modules to grow variant conditionals over timeKeep variant selection constrained to the entry/build layer unless a concrete use case shows up?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good callout. I tried to get stuff working without using
defineat all, but it got kinda messy. Let me give it another shot.