—

              
#!perl
our $DATE = '2021-05-26'; # DATE
our $VERSION = '0.004'; # VERSION
use 5.010001;
use strict;
use warnings;
require Perinci::CmdLine::Lite;
my $prefix = "/App/CPAN/Changes/";
Perinci::CmdLine::Lite->new(
    url => $prefix,
    summary => 'CLI for CPAN::Changes',
    subcommands => {
        check           => { url => "${prefix}check" },
        dump            => { url => "${prefix}dump" },
        preamble        => { url => "${prefix}preamble" },
        release         => { url => "${prefix}release" },
        'add-release'   => { url => "${prefix}add_release" },
    },
)->run;
# ABSTRACT: CLI for CPAN::Changes
# PODNAME: cpan-changes
__END__
HideShow 333 lines of Pod
=pod
=encoding UTF-8
=head1 NAME
cpan-changes - CLI for CPAN::Changes
=head1 VERSION
This document describes version 0.004 of cpan-changes (from Perl distribution App-CPAN-Changes), released on 2021-05-26.
=head1 SYNOPSIS
Check syntax:
 % cpan-changes check -f Changes
 % cpan-changes check ;# by default try to search file Changes, CHANGELOG, etc
Parse and dump parse result as JSON structure:
 % cpan-changes dump
Get preamble:
 % cpan-changes preamble
Set new preamble:
 % cpan-changes preamble "Revision history of Foo-Bar"
See information about a particular release:
 % cpan-changes release 0.001
Add a new release:
 % cpan-changes add-release 0.002 2016-10-10 "Change 1" "[GROUP 1]" "Change 2"
 # ditto, but dry-run and will show the resulting Changes file
 % cpan-changes add-release -V 0.002 --date 2016-10-10 --change "Change 1" \
     --change "[GROUP 1]" --change "Change 2" --dry-run
More subcommands to be added.
=head1 SUBCOMMANDS
=head2 B<add-release>
Add a new release.
=head2 B<check>
Check for parsing errors in Changes file.
=head2 B<dump>
Dump Changes as JSON structure.
=head2 B<preamble>
Get/set preamble.
=head2 B<release>
Return information (JSON object dump) of a specific release.
=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<--file>=I<s>, B<-f>
If not specified, will look for file called Changes/CHANGELOG/etc in current directory.
=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<--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<--subcommands>
List available subcommands.
=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-release
=over
=item B<--change>=I<s@>*
Can be specified multiple times.
=item B<--changes-json>=I<s>
See C<--change>.
=item B<--date>=I<s>*
=item B<--note>=I<s>
=item B<--version-arg>=I<s>*, B<-V>
=back
=head2 Options for subcommand preamble
=over
=item B<--preamble>=I<s>
Set new preamble.
=back
=head2 Options for subcommand release
=over
=item B<--version-arg>=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 cpan-changes cpan-changes
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 cpan-changes 'p/*/`cpan-changes`/'
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/cpan-changes.conf>, F<~/cpan-changes.conf>, or F</etc/cpan-changes.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 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.
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
 file (see --file)
 format (see --format)
 naked_res (see --naked-res)
=head2 Configuration for subcommand add-release
 changes (see --change)
 date (see --date)
 note (see --note)
 version (see --version-arg)
=head2 Configuration for subcommand check
=head2 Configuration for subcommand dump
=head2 Configuration for subcommand preamble
 preamble (see --preamble)
=head2 Configuration for subcommand release
 version (see --version-arg)
=head1 ENVIRONMENT
=head2 CPAN_CHANGES_OPT => str
Specify additional command-line options.
=head1 FILES
F<~/.config/cpan-changes.conf>
F<~/cpan-changes.conf>
F</etc/cpan-changes.conf>
=head1 HOMEPAGE
Please visit the project's homepage at L<https://metacpan.org/release/App-CPAN-Changes>.
=head1 SOURCE
Source repository is at L<https://github.com/perlancar/perl-App-CPAN-Changes>.
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website L<https://github.com/perlancar/perl-App-CPAN-Changes/issues>
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<CPAN::Changes>
L<changes> from L<Module::Changes>
=head1 AUTHOR
perlancar <perlancar@cpan.org>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2021, 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