/ 
Dist-Zilla-Plugins-CJM-6.000
River stage two • 17 direct dependents • 23 total dependents
/ Dist::Zilla::Plugin::RecommendedPrereqs

NAME

Dist::Zilla::Plugin::RecommendedPrereqs - Look for comments recommending prerequisites

VERSION

This document describes version 4.21 of Dist::Zilla::Plugin::RecommendedPrereqs, released December 17, 2017 as part of Dist-Zilla-Plugins-CJM version 6.000.

SYNOPSIS

In your dist.ini:

[RecommendedPrereqs]

In your code:

# RECOMMEND PREREQ: Foo::Bar 1.0
# SUGGEST PREREQ:   Foo::Suggested

DESCRIPTION

If included, this plugin will look for special comments that specify suggested or recommended prerequisites. It's intended as a companion to AutoPrereqs, which can only determine required prerequisites.

Each comment must be on a line by itself, and begin with either RECOMMEND PREREQ: or SUGGEST PREREQ: followed by the module name. The name may be followed by the minimum version, which may in turn be followed by a note explaining the prereq (which will be ignored). If the note is present, the version must be present, even if it's 0.

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

The parser currently just looks for lines beginning with a # (which may be preceded by whitespace). This means it looks in strings and here docs, as well as after __END__. This behavior may be fixed in the future and should not be depended on.

AUTHOR

Christopher J. Madsen <perl AT cjmweb.net>

Please report any bugs or feature requests to <bug-Dist-Zilla-Plugins-CJM AT rt.cpan.org> or through the web interface at http://rt.cpan.org/Public/Bug/Report.html?Queue=Dist-Zilla-Plugins-CJM.

You can follow or contribute to Dist-Zilla-Plugins-CJM's development at https://github.com/madsen/dist-zilla-plugins-cjm.

COPYRIGHT AND LICENSE

This software is copyright (c) 2017 by Christopher J. Madsen.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENSE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.