Help language development. Donate to The Perl Foundation

as-cli-arguments zef:lizmat last updated on 2022-09-18

597f9e0fa3a9aed4d01997c2667f961a06a11507/

Actions Status

NAME

as-cli-arguments - stringify a Capture as command-line arguments

SYNOPSIS

use as-cli-arguments;
sub MAIN(|c) { say as-cli-arguments c, :named-anywhere }
use as-cli-arguments;
my %*SUB-MAIN-OPTS = :named-anywhere;
sub MAIN(|c) { say as-cli-arguments c }

sub MAIN(*@pos, :$foo, :$bar, *%_) {
    die "Found unexpected named arguments: &as-cli-arguments(%_)"
      if %_;
}
say as-cli-arguments { :42a, :666b }  # --a=42 --b=666

say as-cli-arguments (:42a, :666b)    # --a=42 --b=666

say as-cli-arguments "a" => 42;       # --a=42

DESCRIPTION

as-cli-arguments exports a single subroutine as-cli-arguments that takes either a Capture object, a hash with named arguments, a Pair or a list of Pairs and returns a string that represents the contents of the argument given as if they were command line arguments.

If a Capture object is specified, then the subroutine also takes an optional named arguments :named-anywhere to indicate whether or not the "named arguments anywhere" mode should be assumed. By default, this will use the %*SUB-MAIN-OPTS<named-anywhere> setting, if available. Else it will default to False.

This is mainly intended as a helper subroutine for command-line scripts and modules that want to give feedback about the given or perceived or unexpected command line parameters.

AUTHOR

Elizabeth Mattijsen [email protected]

Source can be located at: https://github.com/lizmat/as-cli-arguments . Comments and Pull Requests are welcome.

If you like this module, or what I’m doing more generally, committing to a small sponsorship would mean a great deal to me!

COPYRIGHT AND LICENSE

Copyright 2022 Elizabeth Mattijsen

This library is free software; you can redistribute it and/or modify it under the Artistic License 2.0.