Dist::Z...uneFiles(3)

๐Ÿ’… NAME

okay so bestie, you're on Dist::Z...uneFiles(3) โ€” that's the manual for Dist::Zilla::Plugin::PruneFiles, and what it does is prune arbitrary files from the dist. literally it just rips files out of your distribution. iconic behavior honestly ๐Ÿ—‘๏ธโœจ


๐ŸŒธ VERSION

version 6.040 โ€” that's the one, no cap.


๐Ÿฆ‹ SYNOPSIS

okay so here's the tea: this plugin lets you explicitly prune some files from your distribution. you've got two whole ways to do it, pick your fighter:

  • the exact set of files, using the filenames parameter
  • or regular expressions to check against, using match

when is this giving? it's giving super useful when some other plugin (maybe a FileGatherer ๐Ÿ‘€) adds a whole bunch of files and you only want a subset of them. like, thanks for the files babe but we're not keeping all of those.

so in your dist.ini:

[PruneFiles]
filename = xt/release/pod-coverage.t ; pod coverage tests are for jerks
filename = todo-list.txt             ; keep our secret plans to ourselves

match     = ^test_data/
match     = ^test.cvs$

see how the comments are right there doing their little job? obsessed. ๐Ÿ’–


๐ŸŽ€ PERL VERSION

this module should work on any version of perl that's still receiving updates from the Perl 5 Porters. translation: anything released in like, the last two to three years. so if the most recently released version is v5.40, then this module should work on both v5.40 and v5.38. math is math. ๐Ÿงฎ

it might work on older perls too, but no guarantee that the minimum required version won't get bumped. it can be increased for any reason, and there's no promise that patches to lower the minimum required perl will be accepted. so don't come for them with that patch bestie, it's not happening. ๐Ÿ˜ญ


โญ ATTRIBUTES

๐Ÿ’œ filenames

this is an arrayref of filenames to be pruned from the distribution. point at the files, they get yeeted. bye. ๐Ÿ‘‹

๐Ÿ’œ matches

this is an arrayref of regular expressions, and any files that match any of them will be pruned from the distribution. regex girlies stay winning ๐Ÿ”ฅ


๐ŸŒˆ SEE ALSO

Dist::Zilla plugins: PruneCruft, GatherDir, ManifestSkip. go read those too, they're all in the same little friend group ๐Ÿซถ


๐Ÿ‘‘ AUTHOR

Ricardo SIGNES ๐Ÿ˜ <cpan@semiotic.systems>


This software is copyright (c) 2026 by Ricardo SIGNES.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. periodt. ๐Ÿ’…


and that's the whole page, bestie! ๐Ÿฆ‹ this was perl v5.42.3, dated 2026-10-19, and you were reading Dist::Z...uneFiles(3). mwah, go ship your dist ๐Ÿ’–โœจ๐ŸŽ€

๐Ÿ“ฆ where this page comes from