/ 
Perinci-Sub-XCompletion-0.105
River stage two • 11 direct dependents • 28 total dependents
/ Perinci::Sub::XCompletion::comma_sep

NAME

Perinci::Sub::XCompletion::comma_sep - Generate completion for completing a comma-separated list of other completion

VERSION

This document describes version 0.105 of Perinci::Sub::XCompletion::comma_sep (from Perl distribution Perinci-Sub-XCompletion), released on 2023-11-18.

SYNOPSIS

In argument specification of your Rinci function metadata:

# complete a comma-separated list of unix users
'x.completion' => [comma_sep => {xcompletion => 'unix_user'}],

# complete an argument in the form of FILENAME,UNIX_USER,WORDLIST_MODULE_NAME
'x.completion' => [comma_sep => {xcompletions => ['filename', 'unix_user', [perl_modname => {ns_prefix=>"WordList"}]]}],

DESCRIPTION

This completion lets you string several completions together in a comma-separated list.

PARAMETERS

xcompletion

The Perinci::Sub::XCompletion::* module name, without the prefix, to generate completion for all the items ih the comma-separated list. Or, a 2-element array containing module name and hash of parameters for the module.

Examples:

xcompletion => 'unix_user',
xcompletion => [perl_modname => {ns_prefix=>"WordList"}],

Either this parameter or "xcompletions" must be specified.

xcompletions

An array containing list of completions to generate for each corresponding item in the comma-separated list. Each element of the xcompletions list should be the Perinci::Sub::XCompletion::* module name without the prefix, or a 2-element array containing module name and hash of parameters for the module.

Example:

xcompletions => ['filename', 'unix_user', [perl_modname => {ns_prefix=>"WordList"}]],

Either this parameter or "xcompletion" must be specified.

FUNCTIONS

gen_completion

Usage:

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

This function is not exported.

No arguments.

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: (any)

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Perinci-Sub-XCompletion.

SOURCE

Source repository is at https://github.com/perlancar/perl-Perinci-Sub-XCompletion.

SEE ALSO

Complete::Sequence

AUTHOR

perlancar <perlancar@cpan.org>

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) 2023, 2022, 2019, 2017, 2016, 2015 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=Perinci-Sub-XCompletion

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.