Perl::Critic::Pulp - some add-on perlcritic policies
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).
Perl::Critic
Avoid newline before => not quoting.
=>
Avoid } if () { perhaps meant to be elsif.
} if () {
elsif
Check keyword arguments to __x(), __nx(), etc.
__x()
__nx()
Don't quote a version requirement like use Foo '1.5'
use Foo '1.5'
$VERSION plain number for comparisons and checking.
$VERSION
Avoid problems with FOO < 123
FOO < 123
Avoid problems with ! $x == $y
! $x == $y
Dubious @array=[1,2,3] array/arrayref assignments.
@array=[1,2,3]
Duplicate literal keys %h = (xyz=>123, xyz=>456).
%h = (xyz=>123, xyz=>456)
Don't use -f.
-f
__PACKAGE__ etc special words not expanding.
__PACKAGE__
Version requirement for hash style multi-constants.
Version requirement for constants with leading underscore.
Gtk2 module version requirement for some constants.
Perl version declared against features used.
Perl version declared against POD features used.
Prefer File::Spec->devnull over /dev/null.
File::Spec->devnull
Put __END__ before POD at end of file.
__END__
Locale::TextDomain imported but not used.
Locale::TextDomain
Don't import the whole of POSIX.
POSIX
Comma "," at the end of list, if at a newline.
Semicolon ; on the last statement of a subroutine or block.
;
Stray consecutive commas ,,
,,
Stray semicolons ;
Unknown \z etc escapes in strings.
\z
Double-colon barewords Foo::Bar::
Foo::Bar::
No #! interpreter line in .pm files.
#!
Unbalanced or mismatched ( ) parens, brackets and braces.
Put commas or some text between adjacent L<> links.
L<>
Don't duplicate =head headings.
=head
Don't duplicate L<> links in SEE ALSO sections.
Avoid C<> in NAME section, bad for man's "apropos" output.
C<>
Markup /foo filenames.
Don't L<> link to the document itself.
Don't end paragraph with "," comma.
Don't end paragraph with ".." (stray extra dot).
Verbatim paragraphs not expanding C<> etc markup.
Have a =cut at end of file.
=cut
Use L<> markup on URLs.
You can always enable or disable the policies you do or don't want (see "CONFIGURATION" in Perl::Critic). You may have already realized that there's a wide range of builtin and add-on perlcritic policies ranging from buggy practice to 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 here, or something like ProhibitUnlessBlocks. 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 result in very un-typical code.
ProhibitBarewordDoubleColon
ProhibitUnlessBlocks
Some of the restrictive policies are geared towards beginners. ProhibitUnknownBackslash here or RequireInitializationForLocalVars are along those lines. There might for instance be good backslashing which the prohibition doesn't recognise, or 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.
ProhibitUnknownBackslash
RequireInitializationForLocalVars
$!
local
In general the POD of each policy is supposed to explain the motivation so you can see whether 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!
In most of the perlcritic documentation, including the Pulp add-ons here, policy names appear without the full Perl::Critic::Policy::... class part. In Emacs try man-completion.el to make M-x man automatically expand a suffix part at point, or ffap-perl-module.el for the same to go to the source.
Perl::Critic::Policy::...
man-completion.el
M-x man
ffap-perl-module.el
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 run 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.
%P
perldoc
verbose=%f:%l:%c:\n %P\n %m\n
See Perl::Critic::Violation for all available % escapes. perlcritic.el which comes with perlcritic has regexp patterns for Emacs to recognise the builtin perlcritic formats, but it's easier to output "file:line:column:" in the first place.
%
http://user42.tuxfamily.org/perl-critic-pulp/index.html
Copyright 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017 Kevin Ryde
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/>.
To install Perl::Critic::Pulp, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Perl::Critic::Pulp
CPAN shell
perl -MCPAN -e shell install Perl::Critic::Pulp
For more information on module installation, please visit the detailed CPAN module installation guide.