Debian...arning(3pm)

💖 Debian::DEP12::ValidationWarning(3pm) — bestie edition 💖

okay so this is a page from the User Contributed Perl Documentation section, and the star of the show is Debian::DEP12::ValidationWarning, a lil class that holds onto your validation warnings like a notes-app girlie who never loses a receipt. let's get into it 🎀

---

✨ NAME ✨

Debian::DEP12::ValidationWarning — the validation warning class. yes bestie, it's giving "structured complaint" energy and we love her for it 💅

---

✨ SYNOPSIS ✨

use Debian::DEP12::ValidationWarning;

my $warning = Debian::DEP12::ValidationWarning->new(
    'value \'%(value)s\' is better written as \'%(suggestion)s\'',
    {
        field => 'Bug-Submit',
        value => 'merkys@cpan.org',
        suggestion => 'mailto:merkys@cpan.org',
    }
);
print STDERR "$warning\n";

look at her go 🦋 you build one, you print it to STDERR, done. no cap.

---

✨ DESCRIPTION ✨

Debian::DEP12::ValidationWarning exists so a validation warning's content can be stored in a structured way instead of just vibing as a loose string. and ngl, right now the class is built on top of Text::BibTeX::Validate::Warning — but she might get decoupled in the future, so don't get too attached to that ancestry, iykyk 👑

---

✨ METHODS ✨

🌸 new( $message, $fields )

takes a Text::sprintfn-compatible template plus a hash holding the values you wanna swap into that template. classic.

now here's the tea: three field names are reserved and get used as message prefixes if they're defined:

• file — the name of a file
• key — the index inside a list
• field — the DEP12 field name

and one more that's a lil special: suggestion. Debian::DEP12 might use its value to replace the original, in an attempt to clean up the DEP12 entry. so she's not just decorative, she's got a job 💅

🌸 fields()

returns an array of the fields defined in the instance — in any order, so don't come for her about sorting 🫶

🌸 get( $field )

returns the value of a field. simple. iconic.

🌸 set( $field, $value )

sets a new value for a field, and returns the old value. so you always get the receipts back 🧾✨

🌸 delete( $field )

unsets the value for a field, and also returns the old value. bye bestie, but here's what you were 👋

---

✨ AUTHORS ✨

Andrius Merkys, <merkys@cpan.org> 💜

---

heads up bestie: the suggestion field isn't just any old key — Debian::DEP12 may use it to replace the original while cleaning up the DEP12 entry, so treat it with main character respect 👑

---

and that's the whole page, fr fr 🌈 this was rendered by perl v5.40.0 on 2024-09-28, so go forth and validate, you absolute queen 👑💖