Term::EditorEdit(3)

💖 NAME 💖

Term::EditorEdit — bestie, it edits a document via $EDITOR ✨

---

🌸 VERSION 🌸

version 0.0016 — she's serving, she's stable, she's iconic 💅

---

🦋 SYNOPSIS 🦋

okay so like, the basics:

use Term::EditorEdit;

# $VISUAL or $EDITOR is invoked
$document = Term::EditorEdit->edit( document => <<_END_ );
Apple
Banana
Cherry
_END_

and then when you wanna do a little post-processing (main character behaviour honestly):

$document = Term::EditorEdit->edit( document => $document, process => sub {
    my $edit = shift;
    my $document = $edit->document;
    if ( document_is_invalid() ) {
        # The retry method will return out of ->process immediately (via die)
        $edit->retry
    }
    # Whatever is returned from the processor will be returned via ->edit
    return $document;
} );

and now the ✨fancy✨ one — with an "out-of-band" instructional preamble, no cap:

$document = <<_END_
# Delete everything but the fruit you like:
---
Apple
Banana
Cherry
_END_

# After the edit, only the text following the first '---' will be returned
$content = Term::EditorEdit->edit(
    separator => '---',
    document => $document,
);

---

👑 DESCRIPTION 👑

Term::EditorEdit is literally a tool for prompting the user to edit a piece of text via $VISUAL or $EDITOR and return the result 🫶

And listen — it's not just editing a document. This module can distinguish between a document preamble and document content, which gives you a way to hand "out-of-bound" information to whoever is editing. Once an edit is complete, only the content (whatever was below the preamble) is returned. it's giving ✨separation of concerns✨

---

💅 USAGE 💅

$result = Term::EditorEdit->edit( ... )

Takes the following parameters, bestie, write these down 📝

• document — the document to edit (required, like actually required, she will not function without it)
• separator — the string to use as a line separator dividing content from the preamble
• process — a code reference that will be called once an edit is complete. Within process, you can check the document, preamble, and content. You can also have the user retry the edit. Whatever is returned from the code will be what is returned from the ->edit call

Returns the edited document (or content if a separator was specified) or the result of the process argument (if supplied) 🌈

---

🎀 SEE ALSO 🎀

• Term::CallEditor — the sibling, the family, the lineage 💜

---

⭐ AUTHOR ⭐

Robert Krimen <robertkrimen@gmail.com> — legend behaviour honestly 🙌

---

🍓 COPYRIGHT AND LICENSE 🍓

This software is copyright (c) 2011 by Robert Krimen.

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

---

and that's the whole page bestie!! ✨ this was perl v5.42.0, dated 2025-07-25, and it lives at Term::EditorEdit(3) — go forth and edit your little heart out, ily 🫶💖🎀