Code::T...Command(3)

💖 Code::TidyAll::Role::RunsCommand 💖

okay bestie, welcome to the Code::TidyAll::Role::RunsCommand(3) page from User Contributed Perl Documentation ✨ this one is all about the role for plugins which run external commands, and we are gonna cover every little detail. no cap. 🫶

---

🌸 NAME 🌸

Code::TidyAll::Role::RunsCommand — a role for plugins which run external commands 💅

---

🦋 VERSION 🦋

version 0.84 — iconic, immaculate, current. ✨

---

🎀 SYNOPSIS 🎀

package Whatever;
use Moo;
with 'Code::TidyAll::Role::RunsCommand';

---

🌈 DESCRIPTION 🌈

It's a a role (yes, the original really says “a a” twice, love that for us) for plugins which run external commands. 💖

---

🧚 ATTRIBUTES 🧚

• cmd — the command to run. This is just the executable, bestie; it should not include additional arguments. periodt. 💅

---

🔥 METHODS 🔥

_run_or_die(@argv)

This method runs the plugin's command, combining any values provided to the plugin's argv attribute with those passed to the method. 🛠️

The plugin's argv attribute is parsed with the shellwords subroutine from Text::ParseWords in order to turn the argv string into a list. This ensures that running the command does not spawn an external shell. very demure, very safe. 🐚✨

The @argv passed to the command comes after the values from the argv attribute. The assumption is that this will be what passes a file or source string to the external command. 🍓

If the command exits with a non-zero status, then this method throws an exception. The error message it throws includes the command that was run (with arguments), the exit status, any signal received by the command, and the command's output. 😭 so if it goes wrong, you get the receipts.

Both stdout and stderr from the command are combined into a single string returned by the method. 🫶

bestie, non-zero exit = exception thrown, not a quiet little vibe check. keep that in mind. 💀

_is_bad_exit_code($code)

This method returns true if the exit code is bad and false otherwise. By default all non-zero codes are bad, but some programs may be expected to exit non-0 when they encounter validation/tidying issues. 👑 so yeah, bad exit codes are usually bad, but sometimes the program is just being dramatic for a valid reason.

---

🫶 SUPPORT 🫶

Bugs may be submitted at <https://github.com/houseabsolute/perl-code-tidyall/issues>. 🐛 go off, report that bug.

---

📦 SOURCE 📦

The source code repository for Code-TidyAll can be found at <https://github.com/houseabsolute/perl-code-tidyall>. 💖

---

👑 AUTHORS 👑

• Jonathan Swartz <swartz@pobox.com> 🦋
• Dave Rolsky <autarch@urth.org> 🌈

---

🎀 COPYRIGHT AND LICENSE 🎀

This software is copyright (c) 2011 - 2023 by Jonathan Swartz. 💜

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

The full text of the license can be found in the LICENSE file included with this distribution. 📄✨

---

okay bye bestie 💅 this page is from perl v5.42.0, dated 2024-03-08, and it lives under Code::T...Command(3). periodt. 💖