NAME

Perl::Critic::Pulp - some add-on perlcritic policies

DESCRIPTION

This is a collection of add-on policies for Perl::Critic. They're under a "pulp" theme plus other themes according to their purpose (see "POLICY THEMES" in Perl::Critic).

Bugs

Miscellanea::TextDomainPlaceholders: Check keyword arguments to __x, __nx, etc.
Modules::ProhibitUseQuotedVersion: Don't quote a version requirement like use Foo '1.5'
ValuesAndExpressions::RequireNumericVersion: $VERSION plain number for comparisons and checking.
ValuesAndExpressions::ConstantBeforeLt: Avoid problems with FOO < 123
ValuesAndExpressions::NotWithCompare: Avoid problems with ! $x == $y
ValuesAndExpressions::ProhibitArrayAssignAref: Dubious @array=[1,2,3] array/arrayref assignments.
ValuesAndExpressions::ProhibitDuplicateHashKeys: Duplicate literal keys %h = (xyz=>123, xyz=>456).
ValuesAndExpressions::ProhibitFiletest_f: Don't use -f.
ValuesAndExpressions::UnexpandedSpecialLiteral: __PACKAGE__ etc special words not expanding.

Compatibility

Compatibility::ConstantPragmaHash: Version requirement for hash style multi-constants.
Compatibility::ConstantLeadingUnderscore: Version requirement for constants with leading underscore.
Compatibility::Gtk2Constants: Gtk2 module version requirement for some constants.
Compatibility::PerlMinimumVersionAndWhy: Perl version declared against features used.
Compatibility::PodMinimumVersion: Perl version declared against POD features used.
Compatibility::ProhibitUnixDevNull: Prefer File::Spec->devnull over /dev/null.

Efficiency

Documentation::RequireEndBeforeLastPod: Put __END__ before POD at end of file.
Miscellanea::TextDomainUnused: Locale::TextDomain imported but not used.
Modules::ProhibitPOSIXimport: Don't import the whole of POSIX.

Cosmetic

CodeLayout::RequireTrailingCommaAtNewline: Comma "," at the end of list, if at a newline.
CodeLayout::RequireFinalSemicolon: Semicolon ; on the last statement of a subroutine or block.
ValuesAndExpressions::ProhibitEmptyCommas: Stray consecutive commas ,,
ValuesAndExpressions::ProhibitNullStatements: Stray semicolons ;
ValuesAndExpressions::ProhibitUnknownBackslash: Unknown \z etc escapes in strings.
ValuesAndExpressions::ProhibitBarewordDoubleColon: Double-colon barewords Foo::Bar::
Modules::ProhibitModuleShebang: No #! interpreter line in .pm files.

Documentation

Documentation::ProhibitUnbalancedParens: Unbalanced or mismatched ( ) parens, brackets and braces.
Documentation::ProhibitAdjacentLinks: Put commas or some text between adjacent L<> links.
Documentation::ProhibitBadAproposMarkup: Avoid C<> in NAME section, bad for man's "apropos" output.
Documentation::ProhibitLinkToSelf: Don't L<> link to the document itself.
Documentation::ProhibitParagraphTwoDots: Don't end paragraph with ".." (stray extra dot).
Documentation::ProhibitVerbatimMarkup: Verbatim paragraphs not expanding C<> etc markup.
Documentation::RequireFinalCut: Have a =cut at end of file.
Documentation::RequireLinkedURLs: Use L<> markup on URLs.

You can always enable or disable the policies you do or don't want (see "CONFIGURATION" in Perl::Critic). If you haven't already realized, there's a wide range of builtin and add-on perlcritic policies ranging from buggy practice to the deliberately restrictive or even quite bizarre. You're not meant to pass everything. Some policies may even be mutually contradictory.

The restrictive policies are meant as building blocks for a limited house style. For example ProhibitBarewordDoubleColon above, or something like ProhibitUnlessBlocks is another. They're usually a matter of personal preference (and non de gustibus disputandum as they say in the classics). Trying to follow all of them would give away big parts of the language and quite likely end up with very un-typical code.

Some of the restrictive policies are geared towards beginners. ProhibitUnknownBackslash above or RequireInitializationForLocalVars are along those lines. There might for instance be good backslashing the prohibition doesn't recognise, or for example local variable initializers make no sense for output variables like $! -- once you get to the level of knowing to use local to preserve such globals.

In general the POD of each policy is supposed to explain the motivation so you can see if you want it or not. If you're not turning off or drastically customizing at least half of all policies then you're either not trying or you're much too easily lead!

OTHER NOTES

In most of the perlcritic documentation, including the Pulp stuff here, policy names appear without the full Perl::Critic::Policy::... class part. In Emacs have a look at man-completion.el to make M-x man automatically expand a suffix part at point, or ffap-perl-module.el to go to the source similarly.

    http://user42.tuxfamily.org/man-completion/index.html

    http://user42.tuxfamily.org/ffap-perl-module/index.html

In perlcritic's output you can ask for %P to see the full policy package name to "perldoc" or copy or follow etc. Here's a good output format you can put in your .perlcriticrc. The file:line:column: part is a style Emacs will recognise.

    verbose=%f:%l:%c:\n %P\n %m\n

See Perl::Critic::Violation for all the available % escapes. perlcritic.el which comes with perlcritic has regexp patterns for Emacs to recognise the builtin perlcritic formats, but it's easier to print "file:line:column:" in the first place.

HOME PAGE

http://user42.tuxfamily.org/perl-critic-pulp/index.html

COPYRIGHT

Perl-Critic-Pulp is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3, or (at your option) any later version.

Perl-Critic-Pulp is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Perl-Critic-Pulp. If not, see <http://www.gnu.org/licenses/>.

CPAN RT