File: README

package info (click to toggle)
libperl-critic-community-perl 1.0.4-1
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 428 kB
  • sloc: perl: 1,100; makefile: 2
file content (172 lines) | stat: -rw-r--r-- 4,471 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
NAME

    Perl::Critic::Community - Community-inspired Perl::Critic policies

SYNOPSIS

      $ perlcritic --theme community script.pl
      $ perlcritic --theme community lib/
      
      # .perlcriticrc
      theme = community
      severity = 1

DESCRIPTION

    A set of Perl::Critic policies to enforce the practices generally
    recommended by subsets of the Perl community, particularly on IRC.
    Formerly known as Perl::Critic::Freenode. Because this policy "theme"
    is designed to be used with zero configuration on the command line,
    some duplication will occur if it is used in combination with core
    Perl::Critic policies.

AFFILIATION

    This module has no functionality, but instead contains documentation
    for this distribution and acts as a means of pulling other modules into
    a bundle. All of the Policy modules contained herein will have an
    "AFFILIATION" section announcing their participation in this grouping.

POLICIES

    Perl::Critic::Policy::Community::AmpersandSubCalls

      Don't use & to call subroutines

    Perl::Critic::Policy::Community::ArrayAssignAref

      Don't assign an anonymous arrayref to an array

    Perl::Critic::Policy::Community::BarewordFilehandles

      Don't use bareword filehandles other than built-ins

    Perl::Critic::Policy::Community::ConditionalDeclarations

      Don't declare variables conditionally

    Perl::Critic::Policy::Community::ConditionalImplicitReturn

      Don't end a subroutine with a conditional block

    Perl::Critic::Policy::Community::DeprecatedFeatures

      Avoid features that have been deprecated or removed from Perl

    Perl::Critic::Policy::Community::DiscouragedModules

      Various modules discouraged from use

    Perl::Critic::Policy::Community::DollarAB

      Don't use $a or $b as variable names outside sort()

    Perl::Critic::Policy::Community::Each

      Don't use each() to iterate through a hash

    Perl::Critic::Policy::Community::EmptyReturn

      Don't use return with no arguments

    Perl::Critic::Policy::Community::IndirectObjectNotation

      Don't call methods indirectly

    Perl::Critic::Policy::Community::LexicalForeachIterator

      Don't use undeclared foreach loop iterators

    Perl::Critic::Policy::Community::LoopOnHash

      Don't loop over hashes

    Perl::Critic::Policy::Community::ModPerl

      Don't use mod_perl to write web applications

    Perl::Critic::Policy::Community::MultidimensionalArrayEmulation

      Don't use multidimensional array emulation

    Perl::Critic::Policy::Community::OpenArgs

      Always use the three-argument form of open()

    Perl::Critic::Policy::Community::OverloadOptions

      Don't use overload without specifying a bool overload and enabling
      fallback

    Perl::Critic::Policy::Community::PackageMatchesFilename

      Module files should declare a package matching the filename

    Perl::Critic::Policy::Community::POSIXImports

      Don't use POSIX without specifying an import list

    Perl::Critic::Policy::Community::PreferredAlternatives

      Various modules with preferred alternatives

    Perl::Critic::Policy::Community::Prototypes

      Don't use function prototypes

    Perl::Critic::Policy::Community::SplitQuotedPattern

      Quote the split() pattern argument with regex slashes

    Perl::Critic::Policy::Community::StrictWarnings

      Always use strict and warnings, or a module that imports these

    Perl::Critic::Policy::Community::Threads

      Interpreter-based threads are officially discouraged

    Perl::Critic::Policy::Community::Wantarray

      Don't write context-sensitive functions using wantarray()

    Perl::Critic::Policy::Community::WarningsSwitch

      Scripts should not use the -w switch on the shebang line

    Perl::Critic::Policy::Community::WhileDiamondDefaultAssignment

      Don't use while with implicit assignment to $_

CONFIGURATION AND ENVIRONMENT

    All policies included are in the "community" theme. See the
    Perl::Critic documentation for how to make use of this.

AUTHOR

    Dan Book, dbook@cpan.org

CONTRIBUTORS

    Graham Knop (haarg)

    H.Merijn Brand (Tux)

    John SJ Anderson (genehack)

    Matt S Trout (mst)

    William Taylor (willt)

COPYRIGHT AND LICENSE

    Copyright 2015, Dan Book.

    This library is free software; you may redistribute it and/or modify it
    under the terms of the Artistic License version 2.0.

SEE ALSO

    Perl::Critic