App::D...Update(3pm)

💖 App::DocKnot::Update — the glow-up page 💖

okay bestie, so this is App::DocKnot::Update, straight out of the User Contributed Perl Documentation corner of the universe ✨ it's the little module that handles updating DocKnot input or package configuration, and honestly? it's giving "I fix your old files so you don't have to." iconic behavior, no cap 🎀

---

✨ SYNOPSIS ✨

use App::DocKnot::Update;

my $update = App::DocKnot::Update->new(
    {
        metadata => 'docs/metadata',
        output   => 'docs/docknot.yaml',
    }
);
$update->update();

$update->update_spin('/path/to/spin/input');

like, that's it. that's the whole vibe. you build it, you call it, it does the thing 💅

---

🦋 REQUIREMENTS 🦋

so before you even breathe in this module's direction, you need Perl 5.24 or later — that's the floor, bestie, not a suggestion — plus these modules, all of which are chilling on CPAN waiting for you:

• Git::Repository
• File::BaseDir
• File::ShareDir
• JSON::MaybeXS
• Path::Iterator::Rule
• Path::Tiny
• Perl6::Slurp
• YAML::XS

collect them all like they're stickers in your binder 🍓

---

🌈 DESCRIPTION 🌈

This component of DocKnot updates package configuration from older versions. periodt. Currently, its main purpose is to convert from the JSON format used prior to DocKnot 4.0 to the current YAML syntax. that's the whole arc — glow-up from JSON to YAML, and she ate 🔥

---

👑 CLASS METHODS 👑

new(ARGS)

Create a new App::DocKnot::Update object. This should be used for all subsequent actions — like, do NOT skip this step, it's the main character introduction. ARGS should be a hash reference with one or more of the following keys:

• metadata — The path to the directory containing the legacy JSON metadata for a package. Default: docs/metadata relative to the current directory.
• output — The path to which to write the new YAML configuration. Default: docs/docknot.yaml relative to the current directory.

two keys, very demure, very mindful, defaults already handled so you can just vibe 🙈

---

🧚 INSTANCE METHODS 🧚

update()

Load the legacy JSON metadata and write out the YAML equivalent. in → out. old → new. slay ✨

update_spin([PATH])

Update the input tree for App::DocKnot::Spin to follow current expectations. PATH is the path to the input tree, which defaults to the current directory if not given. so if you're like "bestie I don't know where my tree is," she'll just assume you mean the current directory, we've all been there 💜

If the input tree is the working tree for a Git repository, any changes are also registered with Git (but not committed). so she stages, she does not commit. she sets the table, she does not eat. you do the commit yourself, king 👑

🫶 heads up bestie: not committed fr fr. the changes are registered with Git and that is all. the rest is on you.

---

🌸 AUTHOR 🌸

Russ Allbery <rra@cpan.org>

---

💖 COPYRIGHT AND LICENSE 💖

Copyright 2013-2022, 2024 Russ Allbery <rra@cpan.org>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

😭 yes bestie the ALL CAPS part is scary but that's just how licenses yell. it means what it says. read it, it's real.

---

🌟 SEE ALSO 🌟

• docknot(1)
• App::DocKnot::Config

This module is part of the App-DocKnot distribution. The current version of DocKnot is available from CPAN, or directly from its web site at <https://www.eyrie.org/~eagle/software/docknot/>. go peek, she's cute 💫

---

k bye bestie, this page was perl v5.40.1 flavored and dated 2026-01-16, which is honestly so futuristic of it ✨💅 stay slaying, and remember: update your configs, hydrate, and never commit someone else's staged changes 🫶💖