report-prereqs - report prerequisite versions
Version 0.008
The report-prereqs utility will examine a cpanfile, META.json, or META.yml file for prerequisites with Module::CPANfile respectively CPAN::Meta. It reports the version of all modules listed as prerequisites (including 'recommends', 'suggests', etc.). However, any 'develop' prerequisites are not reported, unless they show up in another category or the --with-develop option is used.
report-prereqs
--with-develop
Option --with-feature enables optional features provided by a CPAN distribution. Option may be used more than once.
--with-feature
Versions are reported based on the result of parse_version from ExtUtils::MakeMaker, which means prerequisite modules are not actually loaded. Parse errors are reported as "undef". If a module is not installed, "missing" is reported instead of a version string.
parse_version
Additionally, unfulfilled required prerequisites are reported after the list of all versions.
Parse the filename with Module::CPANfile instead of the default behavior. If the filename is omitted it defaults to cpanfile - which is also the default.
filename
Can not be used together with --meta or a url.
--meta
Parse the filename with CPAN::Meta instead of the default behavior. If the filename is omitted it defaults to META.json.
Can not be used together with --cpanfile or a url.
--cpanfile
Also report develop prerequisites.
Specify optional feature to enable. Option may be used more than once.
The report-prereqs utility exits 0 on success, 1 if an error occurs, and 2 if invalid command line options were specified.
The state of the prerequisites does have no effect on the exist status.
AUTHOR_TESTING
Add the following lines to .travis.yml right before your tests are run, after all your dependencies are installed.
- cpanm --verbose --notest --skip-satisfied App::ReportPrereqs - report-prereqs --with-develop
- cpanm --verbose --notest --skip-satisfied App::ReportPrereqs - report-prereqs
Add the following lines to .appveyor.yml right before your tests are run, after all your dependencies are installed.
- perl -S cpanm --verbose --notest --skip-satisfied App::ReportPrereqs - perl -S report-prereqs --with-develop
- perl -S cpanm --verbose --notest --skip-satisfied App::ReportPrereqs - perl -S report-prereqs
report-prereqs https://raw.githubusercontent.com/skirmess/App-ReportPrereqs/master/cpanfile
report-prereqs --meta MYMETA.json
The Test::ReportPrereqs Dist::Zilla plugin adds a test to your distribution that prints all the prerequisites version during testing of your distribution.
The goal of this module is to produce the same output on Travis CI and AppVeyor without including an additional file to the distribution.
Dist::Zilla::Plugin::Test::ReportPrereqs
Please report any bugs or feature requests through the issue tracker at https://github.com/skirmess/App-ReportPrereqs/issues. You will be notified automatically of any progress on your issue.
This is open source software. The code repository is available for public review and contribution under the terms of the license.
https://github.com/skirmess/App-ReportPrereqs
git clone https://github.com/skirmess/App-ReportPrereqs.git
Sven Kirmess <sven.kirmess@kzone.ch>
Stephan Sachse <ste.sachse@gmail.com>
This software is Copyright (c) 2018-2022 by Sven Kirmess.
This is free software, licensed under:
The (two-clause) FreeBSD License
To install App::ReportPrereqs, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::ReportPrereqs
CPAN shell
perl -MCPAN -e shell install App::ReportPrereqs
For more information on module installation, please visit the detailed CPAN module installation guide.