sago35 / getopt-kingpin Goto Github PK

Normally, human-readable command output is newline-terminated. Kingpin's error messages are not. Popular shells don't take it very well: bash shows its prompt after the non-terminated line, and zsh (version 5.4.2 in Nixos) somehow "eats" the non-terminated line, thus hiding the error message completely.

Hi,

excellent work...

Any ideas about automatic support for shell completion?

Thanks,

For arguments like this:

myscript.pl command --define os=linux --define arch=amd64

And $flag->values should return:

{
  "os" => "linux",
  "arch" => "amb64",
}

Getopt::Long supports this. If you think this would be a useful feature, I would be happy to send you a patch.

Instead of scalar.

In japanese windows, file paths encoding is cp932.
When you want to use file with default value,

1. Default value with cp932 encoding is works good for Path::Tiny, but help() can't read.
2. with flagged utf8, help() can read. But Path::Tiny does not work.

current : sort {$a->name ne "help" || $a->name cmp $b->name} $self->flags->values

call die instead of croak.

$kingpin->parse parses @ARGV but $kingpin->parse(@args) parses @args... except if @args is an empty array, in which case it parses @ARGV even though that's not what you asked it to do.

If parse took an arrayref, then it would be easier for parse to tell if you wanted it to parse your array or parse @ARGV.

$kingpin->parse( \@args ); # parse @args 
$kingpin->parse( [] );     # parse an empty array
$kingpin->parse;           # parse @ARGV 

But Getopt::Kingpin has already existed for four years, so it is probably too late to change the behaviour of parse. Instead I think a separate method called parse_array should be added and parse should be... not quite deprecated but discouraged.

This is kingpin's README.md.

Place-holders in Help

The place-holder value for a flag is the value used in the help to describe
the value of a non-boolean flag.

The value provided to PlaceHolder() is used if provided, then the value
provided by Default() if provided, then finally the capitalised flag name is
used.

Here are some examples of flags with various permutations:

--name=NAME           // Flag(...).String()
--name="Harry"        // Flag(...).Default("Harry").String()
--name=FULL-NAME      // flag(...).PlaceHolder("FULL-NAME").Default("Harry").String()

For example, sometimes we want to hide a flag that is only used for debug.

For me, it would be useful if Getopt::Kingpin supported "lazy" defaults like Moo/Moose attributes do. So, for example:

$command->flag("email", "Email address")->default(sub { ... })->string;

Looking up the email address might be an expensive operation; it might need a database lookup for example. The coderef would only be called if the user does not provide --email=something on the command line.

It would allow things like:

$command->flag("email", "Email address")->default(sub {
  print STDERR "Please provide an email address!\n";
  chomp( my $email = <STDIN> );
  return $email;
})->string;

I can provide a PR if you think this is a useful feature which you would be likely to accept.