test-rinci - Test Rinci metadata in all dist's modules
This document describes version 0.156 of test-rinci (from Perl distribution Test-Rinci), released on 2023-07-09.
In your dist directory:
% test-rinci [options] [module]...
To test certain modules only:
% test-rinci Module1 Module2::Sub
For more options, see documentation.
This script is an command-line interface for Test::Rinci's metadata_in_all_modules_ok() function.
metadata_in_all_modules_ok()
--exclude-package=s
Exclude a package. Can be specified multiple times.
--exclude-function=s
Exclude a function. Can be specified multiple times.
-E
This sets test_function_examples to 0.
test_function_examples
-W
This sets wrap_function to 0.
wrap_function
Please visit the project's homepage at https://metacpan.org/release/Test-Rinci.
Source repository is at https://github.com/perlancar/perl-Test-Rinci.
Test::Rinci
perlancar <perlancar@cpan.org>
To contribute, you can send patches by email/via RT, or send pull requests on GitHub.
Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:
% prove -l
If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.
This software is copyright (c) 2023, 2020, 2019, 2018, 2016, 2015, 2014, 2013, 2012 by perlancar <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.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Test-Rinci
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.
To install Test::Rinci, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Test::Rinci
CPAN shell
perl -MCPAN -e shell install Test::Rinci
For more information on module installation, please visit the detailed CPAN module installation guide.