NAME

Complete::Fish::Gen::FromGetoptLongDescriptive - Generate fish completion script from Getopt::Long::Descriptive spec/script

VERSION

This document describes version 0.001 of Complete::Fish::Gen::FromGetoptLongDescriptive (from Perl distribution Complete-Fish-Gen-FromGetoptLongDescriptive), released on 2016-10-27.

SYNOPSIS

FUNCTIONS

gen_fish_complete_from_getopt_long_descriptive_script(%args) -> [status, msg, result, meta]

Generate fish completion script from Getopt::Long::Descriptive script.

This routine generate fish complete command for each short/long option, enabling fish to display the options in a different color.

This function is not exported by default, but exportable.

Arguments ('*' denotes required arguments):

• cmdname => str

  Command name to be completed, defaults to filename.

• compname => str

  Completer name.

• filename* => filename

• skip_detect => bool

Returns an enveloped result (an array).

First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: A script that can be fed to the fish shell (str)

gen_fish_complete_from_getopt_long_descriptive_spec(%args) -> [status, msg, result, meta]

From Getopt::Long::Descriptive spec, generate tab completion commands for the fish shell.

This routine generate fish complete command for each short/long option, enabling fish to display the options in a different color.

This function is not exported by default, but exportable.

Arguments ('*' denotes required arguments):

• cmdname* => str

  Command name to be completed.

• compname => str

  Completer name, if there is a completer for option values.

• spec* => array

  Getopt::Long::Descriptive specification.

Returns an enveloped result (an array).

First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: A script that can be fed to the fish shell (str)

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Complete-Fish-Gen-FromGetoptLongDescriptive.

SOURCE

Source repository is at https://github.com/perlancar/perl-Complete-Fish-Gen-FromGetoptLongDescriptive.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Complete-Fish-Gen-FromGetoptLongDescriptive

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

SEE ALSO

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2016 by perlancar@cpan.org.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

cpanm Complete::Fish::Gen::FromGetoptLongDescriptive

perl -MCPAN -e shell
install Complete::Fish::Gen::FromGetoptLongDescriptive