/ 
App-ZshCompleteUtils-0.002
River stage one • 1 direct dependent • 1 total dependent
/ gen-zsh-complete-from-getopt-long-descriptive-script

NAME

gen-zsh-complete-from-getopt-long-descriptive-script - Generate zsh completion script from Getopt::Long::Descriptive script

VERSION

This document describes version 0.002 of gen-zsh-complete-from-getopt-long-descriptive-script (from Perl distribution App-ZshCompleteUtils), released on 2021-05-25.

SYNOPSIS

Usage:

% gen-zsh-complete-from-getopt-long-descriptive-script [-D] [--cmdname=s]
    [--compname=s] [--config-path=path | -c] [--config-profile=profile |
    -P] [--format=name] [--json] [--(no)naked-res] [--no-config | -C]
    [--no-env] [--page-result[=program]] [--skip-detect]
    [--view-result[=program]] <filename>

DESCRIPTION

This routine generate zsh completion script for each short/long option, enabling zsh to be aware of each option.

OPTIONS

* marks required options.

Main options

--cmdname=s

Command name to be completed, defaults to filename.

--compname=s

Completer name.

--filename=s*, -f

Can also be specified as the 1st command-line argument.

--skip-detect, -D

Configuration options

--config-path=s, -c

Set path to configuration file.

--config-profile=s, -P

Set configuration profile to use.

--no-config, -C

Do not use any configuration file.

Environment options

--no-env

Do not read environment for default options.

Output options

--format=s

Choose output format, e.g. json, text.

Default value:

undef
--json

Set output format to json.

--naked-res

When outputing as JSON, strip result envelope.

Default value:

0

By default, when outputing as JSON, the full enveloped result is returned, e.g.:

[200,"OK",[1,2,3],{"func.extra"=>4}]

The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:

[1,2,3]
--page-result

Filter output through a pager.

--view-result

View output using a viewer.

Other options

--help, -h, -?

Display help message and exit.

--version, -v

Display program's version and exit.

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

complete -C gen-zsh-complete-from-getopt-long-descriptive-script gen-zsh-complete-from-getopt-long-descriptive-script

in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.

tcsh

To activate tcsh completion for this script, put:

complete gen-zsh-complete-from-getopt-long-descriptive-script 'p/*/`gen-zsh-complete-from-getopt-long-descriptive-script`/'

in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is also recommended to install shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

CONFIGURATION FILE

This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.

By default, these names are searched for configuration filenames (can be changed using --config-path): ~/.config/gen-zsh-complete-from-getopt-long-descriptive-script.conf, ~/gen-zsh-complete-from-getopt-long-descriptive-script.conf, or /etc/gen-zsh-complete-from-getopt-long-descriptive-script.conf.

All found files will be read and merged.

To disable searching for configuration files, pass --no-config.

You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.

You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [SOMESECTION program=NAME]. The section will then only be used when the reading program matches.

You can also filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable equals some string: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal some string: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when the value of an environment variable includes some string: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. If you only want a section to be read when the value of an environment variable does not include some string: [env=HOSTNAME!*=server ...] or [SOMESECTION env=HOSTNAME!*=server ...]. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.

To load and configure plugins, you can use either the -plugins parameter (e.g. -plugins=DumpArgs or -plugins=DumpArgs@before_validate_args), or use the [plugin=NAME ...] sections, for example:

[plugin=DumpArgs]
-event=before_validate_args
-prio=99

[plugin=Foo]
-event=after_validate_args
arg1=val1
arg2=val2

which is equivalent to setting -plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2.

List of available configuration parameters:

cmdname (see --cmdname)
compname (see --compname)
filename (see --filename)
format (see --format)
naked_res (see --naked-res)
skip_detect (see --skip-detect)

ENVIRONMENT

GEN_ZSH_COMPLETE_FROM_GETOPT_LONG_DESCRIPTIVE_SCRIPT_OPT => str

Specify additional command-line options.

FILES

~/.config/gen-zsh-complete-from-getopt-long-descriptive-script.conf

~/gen-zsh-complete-from-getopt-long-descriptive-script.conf

/etc/gen-zsh-complete-from-getopt-long-descriptive-script.conf

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-ZshCompleteUtils.

SOURCE

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

BUGS

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

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.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2021, 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.