Commit 47161a44 authored by Karen Etheridge's avatar Karen Etheridge

Dist-Zilla-Plugin-Test-Perl-Critic-3.001

 - Test::Perl::Critic is now injected into the distribution as a develop prereq
 - Test::Perl::Critic is now used unconditionally in the test (i.e. with no eval)
parent fceb71d8
# CPAN Covenant for Dist-Zilla-Plugin-Test-Perl-Critic
I, Jerome Quelin, hereby give modules@perl.org permission to grant co-maintainership
to Dist-Zilla-Plugin-Test-Perl-Critic, if all the following conditions are met:
(1) I haven't released the module for a year or more
(2) There are outstanding issues in the module's public bug tracker
(3) Email to my CPAN email address hasn't been answered after a month
(4) The requester wants to make worthwhile changes that will benefit CPAN
In the event of my death, then the time-limits in (1) and (3) do not apply.
CONTRIBUTING
Thank you for considering contributing to this distribution. This file
contains instructions that will help you work with the source code.
PLEASE NOTE that if you have any questions or difficulties, you can reach the
maintainer(s) through the bug queue described later in this document
(preferred), or by emailing the releaser directly. You are not required to
follow any of the steps in this document to submit a patch or bug report;
these are just recommendations, intended to help you (and help us help you
faster).
The distribution is managed with Dist::Zilla (https://metacpan.org/release/Dist-Zilla).
This means than many of the usual files you might expect are not in the
repository, but are generated at release time (e.g. Makefile.PL).
However, you can run tests directly using the 'prove' tool:
$ prove -l
$ prove -lv t/some_test_file.t
$ prove -lvr t/
In most cases, 'prove' is entirely sufficent for you to test any
patches you have.
You may need to satisfy some dependencies. The easiest way to satisfy
dependencies is to install the last release -- this is available at
https://metacpan.org/release/Dist-Zilla-Plugin-Test-Perl-Critic
If you use cpanminus, you can do it without downloading the tarball first:
$ cpanm --reinstall --installdeps --with-recommends Dist::Zilla::Plugin::Test::Perl::Critic
Dist::Zilla is a very powerful authoring tool, but requires a number of
author-specific plugins. If you would like to use it for contributing,
install it from CPAN, then run one of the following commands, depending on
your CPAN client:
$ cpan `dzil authordeps --missing`
or
$ dzil authordeps --missing | cpanm
You should then also install any additional requirements not needed by the
dzil build but may be needed by tests or other development:
$ cpan `dzil listdeps --author --missing`
or
$ dzil listdeps --author --missing | cpanm
Or, you can use the 'dzil stale' command to install all requirements at once:
$ cpan Dist::Zilla::App::Command::stale
$ cpan `dzil stale --all`
or
$ cpanm Dist::Zilla::App::Command::stale
$ dzil stale --all | cpanm
You can also do this via cpanm directly:
$ cpanm --reinstall --installdeps --with-develop --with-recommends Dist::Zilla::Plugin::Test::Perl::Critic
Once installed, here are some dzil commands you might try:
$ dzil build
$ dzil test
$ dzil test --release
$ dzil xtest
$ dzil listdeps --json
$ dzil build --notgz
You can learn more about Dist::Zilla at http://dzil.org/.
The code for this distribution is hosted at GitHub. The repository is:
https://github.com/karenetheridge/Dist-Zilla-Plugin-Test-Perl-Critic
You can submit code changes by forking the repository, pushing your code
changes to your clone, and then submitting a pull request. Detailed
instructions for doing that is available here:
https://help.github.com/articles/creating-a-pull-request
If you have found a bug, but do not have an accompanying patch to fix it, you
can submit an issue report here:
https://rt.cpan.org/Public/Dist/Display.html?Name=Dist-Zilla-Plugin-Test-Perl-Critic
or via email: bug-Dist-Zilla-Plugin-Test-Perl-Critic@rt.cpan.org
There is also a mailing list available for users of this distribution, at
http://dzil.org/#mailing-list
There is also an irc channel available for users of this distribution, at
irc://irc.perl.org/#distzilla
If you send me a patch or pull request, your name and email address will be
included in the documentation as a contributor (using the attribution on the
commit or patch), unless you specifically request for it not to be. If you
wish to be listed under a different name or address, you should submit a pull
request to the .mailmap file to contain the correct mapping.
This file was generated via Dist::Zilla::Plugin::GenerateFile::FromShareDir 0.013 from a
template file originating in Dist-Zilla-PluginBundle-Author-ETHER-0.123.
Revision history for Dist::Zilla::Plugin::Test::Perl::Critic
{{$NEXT}}
3.001 2017-05-09 22:32:01Z
- Test::Perl::Critic is now injected into the distribution as a develop prereq
- Test::Perl::Critic is now used unconditionally in the test (i.e. with no eval)
......
This is the Perl distribution Dist-Zilla-Plugin-Test-Perl-Critic.
Installing Dist-Zilla-Plugin-Test-Perl-Critic is straightforward.
## Installation with cpanm
If you have cpanm, you only need one line:
% cpanm Dist::Zilla::Plugin::Test::Perl::Critic
If it does not have permission to install modules to the current perl, cpanm
will automatically set up and install to a local::lib in your home directory.
See the local::lib documentation (https://metacpan.org/pod/local::lib) for
details on enabling it in your environment.
## Installing with the CPAN shell
Alternatively, if your CPAN shell is set up, you should just be able to do:
% cpan Dist::Zilla::Plugin::Test::Perl::Critic
## Manual installation
As a last resort, you can manually install it. Download the tarball, untar it,
then build it:
% perl Build.PL
% ./Build && ./Build test
Then install it:
% ./Build install
If your perl is system-managed, you can create a local::lib in your home
directory to install modules to. For details, see the local::lib documentation:
https://metacpan.org/pod/local::lib
## Documentation
Dist-Zilla-Plugin-Test-Perl-Critic documentation is available as POD.
You can run perldoc from a shell to read the documentation:
% perldoc Dist::Zilla::Plugin::Test::Perl::Critic
This diff is collapsed.
=pod
=encoding UTF-8
=head1 NAME
Dist::Zilla::Plugin::Test::Perl::Critic - Tests to check your code against best practices
=head1 VERSION
version 3.001
=head1 SYNOPSIS
In your F<dist.ini>:
[Test::Perl::Critic]
critic_config = perlcritic.rc ; default / relative to project root
=head1 DESCRIPTION
This will provide a F<t/author/critic.t> file for use during the "test" and
"release" calls of C<dzil>. To use this, make the changes to F<dist.ini>
above and run one of the following:
dzil test
dzil release
During these runs, F<t/author/critic.t> will use L<Test::Perl::Critic> to run
L<Perl::Critic> against your code and by report findings.
This plugin accepts the C<critic_config> option, which specifies your own config
file for L<Perl::Critic>. It defaults to C<perlcritic.rc>, relative to the
project root. If the file does not exist, L<Perl::Critic> will use its defaults.
This plugin is an extension of L<Dist::Zilla::Plugin::InlineFiles>.
=for Pod::Coverage gather_files register_prereqs
=head1 SEE ALSO
You can look for information on this module at:
=for stopwords AnnoCPAN
=over 4
=item * Search CPAN
L<http://search.cpan.org/dist/Dist-Zilla-Plugin-Test-Perl-Critic>
=item * See open / report bugs
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Dist-Zilla-Plugin-Test-Perl-Critic>
=item * Mailing-list (same as L<Dist::Zilla>)
L<http://www.listbox.com/subscribe/?list_id=139292>
=item * Git repository
L<http://github.com/jquelin/dist-zilla-plugin-test-perl-critic>
=item * AnnoCPAN: Annotated CPAN documentation
L<http://annocpan.org/dist/Dist-Zilla-Plugin-Test-Perl-Critic>
=item * CPAN Ratings
L<http://cpanratings.perl.org/d/Dist-Zilla-Plugin-Test-Perl-Critic>
=back
=head1 SUPPORT
Bugs may be submitted through L<the RT bug tracker|https://rt.cpan.org/Public/Dist/Display.html?Name=Dist-Zilla-Plugin-Test-Perl-Critic>
(or L<bug-Dist-Zilla-Plugin-Test-Perl-Critic@rt.cpan.org|mailto:bug-Dist-Zilla-Plugin-Test-Perl-Critic@rt.cpan.org>).
There is also a mailing list available for users of this distribution, at
L<http://dzil.org/#mailing-list>.
There is also an irc channel available for users of this distribution, at
L<C<#distzilla> on C<irc.perl.org>|irc://irc.perl.org/#distzilla>.
=head1 AUTHOR
Jerome Quelin
=head1 CONTRIBUTORS
=for stopwords Jérôme Quelin Karen Etheridge Kent Fredric Olivier Mengué Stephen R. Scaffidi Gryphon Shafer Mike Doherty
=over 4
=item *
Jérôme Quelin <jquelin@gmail.com>
=item *
Karen Etheridge <ether@cpan.org>
=item *
Kent Fredric <kentfredric@gmail.com>
=item *
Olivier Mengué <dolmen@cpan.org>
=item *
Stephen R. Scaffidi <stephen@scaffidi.net>
=item *
Gryphon Shafer <gryphon@goldenguru.com>
=item *
Mike Doherty <doherty@cs.dal.ca>
=back
=head1 COPYRIGHT AND LICENCE
This software is copyright (c) 2009 by Jerome Quelin.
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
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment