README
1NAME
2 Perl::Critic::More - Supplemental policies for Perl::Critic
3
4SYNOPSIS
5 perl -MCPAN -e'install Perl::Critic::More'
6 perlcritic -theme more lib/Foo.pm
7
8AFFILIATION
9 This file has no functionality, but instead is a placeholder for a loose
10 collection of Perl::Critic policies. All of those policies will have an
11 "Affiliation" section announcing their participation in this grouping.
12
13DESCRIPTION
14 This is a collection of Perl::Critic policies that are not included in
15 the Perl::Critic core for a variety of reasons:
16
17 * Experimental
18
19 Some policies need some time to work out their kinks, test
20 usability, or gauge community interest. A subset of these will end
21 up in the core Perl::Critic someday.
22
23 * Requires special dependencies
24
25 For example, some policies require development versions of PPI (or
26 some other CPAN module). These will likely end up in the
27 Perl::Critic core when their dependencies are fulfilled.
28
29 * Peripheral to Perl
30
31 For example, the "Editor::RequireEmacsFileVariables" policy is
32 metacode. Also, the "Miscellanea::RequireRcsKeywords" policy
33 pertains to the development process, not the code itself. These are
34 not part of Perl::Critic's mission.
35
36 * Special purpose
37
38 For example, policies like "CodeLayout::RequireASCII" designed to
39 scratch itches not felt by most of the community. These will always
40 remain in a Perl::Critic supplement instead of in the core.
41
42 All of these policies have the theme "more" so they can be turned off as
43 a group via .perlcriticrc by adding this line:
44
45 theme = not more
46
47 The special purpose ones may be part of the "notrecommended" theme.
48 Avoid these via:
49
50 theme = not notrecommended
51
52 Sorry about the double-negative... See "CONFIGURATION" in Perl::Critic
53 for details on how to interact with themes.
54
55SEE ALSO
56 Perl::Critic
57
58 Perl::Critic::Bangs - Andy Lester's fantastic list of code pet peeves
59
60 Perl::Critic::Lax - RJBS' more-lenient versions of some core
61 Perl::Critic policies
62
63 parrot - the parrot team has developed a few specialized Perl::Critic
64 policies of their own
65
66AUTHOR
67 Chris Dolan <cdolan@cpan.org>
68
69 The included policies may have other authors -- please see them
70 individually.
71
72 This distribution is controlled by the Perl::Critic team. If you want to
73 add a policy to this collection, check out our Subversion repository and
74 mailing lists at <http://perlcritic.tigris.org>.
75
76COPYRIGHT
77 Copyright (c) 2006-2008 Chris Dolan
78
79 This program is free software; you can redistribute it and/or modify it
80 under the same terms as Perl itself. The full text of this license can
81 be found in the LICENSE file included with this module.
82
83