/ 
App-GenPericmdCompleterScript-0.126
River stage one • 3 direct dependents • 3 total dependents
/ App::GenPericmdCompleterScript

NAME

App::GenPericmdCompleterScript - Generate Perinci::CmdLine completer script

VERSION

This document describes version 0.126 of App::GenPericmdCompleterScript (from Perl distribution App-GenPericmdCompleterScript), released on 2023-07-11.

FUNCTIONS

gen_pericmd_completer_script

Usage:

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

Generate Perinci::CmdLine completer script.

This function is not exported by default, but exportable.

Arguments ('*' denotes required arguments):

  • completion => code

    (No description)

  • default_subcommand => str

    (No description)

  • exclude_package_functions_match => re

    Exclude package functions matching this pattern.

  • get_subcommand_from_arg => int (default: 1)

    (No description)

  • include_package_functions_match => re

    Only include package functions matching this pattern.

  • interpreter_path => str

    What to put on shebang line.

  • load_module => array[str]

    Load extra modules.

  • output_file => filename (default: "-")

    Path to output file.

  • overwrite => bool (default: 0)

    Whether to overwrite output if previously exists.

  • per_arg_json => bool

    (No description)

  • per_arg_yaml => bool

    (No description)

  • program_name* => str

    Program name that is being completed.

  • read_config => bool

    (No description)

  • read_env => bool

    (No description)

  • skip_format => bool

    (No description)

  • strip => bool (default: 0)

    Whether to strip source code using Perl::Stripper.

  • subcommands => hash

    Hash of subcommand names and function URLs.

    Optionally, it can be additionally followed by a summary, so:

    URL[:SUMMARY]

    Example (on CLI):

    --subcommand "delete=/My/App/delete_item:Delete an item"

  • subcommands_from_package_functions => bool

    Form subcommands from functions under package's URL.

    This is an alternative to the subcommand option. Instead of specifying each subcommand's name and URL, you can also specify that subcommand names are from functions under the package URL in url. So for example if url is /My/App/, hen all functions under /My/App are listed first. If the functions are:

    foo
bar
baz_qux

    then the subcommands become:

    foo => /My/App/foo
bar => /My/App/bar
"baz-qux" => /My/App/baz_qux

  • url* => riap::url

    URL to function (or package, if you have subcommands).

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/App-GenPericmdCompleterScript.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-GenPericmdCompleterScript.

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, 2021, 2020, 2018, 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=App-GenPericmdCompleterScript

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.