Christian Walde > Dist-Zilla-Plugin-ProgCriticTests-1.111750 > Dist::Zilla::Plugin::ProgCriticTests

Download:
Dist-Zilla-Plugin-ProgCriticTests-1.111750.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 1.111750   Source  

NAME ^

Dist::Zilla::Plugin::ProgCriticTests - Gradually enforce coding standards with Dist::Zilla

VERSION ^

version 1.111750

SYNOPSIS ^

In dist.ini:

    [ProgCriticTests]
    severity = 1                        # optional : default = 5
    step_size = 1                       # optional : default = 0
    exclude = RequireExplicitPackage    # optional : default = undef
    profile = .critic_profile           # optional : default = undef
    history_file = .perlcritic_history  # optional : default = .perlcritic_history

DESCRIPTION ^

Please see Test::Perl::Critic::Progressive on what exactly it does. For you it's only important to know that by using this plugin you can avoid the creep of bad coding practices into your distribution and slowly remove those that have made their way in already, without being forced to fix everything at once.

The plugin automatically creates the needed test file and primes it with all data it needs to know about your dist as well as the options you give.

OPTIONS ^

severity

A numerical indicator of severity (see Perl::Critic). This is optional. The default is 5.

step_size

A numerical indicator of the expected violation reduction step size. (see T::P::C::P). This is optional. The default is 0.

exclude

A string containing a list of space-separated patterns, which are forwarded as the exclude option to Perl::Critic. This is optional. Default is undefined.

profile

A string indicating the path of a perlcriticrc file (see Perl::Critic). If the path seems to be relative (Class::Path) it is prepended by the distribution root directory, otherwise it is used as is. This is optional. Default is undefined.

history_file

A string indicating the path of a perlcritic history file (see T::P::C::P). If the path seems to be relative (Class::Path) it is prepended by the distribution root directory, otherwise it is used as is. This is optional. Default is '.perlcritic_history'.

SUPPORT ^

I'm usually on irc.perl.org in #distzilla. If you don't see my name (Mithaldu) I'm still there, just not at the computer. However if you mention my name, as well as your problem, I'll get back to you as soon as i get back. Alternatively, sending me an email or a message on GitHub works as well.

The repository for this plugin is located here:

http://github.com/wchristian/Dist-Zilla-Plugin-ProgCriticTests

AUTHOR ^

Christian Walde <mithaldu@yahoo.de>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2011 by Christian Walde.

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

syntax highlighting: