Add option to web-ext build: --filename="{applications.gecko.id}-{version}.zip"

[motin]

Is this a feature request or a bug?

Feature request

What is the current behavior?

Built files are named according to safeFileName(${extensionName}-${manifestData.version}.zip) without any ability to customize the filename.

What is the expected or desired behavior?

Add a new option like build --filename="some-file.zip". However, to make it useful, it should also accept parameters for substitution, preferably corresponding to manifest contents. Example: web-ext build --filename="%{applications.gecko.id}-%{version}.zip

Originally mentioned here: #855 (comment)

Version information (for bug reports)

web-ext 2.7.0

[deadcoder0904]

Any updates on this feature? Would love to have it :)

[Rob--W]

Patches are welcome. This is also relatively simple to implement, forward a command-line parameter to

web-ext/src/cmd/build.js

Line 147 in 1e6e51b

`${extensionName}-${manifestData.version}.zip`);

and add some unit tests.

[rpl]

@Rob--W sounds good to you if I assign you as mentor for this bug?

[Rob--W]

Yeah, I will mentor this bug.

[kumar303]

Since {} can't be used in a filename (I think?), the formatting string could probably be as simple as --filename="{applications.gecko.id}-{version}.zip"

[Rob--W]

{ and } are not forbidden, but they may have special behavior on Windows if the name matches a CSLID. I think that it is reasonable to not support them, so we can use {} to mark variables.

Filesystems on Windows have the most restrictions: https://docs.microsoft.com/en-us/windows/win32/msi/filename
Other filesystems have fewer restrictions: https://en.wikipedia.org/wiki/Filename#Comparison_of_filename_limitations

[birtony]

I would be happy to work on this feature if that's possible!