complete-array-elem - Complete from array
This document describes version 0.153 of complete-array-elem (from Perl distribution App-CompleteCLIs), released on 2023-12-01.
complete-array-elem --help (or -h, -?)
complete-array-elem --version (or -v)
complete-array-elem [--debug|--log-level=level|--quiet|--trace|--verbose] [--exclude=s|--exclude-json=json] [--format=name|--json] [--(no)naked-res] [--page-result[=program]|--view-result[=program]] [--replace-map=s|--replace-map-json=json] [(--summaries=str)+|--summaries-json=json] -- <word> <array> ...
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.
$Complete::Common::OPT_CI
COMPLETE_OPT_CI
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.
$Complete::Common::OPT_WORD_MODE
COMPLETE_OPT_WORD_MODE
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.
$Complete::Common::OPT_CHAR_MODE
COMPLETE_OPT_CHAR_MODE
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.
$Complete::Common::OPT_FUZZY
COMPLETE_OPT_FUZZY
Will sort the resulting completion list, so you don't have to presort the array.
* marks required options.
*
See --array.
--array
Can also be specified as the 2nd command-line argument and onwards.
(No description)
Can be specified multiple times.
See --exclude.
--exclude
See --summaries.
--summaries
Word to complete.
Default value:
""
Can also be specified as the 1st command-line argument.
Shortcut for --log-level=debug.
Set log level.
By default, these log levels are available (in order of increasing level of importance, from least important to most): trace, debug, info, warn/warning, error, fatal. By default, the level is usually set to warn, which means that log statements with level info and less important levels will not be shown. To increase verbosity, choose info, debug, or trace.
trace
debug
info
warn
warning
error
fatal
For more details on log level and logging, as well as how new logging levels can be defined or existing ones modified, see Log::ger.
Shortcut for --log-level=error.
Shortcut for --log-level=trace.
Shortcut for --log-level=info.
Choose output format, e.g. json, text.
undef
Output can be displayed in multiple formats, and a suitable default format is chosen depending on the application and/or whether output destination is interactive terminal (i.e. whether output is piped). This option specifically chooses an output format.
Set output format to json.
When outputing as JSON, strip result envelope.
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:
--naked-res
[1,2,3]
Filter output through a pager.
This option will pipe the output to a specified pager program. If pager program is not specified, a suitable default e.g. less is chosen.
less
View output using a viewer.
This option will first save the output to a temporary file, then open a viewer program to view the temporary file. If a viewer program is not chosen, a suitable default, e.g. the browser, is chosen.
Display help message and exit.
See --replace-map.
--replace-map
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).
['mount','unmount']
umount
unmount
um
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.
{'unmount'=>['umount']}
Display program's version and exit.
This script has shell tab completion capability with support for several shells.
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.
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).
For fish and zsh, install shcompgen as described above.
Please visit the project's homepage at https://metacpan.org/release/App-CompleteCLIs.
Source repository is at https://github.com/perlancar/perl-App-CompleteCLIs.
perlancar <perlancar@cpan.org>
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.
This software is copyright (c) 2023, 2021, 2020, 2019, 2017, 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.
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.
To install App::CompleteCLIs, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::CompleteCLIs
CPAN shell
perl -MCPAN -e shell install App::CompleteCLIs
For more information on module installation, please visit the detailed CPAN module installation guide.