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

Co-authored-by: Aaron <aaronklinker1@gmail.com>

Author: Tensai75

packages/wxt/e2e/tests/zip.test.ts

@@ -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',
       },
     });
 

packages/wxt/src/core/resolve-config.ts

@@ -297,8 +297,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,

packages/wxt/src/core/zip.ts

@@ -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)
@@ -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}`);
 

packages/wxt/src/types.ts

@@ -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;
     /**
@@ -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;
     /**