/ 
App-CompleteCLIs-0.150
River stage one • 1 direct dependent • 1 total dependent
/ complete-array-elem

NAME

complete-array-elem - Complete from array

VERSION

This document describes version 0.150 of complete-array-elem (from Perl distribution App-CompleteCLIs), released on 2021-05-09.

SYNOPSIS

Usage:

% complete-array-elem [--debug] [--exclude-json=s] [--exclude=s]
    [--format=name] [--json] [--log-level=level] [--(no)naked-res]
    [--page-result[=program]] [--quiet] [--replace-map-json=s]
    [--replace-map=s] [--summaries-json=s] [--summaries=s+] [--trace]
    [--verbose] [--view-result[=program]] <word> <array> ...

DESCRIPTION

Try to find completion from an array of strings. Will attempt several methods, from the cheapest and most discriminating to the most expensive and least discriminating.

First method is normal/exact string prefix matching (either case-sensitive or insensitive depending on the $Complete::Common::OPT_CI variable or the COMPLETE_OPT_CI environment variable). If at least one match is found, return result. Else, proceed to the next method.

Word-mode matching (can be disabled by setting $Complete::Common::OPT_WORD_MODE or COMPLETE_OPT_WORD_MODE environment varialbe to false). Word-mode matching is described in Complete::Common. If at least one match is found, return result. Else, proceed to the next method.

Prefix char-mode matching (can be disabled by settings $Complete::Common::OPT_CHAR_MODE or COMPLETE_OPT_CHAR_MODE environment variable to false). Prefix char-mode matching is just like char-mode matching (see next paragraph) except the first character must match. If at least one match is found, return result. Else, proceed to the next method.

Char-mode matching (can be disabled by settings $Complete::Common::OPT_CHAR_MODE or COMPLETE_OPT_CHAR_MODE environment variable to false). Char-mode matching is described in Complete::Common. If at least one match is found, return result. Else, proceed to the next method.

Fuzzy matching (can be disabled by setting $Complete::Common::OPT_FUZZY or COMPLETE_OPT_FUZZY to false). Fuzzy matching is described in Complete::Common. If at least one match is found, return result. Else, return empty string.

Will sort the resulting completion list, so you don't have to presort the array.

OPTIONS

* marks required options.

Main options

--array-json=s

See --array.

Can also be specified as the 2nd command-line argument and onwards.

--array=s@*

Can also be specified as the 2nd command-line argument and onwards.

Can be specified multiple times.

--exclude-json=s

See --exclude.

--exclude=s
--summaries-json=s

See --summaries.

--summaries=s@

Can be specified multiple times.

--word=s*

Word to complete.

Default value:

""

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

Logging options

--debug

Shortcut for --log-level=debug.

--log-level=s

Set log level.

--quiet

Shortcut for --log-level=error.

--trace

Shortcut for --log-level=trace.

--verbose

Shortcut for --log-level=info.

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.

--replace-map-json=s

See --replace-map.

--replace-map=s

You can supply correction entries in this option. An example is when array if `['mount','unmount']` and `umount` is a popular "typo" for `unmount`. When someone already types `um` it cannot be completed into anything (even the current fuzzy mode will return *both* so it cannot complete immediately).

One solution is to add replace_map `{'unmount'=>['umount']}`. This way, `umount` will be regarded the same as `unmount` and when user types `um` it can be completed unambiguously into `unmount`.

--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 complete-array-elem complete-array-elem

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 complete-array-elem 'p/*/`complete-array-elem`/'

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.

HOMEPAGE

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

SOURCE

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

BUGS

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

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, 2020, 2019, 2017, 2016, 2015, 2014 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.