feat: add {{packageVersion}} as template variable

[Tensai75]

Overview

This PR adds {{packageVersion}} as an additional template variable to artifactTemplate and sourcesTemplate.
Currently only {{version}} can be used. However, when building for Firefox, a package version such as 1.0.0-beta.1 is reduced to 1.0.0 because Firefox does not allow suffixes in the version in the manifest file. Therefore, the version numbers in the file names of the zip files for Firefox differ from the version number in the file name for Chrome, e.g.:

myextension-1.0.0-beta.1-chrome.zip
myextension-1.0.0-firefox.zip
myextension-1.0.0-sources.zip

With this PR and when using {{packageVersion}} instead of {{version}}, the version in the file names is the same:

myextension-1.0.0-beta.1-chrome.zip
myextension-1.0.0-beta.1-firefox.zip
myextension-1.0.0-beta.1-sources.zip

Manual Testing

Change your package version to 1.0.0-beta.1 .
Set a custom artifactTemplate and sourcesTemplate in your wxt.config.ts:

artifactTemplate: "{{name}}-{{packageVersion}}-{{browser}}.zip",
sourcesTemplate: "{{name}}-{{packageVersion}}-sources.zip" ,

Run wxt zip -b firefox.
The resulting zip files should contain the package version 1.0.0-beta.1 in the file name.

Related Issue

N/A
I think this PR might be beneficial for people like me who want to see the package version number in the filename.

[netlify]

✅ Deploy Preview for creative-fairy-df92c4 ready!

Name	Link
🔨 Latest commit	4da8ae9
🔍 Latest deploy log	https://app.netlify.com/sites/creative-fairy-df92c4/deploys/6809d85c20fb2f00086da8c1
😎 Deploy Preview	https://deploy-preview-1604--creative-fairy-df92c4.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[aklinker1]

As you can see here, the {{version}} template variable will already use the manifest.version_name if it exists... And as long as you haven't manually set the manifest's version property, it will be automatically pulled from the package.json:

https://wxt.dev/guide/essentials/config/manifest.html#version-and-version-name

[Tensai75]

No, it doesn't.
I use custom artifactTemplate and sourcesTemplate:

zip: {
    excludeSources: ['icons/**', 'screenshots/**', '*.yml'],
    artifactTemplate: '{{name}}-v{{version}}-{{browser}}.zip',
    sourcesTemplate: '{{name}}-v{{version}}-sources.zip',
  },

Package version is 1.0.0-beta.1 and I don't set the manifest's version property manually. But the resulting zip files are named:

myextension-v1.0.0-beta.1-chrome.zip
myextension-v1.0.0-firefox.zip
myextension-v1.0.0-sources.zip

-beta.1 is not included in the firefox and sources zip!

EDIT: this is probably because Firefox does not support version_name and hence when building/zipping for Firefox, version_name is not used?

EDIT2: Yep, I was right:

wxt/packages/wxt/src/core/utils/manifest.ts

Lines 115 to 119 in 14d4aa2

	manifest.version_name =
	// Firefox doesn't support version_name
	wxt.config.browser === 'firefox' || versionName === version
	? undefined
	: versionName;

[aklinker1]

Hmm, I understand the problem now, yeah, I'm OK with this change.

Two changes then based on your PR:

1. We call getPackageJson in the line above your change. Call it once and extract it into a variable.
2. Update the JSDoc:
   

   wxt/packages/wxt/src/types.ts

   Lines 143 to 156 in f5619f6

   	/**
   	* Configure the filename output when zipping files.
   	*
   	* Available template variables:
   	*
   	* - <span v-pre>`{{name}}`</span> - The project's name converted to kebab-case
   	* - <span v-pre>`{{version}}`</span> - The version_name or version from the manifest
   	* - <span v-pre>`{{browser}}`</span> - The target browser from the `--browser` CLI flag
   	* - <span v-pre>`{{mode}}`</span> - The current mode
   	* - <span v-pre>`{{manifestVersion}}`</span> - Either "2" or "3"
   	*
   	* @default "{{name}}-{{version}}-{{browser}}.zip"
   	*/
   	artifactTemplate?: string;

   
   

   wxt/packages/wxt/src/types.ts

   Lines 167 to 180 in f5619f6

   	/**
   	* Configure the filename output when zipping files.
   	*
   	* Available template variables:
   	*
   	* - <span v-pre>`{{name}}`</span> - The project's name converted to kebab-case
   	* - <span v-pre>`{{version}}`</span> - The version_name or version from the manifest
   	* - <span v-pre>`{{browser}}`</span> - The target browser from the `--browser` CLI flag
   	* - <span v-pre>`{{mode}}`</span> - The current mode
   	* - <span v-pre>`{{manifestVersion}}`</span> - Either "2" or "3"
   	*
   	* @default "{{name}}-{{version}}-sources.zip"
   	*/
   	sourcesTemplate?: string;

[Tensai75]

If you are OK with a breaking change, maybe it would be more consistent to to have 3 template variables for the version:

• {{version}} --> strictly use manifest.version
• {{versionName}} --> use manifest.version_name if available or fallback to manifest.version (current behaviour of {{version}})
• {{packageVersion}} --> always use package.version

The behaviour of {{version}} would change but this feels more consistent.

What do you say?

[aklinker1]

Eventually that's probably a good idea. If you want this PR merged soon, make the breaking change in the breaking change in a second PR and I'll add it to the next major release whenever that happens.

If it's not urgent, you are welcome to update this PR with that change!

[Tensai75]

I have updated the PR according to your suggestions. I hope it is OK.
I will create a separate PR for the breaking change later.