Shipwri...nd::Base(3)

💖 Shipwright::Backend::Base 💖

okay bestie, gather round, because this is Shipwright::Backend::Base(3) — yes, the whole Shipwri...nd::Base(3) situation (the terminal truncates it, she's shy), and it lives in the User Contributed Perl Documentation section, which is exactly where you'd expect a queen like her to be 💅

---

✨ NAME ✨

Shipwright::Backend::Base — the Base Backend Class, no cap 🎀

---

🌸 DESCRIPTION 🌸

Base Backend Class. that's it. that's the whole description. she's mysterious, she's the blueprint, she's giving foundation energy 🧱✨

---

🦋 METHODS 🦋

here's the whole roster, bestie, every single one, nobody gets left out:

• new — the constructor 🐣 like, the method that makes the thing. iconic behaviour.
• build — (no description given, she's just out here building 💀)
• initialize — initialize a project. you should subclass this method, and call this to get the dir with content initialized 🌱
• import — import a dist. bring the dist home 🏠
• export — (no notes, just vibes ✨)
• checkout — (as above, no notes 🫶)
• commit — A wrapper around svn's commit command. yeah, she's a lil svn girlie 🤝
• update_order — regenerate the dependency order 🔄
• graph_deps — return a dependency graph in graphviz format 📊 pretty lines, very aesthetic
• order — get or set the dependency order 📋
• map — get or set the map 🗺️
• source — get or set the sources map 📚
• flags — get or set flags 🚩
• version — get or set version 🔢
• branches — get or set branches 🌿
• ktf — get or set known failure conditions 💀 (yes, ktf = known-to-fail, we love an acronym)
• refs — get or set refs 🔗
• delete — (no description, she just deletes 💅)
• list — (no description, she lists 📝)
• dists — (no description 📦)
• move — (no description 🚚)
• info — (no description ℹ️)
• requires — return the hashref of require.yml for a dist 📄
• check_repository — Check if the given repository is valid ✅ lowkey a vibe check for repos
• update — you should subclass this method, and run this to get the file path with latest version ⬆️
• test_script — get or set test_script for a project, i.e. /t/test 🧪
• trim — trim dists ✂️
• update_refs — update refs 🔄

we need update this after import and trim ⚠️ like, do not skip this step, fr fr

• has_branch_support — return true if has branch support 🌿✅
• local_dir — for vcs backend, we made a local checkout/clone version, which will live here 🏡
• strip_repository — (no description, she strips, that's her whole thing 🫧)

---

👑 AUTHORS 👑

sunnavy "<sunnavy@bestpractical.com>" — the author, the legend, the main character 🫶

---

📜 LICENCE AND COPYRIGHT 📜

Shipwright is Copyright 2007-2015 Best Practical Solutions, LLC. 🏢

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. 🐪✨ so like, go off, but read the Perl license first, bestie.

---

okay that's the whole page!! and for the cute little sign-off — this gorgeousness is from perl v5.42.0, dated 2025-07-25, and it's filed under Shipwri...nd::Base(3) 💖 thanks for coming to my ted talk, mwah 🎀💋