/ 
Complete-Fish-Gen-FromGetoptLong-0.100
River stage one • 4 direct dependents • 8 total dependents
/ Complete::Fish::Gen::FromGetoptLong

NAME

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

VERSION

This document describes version 0.100 of Complete::Fish::Gen::FromGetoptLong (from Perl distribution Complete-Fish-Gen-FromGetoptLong), released on 2022-08-11.

SYNOPSIS

FUNCTIONS

gen_fish_complete_from_getopt_long_script

Usage:

gen_fish_complete_from_getopt_long_script(%args) -> [$status_code, $reason, $payload, \%result_meta]

Generate fish completion script from Getopt::Long script.

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

Getopt::Long::Complete scripts are also supported.

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_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.

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

gen_fish_complete_from_getopt_long_spec

Usage:

gen_fish_complete_from_getopt_long_spec(%args) -> [$status_code, $reason, $payload, \%result_meta]

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

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.

  • opt_desc => hash

    Description for each option.

    This is optional and allows adding description for the complete command. Each key of the hash should correspond to the option name without the dashes, e.g. s, long.

  • spec* => hash

    Getopt::Long options specification.

Returns an enveloped result (an array).

First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.

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-FromGetoptLong.

SOURCE

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

SEE ALSO

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTOR

Steven Haryanto <stevenharyanto@gmail.com>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

% prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2022, 2016, 2015, 2014 by perlancar <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.

BUGS

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

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.