Shipwright::Util(3)

okay bestie, pull up a chair because it's time for Shipwright::Util(3) — the user-contributed Perl doc that's basically a lil treasure chest of helper functions. no cap, it's a whole vibe. 💖

---

🌸 LIST 🌸

here's the rundown of everything this module is serving you.

✨ General Helpers ✨

• load_yaml, load_yaml_file, dump_yaml, dump_yaml_file — these four are literally just dropped in from YAML::Tiny. that's it, that's the whole story, they came pre-loaded like a starter pack. 🎀
• confess_or_die — it's here! the docs don't spill any extra tea on it, it just sits in the list looking iconic. 💅
• parent_dir — returns the dir's parent dir. heads up tho: the arg you pass in must be a dir path. 🗂️
• run_cmd — a wrapper of the run3 sub in IPC::Run3. 🏃
• select_fh — a wrapper for the select in core. 🌀
• find_module — takes a perl modules name space and the name of a module in that space. it finds and returns the matching module name using a case insensitive search. for example:

find_module('Shipwright::Backend', 'svn');
# returns 'Shipwright::Backend::SVN'

find_module('Shipwright::Backend', 'git');
# returns 'Shipwright::Backend::Git'

and if there's literally no module matching your criteria? it returns undef. sad but true, bestie. 😭

🦋 PATHS 🦋

• shipwright_root — returns the root directory that Shipwright has been installed into. it uses %INC to figure out where Shipwright.pm is. sneaky smart, honestly. 🔍
• share_root — returns the 'share' directory of the installed Shipwright module. currently this is only used to store the initial files in project. 📁
• user_home — returns the current user's home directory. 🏠
• shipwright_user_root — the user's own shipwright root, where we put internal files in. it's ~/.shipwright by default. plot twist: it can be overwritten by $ENV{SHIPWRIGHT_USER_ROOT}. 👑

---

💜 NAME 💜

Shipwright::Util - Util

yes, that's the name. yes, it's just "Util". she's lowkey mysterious like that. ✨

---

🌟 AUTHOR 🌟

sunnavy "<sunnavy@bestpractical.com>"

shoutout to the author, absolute legend, main character energy fr fr. 🫶

---

🎀 LICENCE AND COPYRIGHT 🎀

Copyright 2007-2015 Best Practical Solutions.

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

legal stuff, but make it cute — go forth and remix, bestie. 🌈

---

and that's the whole page, bestie! this was perl v5.42.0 vibes, dated 2025-07-25, and you just finished reading Shipwright::Util(3) — slay, you ate that. periodt. 💅💖✨