Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aklinker1 merged 10 commits into from
Jun 14, 2025
Merged

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

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
0283fb9
feat: making negate regex pattern work in zip.exclude
nishu-murmu Mar 13, 2025
97aed7c
feat: exclude files in .zip except those with a bang !
nishu-murmu Mar 16, 2025
14550f5
Merge branch 'fix/zip-exclude-bang' of github.com:nishu-murmu/wxt int…
nishu-murmu Apr 7, 2025
1d9ebee
chore: removed unused function.
nishu-murmu Apr 10, 2025
733daf1
Merge branch 'main' of github.com:wxt-dev/wxt into fix/zip-exclude-bang
nishu-murmu Apr 10, 2025
ac9ecbb
chore: reverting code in wxt.config.ts in wxt-demo.
nishu-murmu Apr 10, 2025
628af36
chore: adding tests.
nishu-murmu Apr 10, 2025
cd37b52
Merge remote-tracking branch 'origin/main' into fix/zip-exclude-bang
aklinker1 Jun 14, 2025
6b1d61b
Extract util and add unit tests, apply util to both `include` and
aklinker1 Jun 14, 2025
ef8163b
Fix lint
aklinker1 Jun 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/wxt-demo/wxt.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ export default defineConfig({
},
zip: {
downloadPackages: ['sass'],
exclude: [
'**/*.json', // Exclude all .json files
'!manifest.json', // Include manifest.json
],
Copy link
Member

@aklinker1 aklinker1 Apr 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Contributor Author

@nishu-murmu nishu-murmu Apr 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

@skube skube Apr 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

@nishu-murmu nishu-murmu Apr 10, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

@nishu-murmu nishu-murmu Apr 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added a test case.

Copy link
Member

@aklinker1 aklinker1 Jun 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, duh 👍

},
analysis: {
open: true,
Expand Down
26 changes: 25 additions & 1 deletion packages/wxt/src/core/zip.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,20 @@ async function zipDir(
},
): Promise<void> {
const archive = new JSZip();

function negateCheck(exclude: string[], relativePath: string) {
return exclude
?.map((pattern) => {
if (pattern.startsWith('!')) {
if (relativePath.endsWith('.json')) {
console.log(minimatch(relativePath, pattern.slice(1)));
}
return minimatch(relativePath, pattern.slice(1));
}
return false;
})
.filter(Boolean);
}
const files = (
await glob(['**/*', ...(options?.include || [])], {
cwd: directory,
Expand All @@ -121,9 +135,19 @@ async function zipDir(
onlyFiles: true,
})
).filter((relativePath) => {
const isNegated = options?.exclude?.some(
(option) =>
option.startsWith('!') && minimatch(relativePath, option.slice(1)),
);
if (isNegated) return true;
const updatedExcludeOptions = options?.exclude?.filter(
(option) => !option.startsWith('!'),
);
return (
options?.include?.some((pattern) => minimatch(relativePath, pattern)) ||
!options?.exclude?.some((pattern) => minimatch(relativePath, pattern))
!updatedExcludeOptions?.some((pattern) =>
minimatch(relativePath, pattern),
)
);
});
const filesToZip = [
Expand Down