Dist::...uleInfo(3pm)

πŸ“¦
version 6.000 Β· 4 versions
, in debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

✨ NAME ✨

Dist::Zilla::Role::ModuleInfo β€” bestie, this is the role that builds a Module::Metadata object out of a Dist::Zilla::File. πŸ¦‹ (Also hi, yes, this is a 3pm page β€” User Contributed Perl Documentation, the section-3 Perl module manual zone. Welcome. πŸ’–)


πŸ’… VERSION πŸ’…

So this doc describes version 6.000 of Dist::Zilla::Role::ModuleInfo, and it dropped on December 17, 2017, as part of Dist-Zilla-Plugins-CJM version 6.000. Vintage but iconic, no cap. ⭐


🌸 DESCRIPTION 🌸

Okay so here's the tea. πŸ«– If you're writing a plugin that implements ModuleInfo, you get to call your own get_module_info method, and that's literally how you construct a Module::Metadata object. Main character behaviour.

And quick lore drop: Module::Metadata is the new name for Module::Build::ModuleInfo, now that it's been split away from the Module-Build distribution. She moved out, got her own place, kept the same energy. πŸ’…


πŸŽ€ METHODS πŸŽ€

get_module_info

my $info = $plugin->get_module_info($file);

The way this works: it constructs a Module::Metadata object from the contents of a $file object that does Dist::Zilla::Role::File. ✨

And any extra arguments you toss in? They get passed straight along to Module::Metadata->new_from_file. No extra processing, no side quests, just handing them over. πŸ™ˆ


🌈 CONFIGURATION AND ENVIRONMENT 🌈

Dist::Zilla::Role::ModuleInfo requires no configuration files and no environment variables. Nothing. Zero. She's low maintenance, she's unbothered, she's thriving. 🧚


🧚 DEPENDENCIES 🧚

Just one, and it's giving loyal bestie:

  • Module::Metadata

πŸ“ INCOMPATIBILITIES πŸ“

None reported. Zero drama. We love a peaceful queen. πŸŽ€


πŸ’€ BUGS AND LIMITATIONS πŸ’€

No bugs have been reported. Not one. Not me knocking on wood or anything. πŸͺ΅βœ¨


πŸ‘‘ AUTHOR πŸ‘‘

Christopher J. Madsen "<perl AT cjmweb.net>" β€” the icon, the legend. πŸ‘‘

Please report any bugs or feature requests to "<bug-Dist-Zilla-Plugins-CJM AT rt.cpan.org>", or slide through the web interface at <http://rt.cpan.org/Public/Bug/Report.html?Queue=Dist-Zilla-Plugins-CJM>. πŸ’Œ

And if you wanna follow along or contribute to Dist-Zilla-Plugins-CJM's development, it's all happening at <https://github.com/madsen/dist-zilla-plugins-cjm>. Go be part of the story bestie, the repo is right there. 🫢


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. So yeah β€” same vibes as Perl itself, do your thing. 🌈


⭐ DISCLAIMER OF WARRANTY ⭐

Okay bestie, here comes the part where the lawyers start SCREAMING in all caps, and I'm not even exaggerating, this is the actual text, so buckle up: 😭

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.

Translation, because I got you: it's free, so if it breaks, that's a you problem, and nobody is paying for your damages. No cap. πŸ’…

That's the whole page, bestie! πŸŽ€ This gem was rendered by perl v5.34.0, dated 2022-06-13, and it's the Dist::...uleInfo 3pm page β€” go forth and construct your metadata objects, you absolute icon. πŸ‘‘βœ¨πŸ’–

πŸ“¦ where this page comes from