# Note: This script is a CLI for Riap function /App/ProveMods/prove_mods
# and generated automatically using Perinci::CmdLine::Gen version 0.493

our $DATE = '2020-03-07'; # DATE
our $DIST = 'App-ProveMods'; # DIST
our $VERSION = '0.001'; # VERSION

use 5.010001;
use strict;
use warnings;
use Log::ger;

use Perinci::CmdLine::Any;

my $cmdline = Perinci::CmdLine::Any->new(
    url => "/App/ProveMods/prove_mods",
    program_name => "prove-mods",
    log => 1,
    log_level => "info",


# ABSTRACT: Prove Perl modules' distributions
# PODNAME: prove-mods



=encoding UTF-8

=head1 NAME

prove-mods - Prove Perl modules' distributions

=head1 VERSION

This document describes version 0.001 of prove-mods (from Perl distribution App-ProveMods), released on 2020-03-07.



 % prove-mods [options] <module> ...


To use this utility, first create C<~/.config/prove-mods.conf>:

 dists_dirs = ~/repos
 dists_dirs = ~/repos-other

The above tells I<prove-mods> where to look for Perl distributions. Then:

 % prove-mods '^Regexp::Pattern.*'

This will search local CPAN mirror for all modules that match that regex
pattern, then search the distributions in the distribution directories (or
download them from local CPAN mirror), C<cd> to each and run C<prove> in it.

You can run with C<--dry-run> (C<-n>) option first to not actually run C<prove> but
just see what distributions will get tested. An example output:

 % prove-mods '^Regexp::Pattern' -n
 prove-mods: Found module: Regexp::Pattern (dist=Regexp-Pattern)
 prove-mods: Found module: Regexp::Pattern::CPAN (dist=Regexp-Pattern-CPAN)
 prove-mods: Found module: Regexp::Pattern::Example (dist=Regexp-Pattern)
 prove-mods: Found module: Regexp::Pattern::Git (dist=Regexp-Pattern-Git)
 prove-mods: Found module: Regexp::Pattern::JSON (dist=Regexp-Pattern-JSON)
 prove-mods: Found module: Regexp::Pattern::License (dist=Regexp-Pattern-License)
 prove-mods: Found module: Regexp::Pattern::License::Parts (dist=Regexp-Pattern-License)
 prove-mods: Found module: Regexp::Pattern::Net (dist=Regexp-Pattern-Net)
 prove-mods: Found module: Regexp::Pattern::OS (dist=Regexp-Pattern-OS)
 prove-mods: Found module: Regexp::Pattern::Path (dist=Regexp-Pattern-Path)
 prove-mods: Found module: Regexp::Pattern::RegexpCommon (dist=Regexp-Pattern-RegexpCommon)
 prove-mods: Found module: Regexp::Pattern::Test::re_engine (dist=Regexp-Pattern-Test-re_engine)
 prove-mods: Found module: Regexp::Pattern::Twitter (dist=Regexp-Pattern-Twitter)
 prove-mods: Found module: Regexp::Pattern::YouTube (dist=Regexp-Pattern-YouTube)
 prove-mods: Found dist: Regexp-Pattern
 prove-mods: Found dist: Regexp-Pattern-CPAN
 prove-mods: Found dist: Regexp-Pattern-Git
 prove-mods: Found dist: Regexp-Pattern-JSON
 prove-mods: Found dist: Regexp-Pattern-License
 prove-mods: Found dist: Regexp-Pattern-Net
 prove-mods: Found dist: Regexp-Pattern-OS
 prove-mods: Found dist: Regexp-Pattern-Path
 prove-mods: Found dist: Regexp-Pattern-RegexpCommon
 prove-mods: Found dist: Regexp-Pattern-Test-re_engine
 prove-mods: Found dist: Regexp-Pattern-Twitter
 prove-mods: Found dist: Regexp-Pattern-YouTube
 prove-mods: [DRY] [1/12] Running prove for distribution Regexp-Pattern (directory /home/u1/repos/perl-Regexp-Pattern) ...
 prove-mods: [DRY] [2/12] Running prove for distribution Regexp-Pattern-CPAN (directory /home/u1/repos/perl-Regexp-Pattern-CPAN) ...
 prove-mods: [DRY] [3/12] Running prove for distribution Regexp-Pattern-Git (directory /home/u1/repos/perl-Regexp-Pattern-Git) ...
 prove-mods: [DRY] [4/12] Running prove for distribution Regexp-Pattern-JSON (directory /home/u1/repos/perl-Regexp-Pattern-JSON) ...
 prove-mods: [DRY] [5/12] Running prove for distribution Regexp-Pattern-License (directory /tmp/hEa7jnla5M/Regexp-Pattern-License-v3.2.0) ...
 prove-mods: [DRY] [6/12] Running prove for distribution Regexp-Pattern-Net (directory /home/u1/repos/perl-Regexp-Pattern-Net) ...
 prove-mods: [DRY] [7/12] Running prove for distribution Regexp-Pattern-OS (directory /home/u1/repos/perl-Regexp-Pattern-OS) ...
 prove-mods: [DRY] [8/12] Running prove for distribution Regexp-Pattern-Path (directory /home/u1/repos/perl-Regexp-Pattern-Path) ...
 prove-mods: [DRY] [9/12] Running prove for distribution Regexp-Pattern-RegexpCommon (directory /home/u1/repos/perl-Regexp-Pattern-RegexpCommon) ...
 prove-mods: [DRY] [10/12] Running prove for distribution Regexp-Pattern-Test-re_engine (directory /home/u1/repos/perl-Regexp-Pattern-Test-re_engine) ...
 prove-mods: [DRY] [11/12] Running prove for distribution Regexp-Pattern-Twitter (directory /home/u1/repos/perl-Regexp-Pattern-Twitter) ...
 prove-mods: [DRY] [12/12] Running prove for distribution Regexp-Pattern-YouTube (directory /home/u1/repos/perl-Regexp-Pattern-YouTube) ...

The above example shows that I have the distribution directories locally on my
C<~/repos>, except for one 'Regexp::Pattern::License'.

If we reinvoke the above command without the C<-n>, I<prove-rdeps> will actually
run C<prove> on each directory and provide a summary at the end. Example output:

 % prove-mods '^Regexp::Pattern'
 | dir                                           | label                               | reason                            | status |
 | /tmp/2GOBZuxird/Regexp-Pattern-License-v3.2.0 | distribution Regexp-Pattern-License | Test failed (Failed 1/2 subtests) | 500    |

The above example shows that one distribution failed testing. You can scroll up
for the detailed C<prove> output to see the details of failure failed, fix
things, and re-run.

How distribution directory is searched: see L<App::ProveDists> documentation.

When a dependent distribution cannot be found or downloaded/extracted, this
counts as a 412 error (Precondition Failed).

When a distribution's test fails, this counts as a 500 error (Error). Otherwise,
the status is 200 (OK).

I<prove-rdeps> will return status 200 (OK) with the status of each dist. It will
exit 0 if all distros are successful, otherwise it will exit 1.

=head1 OPTIONS

C<*> marks required options.

=head2 Main options


=item B<--dists-dir>=I<s@>*

Where to find the distributions directories.

Can be specified multiple times.

=item B<--dists-dirs-json>=I<s>

Where to find the distributions directories (JSON-encoded).

See C<--dists-dir>.

=item B<--module>=I<s@>*

Module names to prove.

Can be specified multiple times.

=item B<--modules-json>=I<s>

Module names to prove (JSON-encoded).

See C<--module>.

=item B<--no-download>

=item B<--prove-opt>=I<s@>

Options to pass to the prove command.

Default value:


Can be specified multiple times.

=item B<--prove-opts-json>=I<s>

Options to pass to the prove command (JSON-encoded).

See C<--prove-opt>.

=item B<--summarize-all>

If true, also summarize successes in addition to failures.


=head2 Configuration options


=item B<--config-path>=I<s>, B<-c>

Set path to configuration file.

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

Set configuration profile to use.

=item B<--no-config>, B<-C>

Do not use any configuration file.


=head2 Environment options


=item B<--no-env>

Do not read environment for default options.


=head2 Logging options


=item B<--debug>

Shortcut for --log-level=debug.

=item B<--log-level>=I<s>

Set log level.

=item B<--quiet>

Shortcut for --log-level=error.

=item B<--trace>

Shortcut for --log-level=trace.

=item B<--verbose>

Shortcut for --log-level=info.


=head2 Output options


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

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

Default value:


=item B<--json>

Set output format to json.

=item B<--naked-res>

When outputing as JSON, strip result envelope.

Default value:


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


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:


=item B<--page-result>

Filter output through a pager.


=head2 Other options


=item B<--dry-run>

Run in simulation mode (also via DRY_RUN=1).

Default value:


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

Display help message and exit.

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

Display program's version and exit.



This script has shell tab completion capability with support for several

=head2 bash

To activate bash completion for this script, put:

 complete -C prove-mods prove-mods

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 prove-mods 'p/*/`prove-mods`/'

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.


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

By default, these names are searched for configuration filenames (can be changed using C<--config-path>): F<~/.config/prove-mods.conf>, F<~/prove-mods.conf>, or F</etc/prove-mods.conf>.

All found files will be read and merged.

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

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

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

Finally, you can filter a section by environment variable using the filter C<env=CONDITION> in section names. For example if you only want a section to be read if a certain environment variable is true: C<[env=SOMEVAR ...]> or C<[SOMESECTION env=SOMEVAR ...]>. If you only want a section to be read when the value of an environment variable has value equals something: C<[env=HOSTNAME=blink ...]> or C<[SOMESECTION env=HOSTNAME=blink ...]>. If you only want a section to be read when the value of an environment variable does not equal something: C<[env=HOSTNAME!=blink ...]> or C<[SOMESECTION env=HOSTNAME!=blink ...]>. If you only want a section to be read when an environment variable contains something: C<[env=HOSTNAME*=server ...]> or C<[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.

List of available configuration parameters:

 dists_dirs (see --dists-dir)
 download (see --no-download)
 format (see --format)
 log_level (see --log-level)
 modules (see --module)
 naked_res (see --naked-res)
 prove_opts (see --prove-opt)
 summarize_all (see --summarize-all)


=head2 PROVE_MODS_OPT => str

Specify additional command-line options.

=head1 FILES





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

=head1 SOURCE

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

=head1 BUGS

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

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

=head1 AUTHOR

perlancar <perlancar@cpan.org>


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