Dist::...xternal(3pm)

💖 NAME 💖

okay so bestie, meet Dist::Zilla::Plugin::RequiresExternal — it makes your dists require external commands. like, actual programs that have to exist on the machine. iconic behaviour tbh.

---

✨ VERSION ✨

this is version 1.009 🎀 (also known as Dist::...xternal(3pm), the manual page we are literally reading right now, hi)

---

🌸 SYNOPSIS 🌸

in your dist.ini:

[RequiresExternal]
requires = /path/to/some/executable
requires = executable_in_path

that's it. that's the whole vibe. 💅

---

🦋 DESCRIPTION 🦋

this Dist::Zilla plugin writes a test into your distribution that checks whether the executable commands you require actually exist. so if your code needs sqlplus to be alive and present, this plugin will go "bestie… where is it" at test time. no cap. 🔥

---

👑 ATTRIBUTES 👑

requires

every requires attribute has to be either an absolute path to an executable or the name of a command sitting in the user's PATH environment. and yes, you can have multiple requires lines. stack 'em. slay. ✨

example from a dist.ini file:

[RequiresExternal]
requires = sqlplus
requires = /usr/bin/java

this means the program sqlplus needs to be available somewhere in the user's PATH, and the program java needs to be specifically in /usr/bin. very specific. very demure. 💅

fatal

a boolean value that decides whether a failed test immediately stops testing. it also changes the test name to t/000-requires_external.t so that it runs earlier. defaults to false. so by default it's chill, but flip it and it's giving main character energy at the front of the line. 😭

---

💜 METHODS 💜

gather_files

adds a t/requires_external.t test script to your distribution that checks if each requires item is executable. periodt. 🔥

metadata

using this plugin will add Test::Most and Env::Path to your distribution's testing prerequisites, since the generated script uses those modules. surprise dependencies! but like, not a surprise, because we just told you. 🫶

---

🌈 SEE ALSO 🌈

this module was indirectly inspired by Module::Install::External's requires_external_bin command. ancestral icon behaviour. 👑

---

💖 SUPPORT 💖

Perldoc

you can find documentation for this module with the perldoc command.

perldoc Dist::Zilla::Plugin::RequiresExternal

Websites

the following websites have more information about this module, and may be of help to you. as always, in addition to those websites please use your favorite search engine to discover more resources. (yes bestie, google it, we believe in you 🌸)

• CPANTS

the CPANTS is a website that analyzes the Kwalitee ( code metrics ) of a distribution.

<http://cpants.cpanauthors.org/dist/Dist-Zilla-Plugin-RequiresExternal>

• CPAN Testers

the CPAN Testers is a network of smoke testers who run automated tests on uploaded CPAN distributions.

<http://www.cpantesters.org/distro/D/Dist-Zilla-Plugin-RequiresExternal>

• CPAN Testers Matrix

the CPAN Testers Matrix is a website that provides a visual overview of the test results for a distribution on various Perls/platforms.

<http://matrix.cpantesters.org/?dist=Dist-Zilla-Plugin-RequiresExternal>

• CPAN Testers Dependencies

the CPAN Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution.

<http://deps.cpantesters.org/?module=Dist::Zilla::Plugin::RequiresExternal>

Bugs / Feature Requests

please report any bugs or feature requests through the web interface at <https://github.com/mjgardner/Dist-Zilla-Plugin-RequiresExternal/issues>. you will be automatically notified of any progress on the request by the system. so you'll literally know. 💅

Source Code

the code is open to the world, and available for you to hack on. please feel free to browse it and play with it, or whatever. if you want to contribute patches, please send me a diff or prod me to pull from your repository :)

<https://github.com/mjgardner/Dist-Zilla-Plugin-RequiresExternal>

git clone git://github.com/mjgardner/Dist-Zilla-Plugin-RequiresExternal.git

---

🎀 AUTHORS 🎀

• Mark Gardner <mjgardner@cpan.org>
• Joenio Costa <joenio@joenio.me>

---

⭐ COPYRIGHT AND LICENSE ⭐

this software is copyright (c) 2020 by GSI Commerce and Joenio Costa.

this is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

💀 fr fr, that's the whole license. free software, same terms as Perl 5, go wild but like, respectfully.

---

okay that's the whole page bestie, you ate it up 🫶 this was perl v5.32.1, dated 2021-02-16, and you've been reading Dist::...xternal(3pm) — thanks for coming to my ted talk, mwah 💋✨