Module...estSkip(3pm)

πŸ’– Module::Install::ManifestSkip β€” the vibe ✨

okay bestie so this page lives in the User Contributed Perl Documentation section of the manual, and honestly? it's giving "tiny module, huge convenience" energy. no cap. πŸŽ€


🌸 NAME 🌸

Module::Install::ManifestSkip β€” it generates a MANIFEST.SKIP file for you, and that's literally the whole job. and it ate. πŸ’…


✨ SYNOPSIS ✨

okay so this is what it looks like in the wild, copy it exactly, don't freestyle:

use inc::Module::Install;

all_from 'lib/Foo.pm';

manifest_skip;

WriteAll;

that's it. that's the whole ritual. πŸ¦‹


πŸ’œ DESCRIPTION πŸ’œ

so here's the tea: this module generates a MANIFEST.SKIP file for you (it's using Module::Manifest::Skip under the hood, icon behavior) and that file contains all the common files that people do not want showing up in their MANIFEST files. and it regenerates the SKIP file every single time you (yes, you, the module author, main character) run Makefile.PL. every time. it's committed like that. πŸ”₯

and here's the cute part: you can add your own custom entries at the top of the MANIFEST file. just put a blank line after your entries, and the module will leave them alone. respectful. we love a module that knows boundaries. 🫢

this module also adds 'MANIFEST' to the clean_files() list, so that make clean will remove your MANIFEST for you. no manual deleting, no mess, periodt. 🧚


πŸ’… OPTIONS πŸ’…

  • manifest_skip 'clean'; β€” if you don't plan on adding anything to the stock MANIFEST.SKIP and you just want make clean to delete it, say this:
manifest_skip 'clean';

like that. exactly that. slay. ✨


🌈 THEORY 🌈

okay so there's this one school of thought for release management, and it goes like this: you never commit your MANIFEST file. you just generate it using make manifest, right before releasing a module, and then delete it afterwards. chaotic? maybe. correct? also maybe. πŸ‘‘

the reasoning is lowkey genius: this way you never forget to add new files to your MANIFEST. that's the win. πŸ†

the only problems β€” and the original is very honest about this β€” are that:

  • you always need to generate a MANIFEST.SKIP file, and
  • you need to add MANIFEST to your clean_files, or delete it by hand. 😭

and this module does both of those things for you. bestie behavior fr fr. πŸ’–


πŸŽ€ AUTHOR πŸŽ€

Ingy dΓΆt Net <ingy@cpan.org> β€” king. πŸ‘‘


Copyright 2010-2014. Ingy dΓΆt Net.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

See <http://www.perl.com/perl/misc/Artistic.html>


πŸ’€ heads up bestie: that license line is real, and that URL is real, so don't go rewriting them. they stay exactly as written. iykyk. 🌸

and that's the whole page!! πŸ¦‹ this one came from perl v5.34.0, dated 2022-06-15, and the manual section is Module...estSkip(3pm). go forth and skip your manifests, queen. πŸ’…βœ¨πŸŽ€

πŸ“¦ where this page comes from