fix: Support negation patterns when including/excluding files from ZIP files

[nishu-murmu]

Overview

This is issue reproduction repo: https://github.com/skube/min-repro-wxt

Here is the discussion about creating this PR and more context.

#1510 (comment)

This PR closes #1510

---

Edit from @aklinker1: You can now do things like this when zipping the extension and source code:

// wxt.config.ts

export default defineConfig({
  zip: {
    // Exclude all JSON files from your extension zip except for the manifest
    exclude: ["*.json", "!manifest.json"],
    // Include all TS files in your Firefox sources ZIP, except tests.
    includeSources: ["**/*.ts", "!**/__tests__/*.ts"],
    // Exclude all scripts except for a build script from Firefox sources ZIP
    excludeSources: ["scripts/*", "!scripts/build.sh"],
  },
})

[netlify]

✅ Deploy Preview for creative-fairy-df92c4 ready!

Name	Link
🔨 Latest commit	ef8163b
🔍 Latest deploy log	https://app.netlify.com/projects/creative-fairy-df92c4/deploys/684dedc8c9c81d00090d52af
😎 Deploy Preview	https://deploy-preview-1517--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.

[nishu-murmu]

Do I need to add some test cases for these fix?

[aklinker1]

Thanks for the PR! We need to add some tests around these changes:

https://github.com/wxt-dev/wxt/blob/main/packages/wxt/e2e/tests/zip.test.ts

[aklinker1]

Hold on, I'm looking at this code now, and based on the old logic:

options?.include?.some((pattern) => minimatch(relativePath, pattern)) || !options?.exclude?.some((pattern) => minimatch(relativePath, pattern))

Couldn't you have just added mainfest.json to include, since include has priority over exclude?

[nishu-murmu]

Yeah, but original issue was to include this negate feature in exclude parameter. Maybe you can explain this to @skube.

[skube]

Perhaps I'm not understanding something, but I don't see an include option under the zip property.

[nishu-murmu]

Oh yeah, there isn't.
@aklinker1 that options.includes you're mentioning is taking includeSources
that is different option.

[nishu-murmu]

I've added a test case.

[aklinker1]

Ah, duh 👍

[aklinker1]

Sorry for the slowness, I got caught up in responding to new PRs and issues, so I lost track of this one. We'll get this merged and released now!

Gonna merge with main, checks aren't running how they should be...

[pkg-pr-new]

Open in StackBlitz

@wxt-dev/analytics

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

@wxt-dev/auto-icons

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

@wxt-dev/browser

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

@wxt-dev/i18n

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

@wxt-dev/module-react

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

@wxt-dev/module-solid

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

@wxt-dev/module-svelte

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

@wxt-dev/module-vue

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

@wxt-dev/runner

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

@wxt-dev/storage

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

@wxt-dev/unocss

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

@wxt-dev/webextension-polyfill

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

wxt

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

commit: ef8163b

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.14%. Comparing base (1272e2e) to head (ef8163b).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1517      +/-   ##
==========================================
+ Coverage   80.98%   81.14%   +0.15%     
==========================================
  Files         129      130       +1     
  Lines        6627     6649      +22     
  Branches     1080     1090      +10     
==========================================
+ Hits         5367     5395      +28     
+ Misses       1249     1243       -6     
  Partials       11       11              

☔ 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.

[aklinker1]

One more change, I'm gonna extract this to a function and use it for both include and exclude. That way we can have unit tests to cover other cases as well.

[github-actions]

Thanks for helping make WXT better!