MouseX...:Trait(3pm)

💖 MouseX::Getopt::Meta::Attribute::Trait(3pm) 💖

okay so bestie, this is a page from the User Contributed Perl Documentation, and it's all about MouseX::Getopt::Meta::Attribute::Trait — the optional meta attribute trait that lets you name your own command line options instead of letting the computer pick for you. she's giving custom option names and honestly? iconic. 👑

---

✨ NAME ✨

MouseX::Getopt::Meta::Attribute::Trait — optional meta attribute trait for custom option names 💅

---

🌸 SYNOPSIS 🌸

package App;
use Mouse;

with 'MouseX::Getopt';

has 'data' => (
    traits    => [ 'Getopt' ],
    is        => 'ro',
    isa       => 'Str',
    default   => 'file.dat',

    # tells MouseX::Getopt to use --somedata as the
    # command line flag instead of the normal
    # autogenerated one (--data)
    cmd_flag  => 'somedata',

    # tells MouseX::Getopt to also allow --moosedata,
    # -m, and -d as aliases for this same option on
    # the commandline.
    cmd_aliases => [qw/ moosedata m d /],

    # Or, you can use a plain scalar for a single alias:
    cmd_aliases => 'm',
);

like. look at her. she's literally telling MouseX::Getopt "no babe, I pick the flag name" and MouseX::Getopt is like "okay periodt" 🫶

---

🦋 DESCRIPTION 🦋

This is a custom attribute metaclass trait, and what it does is let you specify the specific command line flag to use — instead of the default one that MouseX::Getopt would just... make up for you. rude of it, honestly. so you take the wheel. 🎀

⭐ cmd_flag

Changes the commandline flag to be this value, instead of the default — and the default is literally just the same as the attribute name. no cap. so if you don't set this, your attribute name is your flag. that's the whole vibe.

🌈 cmd_aliases

Adds more aliases for this commandline flag! super useful for short options and such — you know, the little single-letter guys. one flag, many names. main character energy, she contains multitudes. 💜

🧚 has_cmd_flag

🧚 has_cmd_aliases

(yes bestie, those two are just... listed. they exist. the manpage says so and I do not make the rules. 🌸)

---

🫶 reminder: don't sleep on cmd_aliases — a plain scalar gets you one alias, and an arrayref like [qw/ moosedata m d /] gets you the whole squad. pick your fighter.

---

and that's the whole page, bestie!! you ate. no crumbs left. 💅✨

this was perl v5.32.1, dated 2021-09-16 — shouting out the source and the date, mwah 🎀