Jeffrey Ryan Thalhammer > Perl-Critic-1.117 > Perl::Critic::Policy::CodeLayout::RequireTidyCode

Download:
Perl-Critic-1.117.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

New  61
Open  120
Stalled  4
View/Report Bugs
Module Version: 1.117   Source   Latest Release: Perl-Critic-1.122

NAME ^

Perl::Critic::Policy::CodeLayout::RequireTidyCode - Must run code through perltidy.

AFFILIATION ^

This Policy is part of the core Perl::Critic distribution.

DESCRIPTION ^

Conway does make specific recommendations for whitespace and curly-braces in your code, but the most important thing is to adopt a consistent layout, regardless of the specifics. And the easiest way to do that is to use Perl::Tidy. This policy will complain if you're code hasn't been run through Perl::Tidy.

CONFIGURATION ^

This policy can be configured to tell Perl::Tidy to use a particular perltidyrc file or no configuration at all. By default, Perl::Tidy is told to look in its default location for configuration. Perl::Critic can be told to tell Perl::Tidy to use a specific configuration file by putting an entry in a .perlcriticrc file like this:

    [CodeLayout::RequireTidyCode]
    perltidyrc = /usr/share/perltidy.conf

As a special case, setting perltidyrc to the empty string tells Perl::Tidy not to load any configuration file at all and just use Perl::Tidy's own default style.

    [CodeLayout::RequireTidyCode]
    perltidyrc =

SEE ALSO ^

Perl::Tidy

AUTHOR ^

Jeffrey Ryan Thalhammer <jeff@imaginative-software.com>

COPYRIGHT ^

Copyright (c) 2005-2011 Imaginative Software Systems. All rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of this license can be found in the LICENSE file included with this module.

syntax highlighting: