#!perl

use 5.010;
use strict;
use warnings;

use App::ProgUtils;
use Perinci::CmdLine::Any;

our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2023-12-03'; # DATE
our $DIST = 'App-ProgUtils'; # DIST
our $VERSION = '0.204'; # VERSION

our %SPEC;

$SPEC{scriptlist} = {
    v => 1.1,
    summary => 'List scripts matching query',
    description => <<'MARKDOWN',

Basically like <prog:proglist>, except binaries are excluded.

Note: as of v0.204, `proglist` also sports a `--type` option to filter out
scripts or binaries.

MARKDOWN
    args => {
        query => {
            schema => 're*',
            req => 0,
            pos => 0,
        },
    },
    examples => [
        {
            summary => 'List all scripts that have "csv" in their name',
            argv => [qw/csv/],
            test => 0,
            'x.doc.show_result'=>0,
        },
        {
            summary => 'List all scripts',
            argv => [],
            test => 0,
            'x.doc.show_result'=>0,
        },
    ],
    links => [
    ],
};
sub scriptlist {
    require File::Which;

    my %args = @_;

    my $re = $args{query} || qr//;

    my @res;
    for my $dir (split /:/, $ENV{PATH}) {
        opendir my $dh, $dir or next;
        for my $e (readdir $dh) {
            next if $e eq '.' || $e eq '..';
            next if -d $e;
            next unless $e =~ $re;
            next if -B "$dir/$e";
            push @res, $e;
        }
    }
    [200, "OK", \@res];
}

Perinci::CmdLine::Any->new(
    url => '/main/scriptlist',
    read_config => 0,
    read_env => 0,
)->run;

# ABSTRACT: List scripts matching query
# PODNAME: scriptlist

__END__

=pod

=encoding UTF-8

=head1 NAME

scriptlist - List scripts matching query

=head1 VERSION

This document describes version 0.204 of scriptlist (from Perl distribution App-ProgUtils), released on 2023-12-03.

=head1 SYNOPSIS

B<scriptlist> B<L<--help|/"--help, -h, -?">> (or B<L<-h|/"--help, -h, -?">>, B<L<-?|/"--help, -h, -?">>)

B<scriptlist> B<L<--version|/"--version, -v">> (or B<L<-v|/"--version, -v">>)

B<scriptlist> [B<L<--format|/"--format=s">>=I<name>|B<L<--json|/"--json">>] [B<L<--(no)naked-res|/"--naked-res">>] [B<L<--page-result|/"--page-result">>[=I<program>]|B<L<--view-result|/"--view-result">>[=I<program>]] -- [I<L<query|/"--query=s">>]



See examples in the L</EXAMPLES> section.

=head1 DESCRIPTION

Basically like L<proglist>, except binaries are excluded.

Note: as of v0.204, C<proglist> also sports a C<--type> option to filter out
scripts or binaries.

=head1 OPTIONS

C<*> marks required options.

=head2 Main options

=over

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

(No description)


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

=back

=head2 Output options

=over

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

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

Default value:

 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.


=item B<--json>

Set output format to json.

=item B<--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
C<--naked-res> so you just get:

 [1,2,3]


=item B<--page-result>

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. C<less> is chosen.


=item B<--view-result>

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.


=back

=head2 Other options

=over

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

Display help message and exit.

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

Display program's version and exit.

=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 scriptlist scriptlist

in your bash startup (e.g. F<~/.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 L<cpanm-shcompgen>
which can activate shell completion for scripts immediately.

=head2 tcsh

To activate tcsh completion for this script, put:

 complete scriptlist 'p/*/`scriptlist`/'

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

=head2 other shells

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

=head1 EXAMPLES

=head2 List all scripts that have "csv" in their name

 % scriptlist csv

=head2 List all scripts

 % scriptlist

=head1 HOMEPAGE

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

=head1 SOURCE

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

=head1 AUTHOR

perlancar <perlancar@cpan.org>

=head1 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 L<Dist::Zilla>,
L<Dist::Zilla::PluginBundle::Author::PERLANCAR>,
L<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.

=head1 COPYRIGHT AND LICENSE

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

=head1 BUGS

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

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.

=cut