#!perl

# Note: This script is a CLI interface to Riap function /Complete/Module/complete_module
# and generated automatically using App::GenPericmdScript version 0.13

our $DATE = '2015-08-19'; # DATE
our $DIST = 'App-CompleteCLIs'; # DIST
our $VERSION = '0.04'; # VERSION

use 5.010001;
use strict;
use warnings;

use Perinci::CmdLine::Any;

Perinci::CmdLine::Any->new(
    url => "/Complete/Module/complete_module",
)->run;

# ABSTRACT: Complete with installed Perl module names
# PODNAME: complete-module

__END__

=pod

=encoding UTF-8

=head1 NAME

complete-module - Complete with installed Perl module names

=head1 VERSION

This document describes version 0.04 of complete-module (from Perl distribution App-CompleteCLIs), released on 2015-08-19.

=head1 SYNOPSIS

Usage:

 % complete-module [options] <word>

=head1 DESCRIPTION

For each directory in C<@INC> (coderefs are ignored), find Perl modules and
module prefixes which have C<word> as prefix. So for example, given C<Te> as
C<word>, will return e.g. C<[Template, Template::, Term::, Test, Test::, Text::]>.
Given C<Text::> will return C<[Text::ASCIITable, Text::Abbrev, ...]> and so on.

This function has a bit of overlapping functionality with C<Module::List>, but
this function is geared towards shell tab completion. Compared to
C<Module::List>, here are some differences: 1) list modules where prefix is
incomplete; 2) interface slightly different; 3) (currently) doesn't do
recursing; 4) contains conveniences for completion, e.g. map casing, expand
intermediate paths (see C<Complete> for more details on those features),
autoselection of path separator character, some shortcuts, and so on.

=head1 OPTIONS

C<*> marks required options.

=head2 Configuration options

=over

=item B<--config-path>=I<filename>

{en_US Set path to configuration file}.

Can be specified multiple times.

=item B<--config-profile>=I<s>

{en_US Set configuration profile to use}.

=item B<--no-config>

{en_US Do not use any configuration file}.

=back

=head2 Environment options

=over

=item B<--no-env>

{en_US Do not read environment for default options}.

=back

=head2 Output options

=over

=item B<--format>=I<s>

{en_US Choose output format, e.g. json, text}.

Default value:

 undef

=item B<--json>

{en_US Set output format to json}.

=item B<--naked-res>

{en_US When outputing as JSON, strip result envelope}.

Default value:

 0

{en_US 
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]
}


=back

=head2 Other options

=over

=item B<--ci>

{en_US Whether to do case-insensitive search}.

=item B<--dig-leaf-json>=I<s>

{en_US bool} (JSON-encoded).

See C<--dig-leaf>.

=item B<--dig-leaf>=I<s>

{en_US bool}.

=item B<--exp-im-path>

=item B<--help>, B<-h>, B<-?>

{en_US Display help message and exit}.

=item B<--map-case>

=item B<--no-find-pm>

=item B<--no-find-pmc>

=item B<--no-find-pod>

=item B<--no-find-prefix>

=item B<--ns-prefix>=I<s>

{en_US Namespace prefix}.

{en_US 
This is useful if you want to complete module under a specific namespace
(instead of the root). For example, if you set `ns_prefix` to
`Dist::Zilla::Plugin` (or `Dist::Zilla::Plugin::`) and word is `F`, you can get
`['FakeRelease', 'FileFinder::', 'FinderCode']` (those are modules under the
`Dist::Zilla::Plugin::` namespace).
}


=item B<--path-sep>=I<s>

{en_US Path separator}.

{en_US 
For convenience in shell (bash) completion, instead of defaulting to `::` all
the time, will look at `word`. If word does not contain any `::` then will
default to `/`. This is because `::` (contains colon) is rather problematic as
it is by default a word-break character in bash and the word needs to be quoted
to avoid word-breaking by bash.
}


=item B<--version>, B<-v>

{en_US Display program's version and exit}.

=item B<--word>=I<s>*

=back

=head1 COMPLETION

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

=head2 bash

To activate bash completion for this script, put:

 complete -C complete-module complete-module

in your bash startup (e.g. C<~/.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 L<shcompgen> which allows you to
activate completion scripts for several kinds of scripts on multiple shells.
Some CPAN distributions (those that are built with
L<Dist::Zilla::Plugin::GenShellCompletion>) will even automatically enable shell
completion for their included scripts (using C<shcompgen>) at installation time,
so you can immadiately have tab completion.

=head2 tcsh

To activate tcsh completion for this script, put:

 complete complete-module 'p/*/`complete-module`/'

in your tcsh startup (e.g. C<~/.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 C<shcompgen> (see above).

=head2 other shells

For fish and zsh, install C<shcompgen> as described above.

=head1 ENVIRONMENT

=head2 COMPLETE_MODULE_OPT => str

Specify additional command-line options

=head1 CONFIGURATION FILE

This script can read configuration file, which by default is searched at C<~/.config/complete-module.conf>, C<~/complete-module.conf> or C</etc/complete-module.conf> (can be changed by specifying C<--config-path>). All found files will be read and merged.

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

Configuration file is in the format of L<IOD>, which is basically INI with some extra features. 

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

List of available configuration parameters:

 ci (see --ci)
 dig_leaf (see --dig-leaf)
 exp_im_path (see --exp-im-path)
 find_pm (see --no-find-pm)
 find_pmc (see --no-find-pmc)
 find_pod (see --no-find-pod)
 find_prefix (see --no-find-prefix)
 format (see --format)
 map_case (see --map-case)
 naked_res (see --naked-res)
 ns_prefix (see --ns-prefix)
 path_sep (see --path-sep)
 word (see --word)

=head1 FILES

~/.config/complete-module.conf

~/complete-module.conf

/etc/complete-module.conf

=head1 HOMEPAGE

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

=head1 SOURCE

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

=head1 BUGS

Please report any bugs or feature requests on the bugtracker website L<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.

=head1 AUTHOR

perlancar <perlancar@cpan.org>

=head1 COPYRIGHT AND LICENSE

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

=cut
