Skip to content

feat!: add {{modeSuffix}} to zip templates and update defaults #1623

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+20 −9
Open

feat!: add {{modeSuffix}} to zip templates and update defaults #1623

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
870c99e
feat!: use `{{packageVersion}}` as default in zip file templates
Tensai75 Apr 27, 2025
2e29f9b
feat!: add `{{modeSuffix}}` to zip templates and use as default
Tensai75 Apr 27, 2025
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
12 changes: 7 additions & 5 deletions packages/wxt/e2e/tests/zip.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,21 +77,23 @@ describe('Zipping', () => {
it('should correctly apply template variables for zip file names based on provided config', async () => {
const project = new TestProject({
name: 'test',
version: '1.0.0',
version: '1.0.0-beta.1',
});
project.addFile(
'entrypoints/background.ts',
'export default defineBackground(() => {});',
);
const artifactZip = '.output/test-1.0.0-firefox-development.zip';
const sourcesZip = '.output/test-1.0.0-development-sources.zip';
const artifactZip = '.output/test-1.0.0-beta.1-firefox-dev.zip';
const sourcesZip = '.output/test-1.0.0-beta.1-sources-dev.zip';

await project.zip({
browser: 'firefox',
mode: 'development',
zip: {
artifactTemplate: '{{name}}-{{version}}-{{browser}}-{{mode}}.zip',
sourcesTemplate: '{{name}}-{{version}}-{{mode}}-sources.zip',
artifactTemplate:
'{{name}}-{{packageVersion}}-{{browser}}{{modeSuffix}}.zip',
sourcesTemplate:
'{{name}}-{{packageVersion}}-sources{{modeSuffix}}.zip',
},
});

Expand Down
5 changes: 3 additions & 2 deletions packages/wxt/src/core/resolve-config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -301,8 +301,9 @@ function resolveZipConfig(
const downloadedPackagesDir = path.resolve(root, '.wxt/local_modules');
return {
name: undefined,
sourcesTemplate: '{{name}}-{{version}}-sources.zip',
artifactTemplate: '{{name}}-{{version}}-{{browser}}.zip',
sourcesTemplate: '{{name}}-{{packageVersion}}-sources{{modeSuffix}}.zip',
artifactTemplate:
'{{name}}-{{packageVersion}}-{{browser}}{{modeSuffix}}.zip',
sourcesRoot: root,
includeSources: [],
compressionLevel: 9,
Expand Down
6 changes: 6 additions & 0 deletions packages/wxt/src/core/zip.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ export async function zip(config?: InlineConfig): Promise<string[]> {
const projectName =
wxt.config.zip.name ??
safeFilename(packageJson?.name || path.basename(process.cwd()));
const modeSuffixes: Record<string, string | undefined> = {
production: '',
development: '-dev',
};
const modeSuffix = modeSuffixes[wxt.config.mode] ?? `-${wxt.config.mode}`;
const applyTemplate = (template: string): string =>
template
.replaceAll('{{name}}', projectName)
Expand All @@ -39,6 +44,7 @@ export async function zip(config?: InlineConfig): Promise<string[]> {
output.manifest.version_name ?? output.manifest.version,
)
.replaceAll('{{packageVersion}}', packageJson?.version)
.replaceAll('{{modeSuffix}}', modeSuffix)
.replaceAll('{{mode}}', wxt.config.mode)
.replaceAll('{{manifestVersion}}', `mv${wxt.config.manifestVersion}`);

Expand Down
6 changes: 4 additions & 2 deletions packages/wxt/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,9 +150,10 @@ export interface InlineConfig {
* - <span v-pre>`{{packageVersion}}`</span> - The version from the package.json
* - <span v-pre>`{{browser}}`</span> - The target browser from the `--browser` CLI flag
* - <span v-pre>`{{mode}}`</span> - The current mode
* - <span v-pre>`{{modeSuffix}}`</span>: A suffix based on the mode ('-dev' for development, '' for production)
* - <span v-pre>`{{manifestVersion}}`</span> - Either "2" or "3"
*
* @default "{{name}}-{{version}}-{{browser}}.zip"
* @default "{{name}}-{{packageVersion}}-{{browser}}{{modeSuffix}}.zip"
*/
artifactTemplate?: string;
/**
Expand All @@ -175,9 +176,10 @@ export interface InlineConfig {
* - <span v-pre>`{{packageVersion}}`</span> - The version from the package.json
* - <span v-pre>`{{browser}}`</span> - The target browser from the `--browser` CLI flag
* - <span v-pre>`{{mode}}`</span> - The current mode
* - <span v-pre>`{{modeSuffix}}`</span>: A suffix based on the mode ('-dev' for development, '' for production)
* - <span v-pre>`{{manifestVersion}}`</span> - Either "2" or "3"
*
* @default "{{name}}-{{version}}-sources.zip"
* @default "{{name}}-{{packageVersion}}-sources{{modeSuffix}}.zip"
*/
sourcesTemplate?: string;
/**
Expand Down