DOKK / manpages / debian 12 / libmoosex-app-perl / MooseX::App::Meta::Role::Attribute::Option.3pm.en
MooseX::App::Meta::Role::Attribute::Option(3pm) User Contributed Perl Documentation MooseX::App::Meta::Role::Attribute::Option(3pm)

MooseX::App::Meta::Role::Attribute::Option - Meta attribute role for options

This meta attribute role will automatically be applied to all attributes that should be used as options.

In your app and command classes you can use the following attributes in option or parameter definitions.

 option 'myoption' => (
     is                 => 'rw',
     isa                => 'ArrayRef[Str]',
     documentation      => 'My special option',
     cmd_flag           => 'myopt',
     cmd_aliases        => [qw(mopt localopt)],
     cmd_tags           => [qw(Important!)],
     cmd_env            => 'MY_OPTION',
     cmd_position       => 1,
     cmd_split          => qr/,/,
     cmd_negate         => 'notoption'
 );

Use this name instead of the attribute name as the option name

Option to mark if this attribute should be used as an option or parameter value.

Allowed values are:

  • option - Command line option
  • proto - Command line option that should be processed prior to other options (eg. a config-file option that sets other attribues) Usually only used for plugin developmemt
  • parameter - Positional parameter command line value

Environment variable name (only uppercase letters, numeric and underscores allowed). If variable was not specified otherwise the value will be taken from %ENV.

Arrayref of alternative option names

Extra option tags displayed in the usage information (in brackets)

Override the order of the parameters in the usage message.

Splits multiple values at the given separator string or regular expression. Only works in conjunction with an 'ArrayRef[*]' type constraint. ie. '--myattr value1,value2' with cmd_split set to ',' would produce an arrayref with to elements.

Similar to the Getopt::Long '+' modifier, cmd_count turns the attribute into a counter. Every occurrence of the attribute in @ARGV (without any value) would increment the resulting value by one

Sets names for the negated variant of a boolean field. Only works in conjunction with a 'Bool' type constraint.

These methods are only of interest to plugin authors.

Runs sanity checks on options and parameters. Will usually only be executed if either HARNESS_ACTIVE or APP_DEVELOPER environment are set.

 my @names = $attribute->cmd_name_possible();

Returns a list of all possible option names.

 my @names = $attribute->cmd_name_list();

Similar to cmd_name_possible this method returns a list of option names, except for names set via cmd_negate.

 my $name = $attribute->cmd_name_primary();

Returns the primary option name

 my $name = $attribute->cmd_usage_name();

Returns the name as used by the usage text

 my $name = $attribute->cmd_usage_description();

Returns the description as used by the usage text

 my @tags = $attribute->cmd_tags_list();

Returns a list of tags

 $attribute->cmd_type_constraint_check($value)

Checks the type constraint. Returns an error message if the check fails

 $attribute->cmd_type_constraint_description($type_constraint,$singular)

Creates a description of the selected type constraint.

2022-10-16 perl v5.34.0