#!perl

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

our $DATE = '2015-08-18'; # DATE
our $DIST = 'App-LintPrereqs'; # DIST
our $VERSION = '0.30'; # VERSION

use 5.010001;
use strict;
use warnings;

use Perinci::CmdLine::Any;

Perinci::CmdLine::Any->new(
    url => "/App/LintPrereqs/lint_prereqs",
    log => 1,
)->run;

# ABSTRACT: Check extraneous/missing prerequisites in dist.ini
# PODNAME: lint-prereqs

__END__

=pod

=encoding UTF-8

=head1 NAME

lint-prereqs - Check extraneous/missing prerequisites in dist.ini

=head1 VERSION

This document describes version 0.30 of lint-prereqs (from Perl distribution App-LintPrereqs), released on 2015-08-18.

=head1 SYNOPSIS

Usage:

 % lint-prereqs [options]

=head1 DESCRIPTION

Check C<[Prereqs / *]> (as well as C<OSPrereqs>, C<Extras/lint-prereqs/Assume-*>)
sections in your C<dist.ini> against what's actually being used in your Perl code
(using C<Perl::PrereqScanner::Lite>) and what's in Perl core list of modules.
Will complain if your prerequisites are not actually used, or already in Perl
core. Will also complain if there are missing prerequisites.

Designed to work with prerequisites that are manually written. Does not work if
you use AutoPrereqs.

Sometimes there are prerequisites that you know are used but can't be detected
by scan_prereqs, or you want to include anyway. If this is the case, you can
instruct lint_prereqs to assume the prerequisite is used.

 ;!lint-prereqs assume-used # even though we know it is not currently used
 Foo::Bar=0
 ;!lint-prereqs assume-used # we are forcing a certain version
 Baz=0.12

Sometimes there are also prerequisites that are detected by scan_prereqs, but
you know are already provided by some other modules. So to make lint-prereqs
ignore them:

 [Extras / lint-prereqs / assume-provided]
 Qux::Quux=0

=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 Logging options

=over

=item B<--debug>

{en_US Set log level to debug (note: you also need to set LOG=1 to enable logging, or use DEBUG=1)}.

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

{en_US Set log level (note: you also need to set LOG=1 to enable logging)}.

=item B<--quiet>

{en_US Set log level to quiet (note: you also need to set LOG=1 to enable logging, or use QUIET=1)}.

=item B<--trace>

{en_US Set log level to trace (note: you also need to set LOG=1 to enable logging, or use TRACE=1)}.

=item B<--verbose>

{en_US Set log level to info (note: you also need to set LOG=1 to enable logging, or use VERBOSE=1)}.

=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<--help>, B<-h>, B<-?>

{en_US Display help message and exit}.

=item B<--no-lite>

{en_US Use Perl::PrereqScanner instead of Perl::PrereqScanner::Lite}.

{en_US 
Lite is faster but it might still miss detecting some modules.
}


=item B<--perl-version>=I<s>

{en_US Perl version to use (overrides scan_prereqs/dist.ini)}.

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

{en_US 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 lint-prereqs lint-prereqs

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 lint-prereqs 'p/*/`lint-prereqs`/'

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 LINT_PREREQS_OPT => str

Specify additional command-line options

=head1 CONFIGURATION FILE

This script can read configuration file, which by default is searched at C<~/.config/lint-prereqs.conf>, C<~/lint-prereqs.conf> or C</etc/lint-prereqs.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:

 format (see --format)
 lite (see --no-lite)
 log_level (see --log-level)
 naked_res (see --naked-res)
 perl_version (see --perl-version)

=head1 FILES

~/.config/lint-prereqs.conf

~/lint-prereqs.conf

/etc/lint-prereqs.conf

=head1 HOMEPAGE

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

=head1 SOURCE

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

=head1 BUGS

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

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
