feat: Add globalName entrypoint option.

[jviney]

Overview

Implements #2004

The IIFE name is not currently configurable for content scripts and unlisted scripts. The variable name can be important when inserting scripts with world=MAIN or directly via a <script> tag to ensure there is no conflict with an existing variable name on the page.

This PR is a followup to the discussion in #1897 where we decided to add a globalName option.

Questions:

• The globalName property is available on all entrypoints - should we restrict this to just content scripts and unlisted scripts in the type definitions?
• Is there any benefit to having the globalName option available for other entrypoint types?
• How shall we indicate that the default value will switch to the behaviour of false in a future WXT version? Would this version change the generated output for other script types too (eg: background, popup), or will we leave them generating a named IIFE.

Manual Testing

Specify the globalName option on a content script or unlisted script entrypoint and check the generated JS output matches what's expected for the given option.

[netlify]

✅ Deploy Preview for creative-fairy-df92c4 ready!

Name	Link
🔨 Latest commit	e00a3d4
🔍 Latest deploy log	https://app.netlify.com/projects/creative-fairy-df92c4/deploys/699a8baa46d898000894e44c
😎 Deploy Preview	https://deploy-preview-2017--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 project configuration.

[aklinker1]

• The globalName property is available on all entrypoints - should we restrict this to just content scripts and unlisted scripts in the type definitions?

Only content scripts and unlisted scripts are bundled as IIFEs, so this option is only relevant for them.

• Is there any benefit to having the globalName option available for other entrypoint types?

No, for the above reason.

• How shall we indicate that the default value will switch to the behaviour of false in a future WXT version? Would this version change the generated output for other script types too (eg: background, popup), or will we leave them generating a named IIFE.

You don't need to indicate anything in this PR. For the PR that makes the breaking change, add a section to the PR explaining the change and migration path for people.

https://github.com/wxt-dev/wxt/blob/main/CONTRIBUTING.md#breaking-changes-policy

[jviney]

Ready for another review.

[aklinker1]

Nice, thanks! Will release today.

[pkg-pr-new]

Open in StackBlitz

@wxt-dev/analytics

npm i https://pkg.pr.new/@wxt-dev/analytics@2017

@wxt-dev/auto-icons

npm i https://pkg.pr.new/@wxt-dev/auto-icons@2017

@wxt-dev/browser

npm i https://pkg.pr.new/@wxt-dev/browser@2017

@wxt-dev/i18n

npm i https://pkg.pr.new/@wxt-dev/i18n@2017

@wxt-dev/module-react

npm i https://pkg.pr.new/@wxt-dev/module-react@2017

@wxt-dev/module-solid

npm i https://pkg.pr.new/@wxt-dev/module-solid@2017

@wxt-dev/module-svelte

npm i https://pkg.pr.new/@wxt-dev/module-svelte@2017

@wxt-dev/module-vue

npm i https://pkg.pr.new/@wxt-dev/module-vue@2017

@wxt-dev/runner

npm i https://pkg.pr.new/@wxt-dev/runner@2017

@wxt-dev/storage

npm i https://pkg.pr.new/@wxt-dev/storage@2017

@wxt-dev/unocss

npm i https://pkg.pr.new/@wxt-dev/unocss@2017

@wxt-dev/webextension-polyfill

npm i https://pkg.pr.new/@wxt-dev/webextension-polyfill@2017

wxt

npm i https://pkg.pr.new/wxt@2017

commit: e00a3d4

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 76.22%. Comparing base (182d575) to head (e00a3d4).
⚠️ Report is 7 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2017      +/-   ##
==========================================
+ Coverage   76.11%   76.22%   +0.10%     
==========================================
  Files         113      114       +1     
  Lines        3048     3062      +14     
  Branches      682      687       +5     
==========================================
+ Hits         2320     2334      +14     
  Misses        643      643              
  Partials       85       85              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[github-actions]

Thanks for helping make WXT better!