| 1 |
NAME |
| 2 |
|
| 3 |
Perl::Critic::Community - Community-inspired Perl::Critic policies |
| 4 |
|
| 5 |
SYNOPSIS |
| 6 |
|
| 7 |
$ perlcritic --theme community script.pl |
| 8 |
$ perlcritic --theme community lib/ |
| 9 |
|
| 10 |
# .perlcriticrc |
| 11 |
theme = community |
| 12 |
severity = 1 |
| 13 |
|
| 14 |
DESCRIPTION |
| 15 |
|
| 16 |
A set of Perl::Critic policies to enforce the practices generally |
| 17 |
recommended by subsets of the Perl community, particularly on IRC. |
| 18 |
Formerly known as Perl::Critic::Freenode. Because this policy "theme" |
| 19 |
is designed to be used with zero configuration on the command line, |
| 20 |
some duplication will occur if it is used in combination with core |
| 21 |
Perl::Critic policies. |
| 22 |
|
| 23 |
AFFILIATION |
| 24 |
|
| 25 |
This module has no functionality, but instead contains documentation |
| 26 |
for this distribution and acts as a means of pulling other modules into |
| 27 |
a bundle. All of the Policy modules contained herein will have an |
| 28 |
"AFFILIATION" section announcing their participation in this grouping. |
| 29 |
|
| 30 |
POLICIES |
| 31 |
|
| 32 |
Perl::Critic::Policy::Community::AmpersandSubCalls |
| 33 |
|
| 34 |
Don't use & to call subroutines |
| 35 |
|
| 36 |
Perl::Critic::Policy::Community::ArrayAssignAref |
| 37 |
|
| 38 |
Don't assign an anonymous arrayref to an array |
| 39 |
|
| 40 |
Perl::Critic::Policy::Community::BarewordFilehandles |
| 41 |
|
| 42 |
Don't use bareword filehandles other than built-ins |
| 43 |
|
| 44 |
Perl::Critic::Policy::Community::ConditionalDeclarations |
| 45 |
|
| 46 |
Don't declare variables conditionally |
| 47 |
|
| 48 |
Perl::Critic::Policy::Community::ConditionalImplicitReturn |
| 49 |
|
| 50 |
Don't end a subroutine with a conditional block |
| 51 |
|
| 52 |
Perl::Critic::Policy::Community::DeprecatedFeatures |
| 53 |
|
| 54 |
Avoid features that have been deprecated or removed from Perl |
| 55 |
|
| 56 |
Perl::Critic::Policy::Community::DiscouragedModules |
| 57 |
|
| 58 |
Various modules discouraged from use |
| 59 |
|
| 60 |
Perl::Critic::Policy::Community::DollarAB |
| 61 |
|
| 62 |
Don't use $a or $b as variable names outside sort() |
| 63 |
|
| 64 |
Perl::Critic::Policy::Community::Each |
| 65 |
|
| 66 |
Don't use each() to iterate through a hash |
| 67 |
|
| 68 |
Perl::Critic::Policy::Community::EmptyReturn |
| 69 |
|
| 70 |
Don't use return with no arguments |
| 71 |
|
| 72 |
Perl::Critic::Policy::Community::IndirectObjectNotation |
| 73 |
|
| 74 |
Don't call methods indirectly |
| 75 |
|
| 76 |
Perl::Critic::Policy::Community::LexicalForeachIterator |
| 77 |
|
| 78 |
Don't use undeclared foreach loop iterators |
| 79 |
|
| 80 |
Perl::Critic::Policy::Community::LoopOnHash |
| 81 |
|
| 82 |
Don't loop over hashes |
| 83 |
|
| 84 |
Perl::Critic::Policy::Community::ModPerl |
| 85 |
|
| 86 |
Don't use mod_perl to write web applications |
| 87 |
|
| 88 |
Perl::Critic::Policy::Community::MultidimensionalArrayEmulation |
| 89 |
|
| 90 |
Don't use multidimensional array emulation |
| 91 |
|
| 92 |
Perl::Critic::Policy::Community::OpenArgs |
| 93 |
|
| 94 |
Always use the three-argument form of open() |
| 95 |
|
| 96 |
Perl::Critic::Policy::Community::OverloadOptions |
| 97 |
|
| 98 |
Don't use overload without specifying a bool overload and enabling |
| 99 |
fallback |
| 100 |
|
| 101 |
Perl::Critic::Policy::Community::PackageMatchesFilename |
| 102 |
|
| 103 |
Module files should declare a package matching the filename |
| 104 |
|
| 105 |
Perl::Critic::Policy::Community::POSIXImports |
| 106 |
|
| 107 |
Don't use POSIX without specifying an import list |
| 108 |
|
| 109 |
Perl::Critic::Policy::Community::PreferredAlternatives |
| 110 |
|
| 111 |
Various modules with preferred alternatives |
| 112 |
|
| 113 |
Perl::Critic::Policy::Community::Prototypes |
| 114 |
|
| 115 |
Don't use function prototypes |
| 116 |
|
| 117 |
Perl::Critic::Policy::Community::SplitQuotedPattern |
| 118 |
|
| 119 |
Quote the split() pattern argument with regex slashes |
| 120 |
|
| 121 |
Perl::Critic::Policy::Community::StrictWarnings |
| 122 |
|
| 123 |
Always use strict and warnings, or a module that imports these |
| 124 |
|
| 125 |
Perl::Critic::Policy::Community::Threads |
| 126 |
|
| 127 |
Interpreter-based threads are officially discouraged |
| 128 |
|
| 129 |
Perl::Critic::Policy::Community::Wantarray |
| 130 |
|
| 131 |
Don't write context-sensitive functions using wantarray() |
| 132 |
|
| 133 |
Perl::Critic::Policy::Community::WarningsSwitch |
| 134 |
|
| 135 |
Scripts should not use the -w switch on the shebang line |
| 136 |
|
| 137 |
Perl::Critic::Policy::Community::WhileDiamondDefaultAssignment |
| 138 |
|
| 139 |
Don't use while with implicit assignment to $_ |
| 140 |
|
| 141 |
CONFIGURATION AND ENVIRONMENT |
| 142 |
|
| 143 |
All policies included are in the "community" theme. See the |
| 144 |
Perl::Critic documentation for how to make use of this. |
| 145 |
|
| 146 |
AUTHOR |
| 147 |
|
| 148 |
Dan Book, [email protected] |
| 149 |
|
| 150 |
CONTRIBUTORS |
| 151 |
|
| 152 |
Graham Knop (haarg) |
| 153 |
|
| 154 |
H.Merijn Brand (Tux) |
| 155 |
|
| 156 |
John SJ Anderson (genehack) |
| 157 |
|
| 158 |
Matt S Trout (mst) |
| 159 |
|
| 160 |
William Taylor (willt) |
| 161 |
|
| 162 |
COPYRIGHT AND LICENSE |
| 163 |
|
| 164 |
Copyright 2015, Dan Book. |
| 165 |
|
| 166 |
This library is free software; you may redistribute it and/or modify it |
| 167 |
under the terms of the Artistic License version 2.0. |
| 168 |
|
| 169 |
SEE ALSO |
| 170 |
|
| 171 |
Perl::Critic |
| 172 |
|