—

              
#!perl
our $DATE = '2021-05-25'; # DATE
our $VERSION = '0.122'; # VERSION
BEGIN { $ENV{VERBOSE} //= 1 }
use 5.010;
use strict;
use warnings;
use Log::ger;
use App::PDRUtils;
use Perinci::CmdLine::Any;
use PERLANCAR::Module::List;
my $mods = do {
    # if we are called during building by dzil, don't include subcommands
    # installed outside our dist. otherwise we'll be documenting and depending
    # on extraneous subcommands.
    local @INC = ("lib") if $ENV{DZIL};
    PERLANCAR::Module::List::list_modules(
        "App::PDRUtils::SingleCmd::", {list_modules=>1});
};
my $subcommands = {};
for my $mod (keys %$mods) {
    (my $sc_name = $mod) =~ s/App::PDRUtils::SingleCmd:://;
    next if $sc_name =~ /^_/;
    $sc_name =~ s/_/-/g;
    # ignore old subcommands
    #next if $sc_name =~ /\A(...|...)\z/;
    (my $url = $mod) =~ s!::!/!g;
    $subcommands->{$sc_name} = {
        url => "/$url/handle_cmd",
    };
}
Perinci::CmdLine::Any->new(
    %App::PDRUtils::Common_CLI_Attrs,
    url => '/App/PDRUtils/',
    subcommands => $subcommands,
    log => 1,
    log_level => 'info',
)->run;
1;
# ABSTRACT: Collection of utilities for perl dist repos
# PODNAME: pdrutil
__END__
HideShow 533 lines of Pod
=pod
=encoding UTF-8
=head1 NAME
pdrutil - Collection of utilities for perl dist repos
=head1 VERSION
This document describes version 0.122 of pdrutil (from Perl distribution App-PDRUtils), released on 2021-05-25.
=head1 SYNOPSIS
Usage:
 % pdrutil add-prereq [--config-path=path | -c] [--config-profile=profile |
     -P] [--debug] [--format=name] [--json] [--log-level=level]
     [--(no)naked-res] [--no-config | -C] [--no-env]
     [--page-result[=program]] [--phase=s] [--quiet] [--rel=s] [--trace]
     [--verbose] [--view-result[=program]] <module> [module_version]
 % pdrutil dec-prereq-version-by [--config-path=path | -c]
     [--config-profile=profile | -P] [--debug] [--format=name] [--json]
     [--log-level=level] [--(no)naked-res] [--no-config | -C] [--no-env]
     [--page-result[=program]] [--quiet] [--trace] [--verbose]
     [--view-result[=program]] <module> <by>
 % pdrutil dec-prereq-version-to [--config-path=path | -c]
     [--config-profile=profile | -P] [--debug] [--format=name] [--json]
     [--log-level=level] [--(no)naked-res] [--no-config | -C] [--no-env]
     [--page-result[=program]] [--quiet] [--trace] [--verbose]
     [--view-result[=program]] <module> <module_version>
 % pdrutil inc-prereq-version-by [--config-path=path | -c]
     [--config-profile=profile | -P] [--debug] [--format=name] [--json]
     [--log-level=level] [--(no)naked-res] [--no-config | -C] [--no-env]
     [--page-result[=program]] [--quiet] [--trace] [--verbose]
     [--view-result[=program]] <module> <by>
 % pdrutil inc-prereq-version-to [--config-path=path | -c]
     [--config-profile=profile | -P] [--debug] [--format=name] [--json]
     [--log-level=level] [--(no)naked-res] [--no-config | -C] [--no-env]
     [--page-result[=program]] [--quiet] [--trace] [--verbose]
     [--view-result[=program]] <module> <module_version>
 % pdrutil list-prereqs [--config-path=path | -c] [--config-profile=profile
     | -P] [--debug] [--detail] [--format=name] [--json] [-l]
     [--log-level=level] [--module=s] [--(no)naked-res] [--no-config | -C]
     [--no-detail] [--no-env] [--nodetail] [--page-result[=program]]
     [--phase=s] [--quiet] [--rel=s] [--trace] [--verbose]
     [--view-result[=program]]
 % pdrutil remove-prereq [--config-path=path | -c]
     [--config-profile=profile | -P] [--debug] [--format=name] [--json]
     [--log-level=level] [--(no)naked-res] [--no-config | -C] [--no-env]
     [--page-result[=program]] [--quiet] [--trace] [--verbose]
     [--view-result[=program]] <module>
 % pdrutil set-prereq-version-to [--config-path=path | -c]
     [--config-profile=profile | -P] [--debug] [--format=name] [--json]
     [--log-level=level] [--(no)naked-res] [--no-config | -C] [--no-env]
     [--page-result[=program]] [--quiet] [--trace] [--verbose]
     [--view-result[=program]] <module> <module_version>
 % pdrutil sort-prereqs [--config-path=path | -c] [--config-profile=profile
     | -P] [--debug] [--format=name] [--json] [--log-level=level]
     [--(no)naked-res] [--no-config | -C] [--no-env]
     [--page-result[=program]] [--quiet] [--spacing=s] [--trace]
     [--verbose] [--view-result[=program]]
=head1 DESCRIPTION
This utility operates on a single Perl distribution repository.
=head1 SUBCOMMANDS
=head2 B<add-prereq>
Add a prereq.
=head2 B<dec-prereq-version-by>
Decrease prereq version by a certain decrement.
=head2 B<dec-prereq-version-to>
Decrease prereq version to a specified version.
=head2 B<inc-prereq-version-by>
Increase prereq version by a certain increment.
=head2 B<inc-prereq-version-to>
Increase prereq version to a specified version.
=head2 B<list-prereqs>
List prereqs from `[Prereqs/*]` sections.
This command list prerequisites found in C<[Prereqs/*]> sections in your
C<dist.ini>.
=head2 B<remove-prereq>
Add a prereq.
=head2 B<set-prereq-version-to>
Set prereq version to a specified version.
=head2 B<sort-prereqs>
Sort lines in `[Prereqs/*]` sections.
This command can sort C<[Prereqs/*]> sections in your C<dist.ini> according to
this rule (TODO: allow customized rule): C<perl> comes first, then pragmas sorted
ascibetically and case-insensitively (e.g. C<strict>, C<utf8>, C<warnings>), then
other modules sorted ascibetically and case-insensitively.
Can detect one-spacing or two-spacing. Detects directives and comments.
=head1 OPTIONS
C<*> marks required options.
=head2 Common options
=over
=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<--debug>
Shortcut for --log-level=debug.
=item B<--format>=I<s>
Choose output format, e.g. json, text.
Default value:
 undef
=item B<--help>, B<-h>, B<-?>
Display help message and exit.
=item B<--json>
Set output format to json.
=item B<--log-level>=I<s>
Set log level.
=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
`--naked-res` so you just get:
    [1,2,3]
=item B<--no-config>, B<-C>
Do not use any configuration file.
=item B<--no-env>
Do not read environment for default options.
=item B<--page-result>
Filter output through a pager.
=item B<--quiet>
Shortcut for --log-level=error.
=item B<--subcommands>
List available subcommands.
=item B<--trace>
Shortcut for --log-level=trace.
=item B<--verbose>
Shortcut for --log-level=info.
=item B<--version>, B<-v>
Display program's version and exit.
=item B<--view-result>
View output using a viewer.
=back
=head2 Options for subcommand add-prereq
=over
=item B<--module-version>=I<s>
Default value:
 0
Can also be specified as the 2nd command-line argument.
=item B<--module>=I<s>*
Can also be specified as the 1st command-line argument.
=item B<--phase>=I<s>
Select prereq phase.
Default value:
 "runtime"
=item B<--rel>=I<s>
Select prereq relationship.
Default value:
 "requires"
=back
=head2 Options for subcommand dec-prereq-version-by
=over
=item B<--by>=I<s>*
Can also be specified as the 2nd command-line argument.
=item B<--module>=I<s>*
Can also be specified as the 1st command-line argument.
=back
=head2 Options for subcommand dec-prereq-version-to
=over
=item B<--module-version>=I<s>*
Can also be specified as the 2nd command-line argument.
=item B<--module>=I<s>*
Can also be specified as the 1st command-line argument.
=back
=head2 Options for subcommand inc-prereq-version-by
=over
=item B<--by>=I<s>*
Can also be specified as the 2nd command-line argument.
=item B<--module>=I<s>*
Can also be specified as the 1st command-line argument.
=back
=head2 Options for subcommand inc-prereq-version-to
=over
=item B<--module-version>=I<s>*
Can also be specified as the 2nd command-line argument.
=item B<--module>=I<s>*
Can also be specified as the 1st command-line argument.
=back
=head2 Options for subcommand list-prereqs
=over
=item B<--detail>, B<-l>
=item B<--module>=I<s>
Module name.
=item B<--phase>=I<s>
Valid values:
 ["configure","build","test","runtime","develop"]
=item B<--rel>=I<s>
Valid values:
 ["requires","recommends","suggests","conflicts"]
=back
=head2 Options for subcommand remove-prereq
=over
=item B<--module>=I<s>*
Can also be specified as the 1st command-line argument.
=back
=head2 Options for subcommand set-prereq-version-to
=over
=item B<--module-version>=I<s>*
Can also be specified as the 2nd command-line argument.
=item B<--module>=I<s>*
Can also be specified as the 1st command-line argument.
=back
=head2 Options for subcommand sort-prereqs
=over
=item B<--spacing>=I<s>
Set spacing explicitly.
=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 pdrutil pdrutil
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 pdrutil 'p/*/`pdrutil`/'
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 CONFIGURATION FILE
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/pdrutil.conf>, F<~/pdrutil.conf>, or F</etc/pdrutil.conf>.
All found files will be read and merged.
To disable searching for configuration files, pass C<--no-config>.
To put configuration for a certain subcommand only, use a section name like C<[subcommand=NAME]> or C<[SOMESECTION subcommand=NAME]>.
You can put multiple profiles in a single file by using section names like C<[profile=SOMENAME]> or C<[SOMESECTION profile=SOMENAME]> or C<[subcommand=SUBCOMMAND_NAME profile=SOMENAME]> or C<[SOMESECTION subcommand=SUBCOMMAND_NAME 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.
You can also 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 equals some string: 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 some string: 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 includes some string: C<[env=HOSTNAME*=server ...]> or C<[SOMESECTION env=HOSTNAME*=server ...]>. If you only want a section to be read when the value of an environment variable does not include some string: 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.
To load and configure plugins, you can use either the C<-plugins> parameter (e.g. C<< -plugins=DumpArgs >> or C<< -plugins=DumpArgs@before_validate_args >>), or use the C<[plugin=NAME ...]> sections, for example:
 [plugin=DumpArgs]
 -event=before_validate_args
 -prio=99
  
 [plugin=Foo]
 -event=after_validate_args
 arg1=val1
 arg2=val2
  
which is equivalent to setting C<< -plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2 >>.
List of available configuration parameters:
=head2 Common for all subcommands
 format (see --format)
 log_level (see --log-level)
 naked_res (see --naked-res)
=head2 Configuration for subcommand add-prereq
 module (see --module)
 module_version (see --module-version)
 phase (see --phase)
 rel (see --rel)
=head2 Configuration for subcommand dec-prereq-version-by
 by (see --by)
 module (see --module)
=head2 Configuration for subcommand dec-prereq-version-to
 module (see --module)
 module_version (see --module-version)
=head2 Configuration for subcommand inc-prereq-version-by
 by (see --by)
 module (see --module)
=head2 Configuration for subcommand inc-prereq-version-to
 module (see --module)
 module_version (see --module-version)
=head2 Configuration for subcommand list-prereqs
 detail (see --detail)
 module (see --module)
 phase (see --phase)
 rel (see --rel)
=head2 Configuration for subcommand remove-prereq
 module (see --module)
=head2 Configuration for subcommand set-prereq-version-to
 module (see --module)
 module_version (see --module-version)
=head2 Configuration for subcommand sort-prereqs
 spacing (see --spacing)
=head1 ENVIRONMENT
=head2 PDRUTIL_OPT => str
Specify additional command-line options.
=head1 FILES
F<~/.config/pdrutil.conf>
F<~/pdrutil.conf>
F</etc/pdrutil.conf>
=head1 HOMEPAGE
Please visit the project's homepage at L<https://metacpan.org/release/App-PDRUtils>.
=head1 SOURCE
Source repository is at L<https://github.com/perlancar/perl-App-PDRUtils>.
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=App-PDRUtils>
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 SEE ALSO
L<pdrutil-multi> which operates on several Perl distribution repositories at
once.
=head1 AUTHOR
perlancar <perlancar@cpan.org>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2021, 2019, 2018, 2017, 2016 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