Dist::...Prereqs(3pm)

📦
version 6.000 · 4 versions
, in debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

💖 Dist::Zilla::Plugin::RecommendedPrereqs 💖

okay bestie, so this page is from the User Contributed Perl Documentation for the Dist::...Prereqs(3pm) manual, and the star of the show is a lil Dist::Zilla plugin called Dist::Zilla::Plugin::RecommendedPrereqs. pull up a chair, we're about to be so normal about prerequisites 🫶

✨ NAME ✨

Dist::Zilla::Plugin::RecommendedPrereqs — it goes looking for comments that recommend prerequisites. that's it, that's the job. lowkey iconic. 💅

🌸 VERSION 🌸

This doc is describing version 4.21 of Dist::Zilla::Plugin::RecommendedPrereqs, which dropped on December 17, 2017 as part of Dist-Zilla-Plugins-CJM version 6.000. vintage, but make it fashion. 🎀

🦋 SYNOPSIS 🦋

so in your dist.ini, you're gonna do this:

[RecommendedPrereqs]

and then in your actual code, you drop lil notes like this:

# RECOMMEND PREREQ: Foo::Bar 1.0
# SUGGEST PREREQ:   Foo::Suggested

see? cute, self-documenting, no cap. ✨

💜 DESCRIPTION 💜

so here's the tea. if you include this plugin, it will go hunting for those special little comments that spell out your suggested or recommended prerequisites. think of it as the bestie sidekick to AutoPrereqs — except AutoPrereqs can only ever figure out the required prereqs, and this one handles the softer, gentler tiers. 😌

here are the rules, and they're strict but fair:

  • each comment has to live on a line all by itself. no sharing, it's a main character. 👑
  • it has to start with either "RECOMMEND PREREQ:" or "SUGGEST PREREQ:", and then the module name.
  • after the name you may put the minimum version.
  • after the version you may put a note explaining why this prereq exists — and that note just gets ignored. no thoughts, head empty, we don't read it. 🙈
  • ⚠️ but if you include the note, the version must be present too. even if it's 0. yes, even 0. fr fr.

🍓 INCOMPATIBILITIES 🍓

None reported. literally zero drama. a peaceful, unbothered plugin. 🌈

💀 BUGS AND LIMITATIONS 💀

okay so this is the part where we keep it real. 😭

the parser currently just looks for any line beginning with a "#" — and that # may have whitespace before it, it does not care. which means... it's looking in places you did not intend:

  • inside strings 😬
  • inside here docs 😬
  • even after "__END__" 😬
this behavior may get fixed in the future, so do not depend on it. like, please don't build your whole thing on this. it's giving undefined behavior energy.

🌟 AUTHOR 🌟

Christopher J. Madsen <perl AT cjmweb.net> — the legend, the moment, the whole vibe. 👑

got bugs? got feature requests? spill:

and if you wanna follow along or contribute to Dist-Zilla-Plugins-CJM's development, the repo lives at <https://github.com/madsen/dist-zilla-plugins-cjm>. go be part of the story bestie 🫶

This software is copyright (c) 2017 by Christopher J. Madsen.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. slay, permissive licensing, we love to see it 💅

🧚 DISCLAIMER OF WARRANTY 🧚

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENSE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

and that's the whole page, bestie 💖 this doc came to you courtesy of perl v5.34.0 on 2022-06-13, filed under Dist::...Prereqs(3pm) in the User Contributed Perl Documentation. now go forth and annotate your prereqs, you absolute icon 🌟🦋💜

📦 where this page comes from