Login
Now that we have ProhibitUselessNoCritic, we can
[gknop/Perl-Critic.git] / Changes
CommitLineData
1c31cb1f
ES
1[1.xxx] Released on 2008-xx-xx
2
3 * InputOutput::RequireCheckedSyscalls now has an exclude_functions
4 parameter.
5
64b9b8c8
ES
6[1.093_02] Released on 2008-10-30
7
8 Being released right now simply so that I can put out a version of
9 Perl::Critic::Moose.
a6539177 10
7b3a5e91
ES
11 Incompatible change:
12 * The deprecated $FORMAT variables for Perl::Critic::Policy and
13 Perl::Critic::Violation no longer exist. Use the corresponding
14 get_format() and set_format() functions instead.
d5835ca8
JRT
15 * Also, the way that "## no critic" markers was refactored. As
16 a result, we discovered that the syntax for the markers was
17 pretty vague. If you didn't do it just right, it would
18 disable all policies, and not just the specific ones that
19 you wanted. So we've tightened this up a bit. If you
20 followed the examples that have been in the docs for the
21 last couple years, then you should be fine. But if you've
22 been using certain other variations in your "## no critic"
23 markers, then you might suddenly find yourself violating
24 the new ProhibtUnrestrictedNoCritic policy. To fix this,
25 just make sure your Policy names appear in parentheses:
26
27 ## no critic Foo, Bar, Baz # wrong!
28 ## no critic Foo Bar Baz # wrong!
1c31cb1f
ES
29
30
d5835ca8
JRT
31 ## no critic (Foo, Bar, Baz) # ok!
32 ## no critic qw(Foo Bar Baz) # also ok!
1c31cb1f 33
78afb6d4
ES
34 New Developer Features:
35 * Perl::Critic::Policy::is_document_exempt() has been renamed to
36 prepare_to_scan_document() and the sense of the return value has been
37 reversed in order to make it indicative of being more generally useful.
38
a6539177 39 Policy Changes:
6386d95c
ES
40 * InputOutput::RequireCheckedClose, InputOutput::RequireCheckedOpen, and
41 InputOutput::RequireCheckedSyscalls now all support autodie.
b4f62a87
ES
42 Unfortunately, autodie is currently treated like a module and not a
43 pragma, which means that the lexical scoping is not taken into account.
5f629e32
ES
44 * Modules::ProhibitEvilModules now allows you to specify what the
45 description of a use of a bad module should be, to, say, suggest that
46 people use autodie instead of Fatal.
47 * Subroutine::ProhibitExcessComplexity violation descriptions now include
48 the name of the subroutine, thanks to Andreas Koenig, RT #40070.
a6539177 49
05e2d404 50 New Policies:
1c31cb1f 51 * NamingConventions::Capitalization
05e2d404 52 * Miscellanea::ProhibitUnrestrictedNoCritic
d5835ca8 53 * Miscellanea::ProhibitUselessNoCritic
5603748e 54 * Variables::ProhibitReusedNames
2edc607d 55
a6539177 56[1.093_01] Released on 2008-09-07
f9d21294
ES
57
58 New Developer Features:
59 * Perl::Critic::Policy::is_document_exempt() is checked prior to scanning
60 and thus can speed things up.
50759351
ES
61
62 Bug Fixes:
63 * Miscellanea::RequireRcsKeywords couldn't find keywords after __END__
64 that didn't look like part of POD.
3de28bcc
ES
65 * Modules::RequireFilenameMatchesPackage would incorrectly complain about
66 programs. Yet more greatness contributed by Schwern. RT #39024.
50759351 67
33e51b94
JRT
68[1.092] Released on 2008-09-02
69
70 Bug Fixes:
71 * Fixed POD errors that were causing build failures. Sorry
72 about that.
73
5f2b1108 74[1.091] Released on 2008-09-01
57aab077
JRT
75
76 New Policies:
75a4e4c6 77 * RegularExpressions::RequireDotMatchAnything
57aab077 78
385d181e
JRT
79 New Features:
80 * perlcritic now supports a -pager option, so you can more easily
81 send the output to your favorite pager. You can set this option
82 on the command-line or in your .perlcriticrc file. See the
83 perlcritic perldoc for more details. Credit to Michael Schwern.
84 * The output from "perlcritic -doc PATTERN" will be automatically
85 sent to your pager if you have set the -pager option.
1c31cb1f 86
8e999c4c 87 Policy Changes:
724b3cfb
ES
88 * CodeLayout::ProhibitQuotedWordLists no longer applies if the list
89 contains any non-words, by default. A non-word is anything that does
90 not match /[\w-]+/. You can restore the former behavior by setting the
91 "strict" option. RT #37886.
92 * CodeLayout::ProhibitQuotedWordLists also now applies to the import
93 arguments of a C<use> statement. RT #24467.
94 * ErrorHandling::RequireCheckingReturnValueOfEval now recognizes ternary
95 left-sides as valid checks.
5f2b1108
JRT
96 * RegularExpressions::RequireExtendedFormatting gains a
97 minimum_regex_length_to_complain_about option. Also, regexes that
4377d197
ES
98 contain only word and whitespace characters are now exempt from this
99 policy, by default; you can make it complain about them by turning on
100 the new strict option. Contributed by Michael Schwern. RT #38531.
724b3cfb 101 * TestingAndDebugging::ProhibitNoWarnings now supports a
950a9602
ES
102 allow_with_category_restriction option, thanks to Michael Schwern.
103 RT #38514.
1c31cb1f 104 * CodeLayout::ProhibitHardTabs now allows leading tabs in qw() word lists
b979ee62
JRT
105 and regexes with the /x modifier. You can still configure this
106 policy to forbid all hard tabs, if you like. RT #32440
1b6d3116
ES
107
108 Bug Fixes:
109 * perlcritic should now work under PAR. RT #38380.
1ffd2487 110 * URL for our repository in META.yml now works for anonymous
1c31cb1f
ES
111 checkout. The password is "" (empty). RT #38628.
112 * color for high-severity violations is now magenta because
385d181e 113 it is more redable than yellow on white backgrounds. RT #38511.
8e999c4c 114
8eb8a2e5
ES
115[1.090] Released on 2008-07-22
116
117 Bug Fixes:
118 * Test was incorrectly failing when Regexp::Parser wasn't installed.
119
e6bca1d1 120[1.089] Released on 2008-07-21
a1477a62 121
2849151b
ES
122 Minor Enhancements:
123 * -s is now a synonym for --single-policy.
124
57774e85 125 Policy Changes:
1c31cb1f 126 * Subroutines::ProhibitBuiltinHomonyms now also prohibits subroutines
e4c35446 127 with the same name as a Perl keyword (e.g. if, foreach, while).
57a6408c 128 Inspired by RT #37632.
89c76499
JRT
129 * Subroutines::ProtectPrivateSubs now allows expressions like
130 "shift->_some_private_method();". Note that this *only* applies
131 to the "shift" function -- a private method call on the right of any
132 other bareword still causes a violation. RT #34713.
57774e85
ES
133 * Subroutines::RequireFinalReturn now includes exec in the set of things
134 that mark a successful return. RT #37672
135 * ValuesAndExpressions::ProhibitInterpolationOfLiterals now takes a
136 allow_if_string_contains_single_quote option. Contributed by Ed
137 Avis <ed@membled.com>. RT #36125.
138 * ValuesAndExpressions::RequireInterpolationOfMetachars now supports a
139 rcs_keywords option to allow for the common case where those require
140 dollar signs.
dcfc3546 141
8eb8a2e5 142 Bug Fixes:
a1477a62
ES
143 * BuiltinFunctions::ProhibitSleepViaSelect would complain if there were
144 three undefs as arguments to select(), but one of them was the timeout.
145 RT #37416.
d095fae4
CD
146 * Reduced false positives in
147 RegularExpressions::ProhibitSingleCharAlternation. Thanks to
148 Andy Lester and Elliot Shank test cases.
e624a1c0
ES
149 * RegularExpressions::ProhibitUnusedCapture would complain if there were
150 multiple captures used in a substitution, e.g. s/(.)(.)/$2$1/.
151 * Subroutines::ProhibitAmpersandSigils no longer complains about
152 "sort &foo(...)".
deb58212
JRT
153 * Makefile.PL, Build.PL and other ".PL" scripts which typically do not
154 have a shebang are no longer mistaken as modules. This prevents
e6bca1d1
ES
155 spurious warnings from Modules::RequireEndWithOne. RT #20481.
156
157 Internals:
158 * Tests are now self compliant.
a1477a62 159
07eded00 160[1.088] Released on 2008-07-04
eb4540f0 161
dd813c73
ES
162 New Policies
163 * ErrorHandling::RequireCheckingReturnValueOfEval
164
c25eb228
ES
165 Policy Changes:
166 * ValuesAndExpressions::ProhibitLeadingZeros now accepts octal numbers
94ab9170
ES
167 for the Unix permissions argument to chmod, dbmopen, mkdir, sysopen, or
168 umask, by default. Use the "strict" option to get the old behavior.
169 RT #31977.
99ee70a0
ES
170 * Due to the consensus at YAPC::NA 2008,
171 Variables::ProhibitUnusedVariables default severity has been raised to
172 medium/3.
c25eb228 173
eb4540f0
ES
174 Minor Changes:
175 * The perlcritic "--Version" option is now "--version" in order to act
176 like the rest of the world.
177
449d852e 178[1.087] Released on 2008-06-21
fc97dc73
ES
179
180 Policy Changes:
181 * CodeLayout::ProhibitParensWithBuiltins no longer complains about
182 sort(foo(@x)).
b00c448e
ES
183 * TestingAndDebugging::RequireUseWarnings will not complain about files
184 that contain a "use 5.005" statement or similar for perls prior to 5.6.
185 Lesson of the day: computer conferences where you can meet in the real
186 world can clarify conversations greatly. Good to finally meet you Adam.
80f16a6a 187 * InputOutput::ProhibitTwoArgOpen similarly will not complain if there's
c25eb228 188 a "use/require 5.005" statement in the file. RT #34385.
fc97dc73 189
de2dc641
ES
190 Bug fixes:
191 * Perl::Critic can now critique a file named "0". However, PPI will give
192 a parse error until the next version comes out. Fixes RT #36127.
558488f7
ES
193 * Moved detection of the lack of any enabled Policies from P::C::Config
194 to Perl::Critic. This was causing the perlcritic.t in Parrot to fail.
195 Note, however, there are plans afoot to change how Perl::Critic is
196 configured and things that depend upon that may break. Please contact
197 users@perlcritic.tigris.org and tell us how you're using P::C::Config
198 directly so that we can take your needs into account.
de2dc641 199
809f2b1d 200[1.086] Released on 2008-06-12
e424327a 201
2fa231f5
ES
202 Policy Changes:
203 * NamingConventions::ProhibitAmbiguousNames now specifies the name that
204 it had problems with in its violation descriptions.
9898dfa4 205
2fa231f5
ES
206 Bug fixes:
207 * The color option wasn't being correctly set from a .perlcriticrc.
208 RT #36569.
e424327a 209
2fa231f5
ES
210 Minor changes:
211 * --colour is now a synonym for --color.
e424327a 212
09c724b8 213[1.085] Released on 2008-06-07
fc1fcfaf 214
2fa231f5
ES
215 New Policies:
216 * Documentation::RequirePackageMatchesPodName
fc1fcfaf 217
2fa231f5
ES
218 Policy Changes:
219 * Variables::ProhibitUnusedVariables detects a few more cases. It's
220 still very limited, though.
09c724b8 221
2fa231f5
ES
222 Bug fixes:
223 * ControlStructures::ProhibitUnreachableCode didn't notice "until" was an
224 conditional expression.
20cf6b86 225
2fa231f5 226 Minor documentation updates.
20cf6b86 227
8896dc87 228[1.084] Released on 2008-05-24
da5b6791 229
2fa231f5
ES
230 New Features:
231 * perlcritic now supports a --list-themes option.
232 * You can specify the maximum number of violations you want per Policy
233 per document. Developers can give a default value for this for a
234 Policy by overriding default_maximum_violations_per_document().
235 See RequireUseStrict and ProhibitMagicNumbers for examples.
236
237 Policy Moved:
238 * The ValuesAndExpressions::ProhibitMagicNumbers policy has been moved
239 from Perl::Critic::More into the primary Perl::Critic distribution.
240
241 New Policies:
242 * Variables::ProhibitUnusedVariables (very dumb, limited initial
243 implementation.)
244 * ControlStructures::ProhibitLabelsWithSpecialBlockNames
245 Contributed by Mike O'Regan. Kickin' ass, Mike.
246
247 Policy Changes:
248 * ControlStructures::ProhibitUnreachableCode now handles the perl 5.10
249 "//" and "err" operators. RT #36080
250 * InputOutput::RequireBriefOpen now ignores opens of STDIN, STDOUT,
251 and STDERR. You're generally trying to make long-lasting global
252 effects when manipulating these. (RT #35774)
253 * RegularExpressions::ProhibitUnusualDelimiters now supports an
254 "allow_all_brackets" option.
255 * RegularExpressions::RequireBracesForMultiline now supports an
256 "allow_all_brackets" option.
257 * TestingAndDebugging::RequireUseStrict now accepts "use Moose::Role"
258 as equivalent to "use strict". (RT #34838)
259 * TestingAndDebugging::RequireUseWarnings now accepts "use Moose::Role"
260 as equivalent to "use warnings". (RT #34838)
261 * ValuesAndExpressions::ProhibitMagicNumbers now accepts constant
262 subroutines.
263 * Variables::ProhibitMatchVars no longer detects "use English;".
264 This problem is detected in a more clear way by
265 Modules::RequireNoMatchVarsWithUseEnglish.
266 * Variables::ProhibitPerl4PackageNames no longer complains about
267 $'/$POSTMATCH. RT #36059
268 * Variables::RequireLocalizedPunctuationVars now allows the use of "my".
269 RT #33937
270
271 Bug Fixes:
272 * No longer falls over if a single file has a parse error.
273
274 New Developer Features:
275 * If a document specifies a minimum perl version, e.g. "use 5.008003",
276 P::C::Document::highest_explicit_perl_version() will tell you what it
277 is.
278 * The parameter to P::C::Policy::initialize_if_enabled is now a
279 P::C::PolicyConfig object instead of a hash reference.
280
281 Minor Changes:
282 * LOTS of documentation updates.
283 * A few more statistics are emitted by perlcritic with the --statistics
284 option.
285 * perlcritic --profile-proto now includes policy abstracts in its
286 output.
287
288 Prerequisites:
289 * Now depends upon PPI 1.203.
290 * New dependency upon version.
267b39b4 291
8896dc87
ES
292[1.083_006] Released on 2008-05-20
293[1.083_005] Released on 2008-05-19
294[1.083_004] Released on 2008-05-18
295[1.083_003] Released on 2008-05-17
296[1.083_002] Released on 2008-05-17
297[1.083_001] Released on 2008-04-13
298
2fa231f5
ES
299 Changes summarized into 1.084 above. For exact details, see Changes in
300 1.083_006 on BackPAN.
8896dc87 301
3c1084d4 302[1.082] Released on 2008-03-08
e95460bd 303
2fa231f5
ES
304 New Features:
305 * A new metadata system for defining policy parameters/options has been
306 added. This makes the life of policy authors easier because
307 configuration validation and parsing can be taken care of
308 automatically, in most cases. This allows greater integration with
309 IDEs and allows the perlcritic "--profile-proto" option to produce
310 better output.
311
312 Note: This change does NOT REQUIRE ANY CHANGES to policies outside of
313 this distribution; they should continue to work as is. However, use
314 of this facility can reduce the size of your code and provide the
315 means for tools to discover more about your policy. If this change
316 does break any of your policies, please let us know.
317
318 To learn how to take advantage of this facility, read
319 Perl::Critic::DEVELOPER and look at the source of any of the
320 configurable policies included in this distribution.
321
322 There is a discussion of the design considerations for this facility in
323 the source repository under doc/PolicyParameter_Notes.pod.
324
325 * Added support for "criticism-fatal" option in your perlcriticrc
326 file. This will be used by the criticism pragma to cause execution
327 to abort if the file contains any violations.
328
329 New Policy:
330 * Module::RequireNoMatchVarsWithUseEnglish
331
332 Policy Changes:
333 * Added an allow_last_statement_to_be_comma_separated_in_map_and_grep
334 option to ValuesAndExpressions::ProhibitCommaSeparatedStatements.
335 Partial response to http://rt.cpan.org/Public/Bug/Display.html?id=27654.
336 * ControlStructures::ProhibitPostfixControls gains the ability to have
337 the flow control statements allowed to be modified. This in response
338 to RT #29540.
339 * TestingAndDebugging::RequireUseStrict now accepts "use Moose" as
340 equivalent to "use strict".
341 * TestingAndDebugging::RequireUseWarnings now accepts "use Moose" as
342 equivalent to "use warnings".
343
344 Bug Fixes:
345 * RT #31281 perlcritic doesn't recognize "#!/bin/env perl" shebang
346 * Replace usage of Unicode property escapes with POSIX character classes
347 order to restore 5.6 compatability.
348 * RT #30388 ValuesAndExpressions::ProhibitVersionStrings complained
349 about numbered directories in "use lib".
350 * Fixed handling of badly behaved spelling programs in PodSpelling.
351a08b3 351
3c1084d4
ES
352[1.081_006] Released on 2008-03-02
353[1.081_005] Released on 2007-12-29
90c56584 354[1.081_004] Released on 2007-12-20
28b227a2 355[1.081_003] Released on 2007-12-16
2f3bba7c 356[1.081_002] Released on 2007-12-16
2f3bba7c 357[1.081_001] Released on 2007-12-15
247cca4d 358
2fa231f5
ES
359 Changes summarized into 1.082 above. For exact details, see Changes in
360 1.081_006 on BackPAN.
3d075ed6 361
da251890
ES
362[1.080] Released on 2007-11-11
363
2fa231f5
ES
364 New Features:
365 * Allow a "## no critic" statement after a shebang on line 1 of a
366 file. This allows users to block violations that apply to
367 whole files and still allow shebangs.
368
369 New Policies: (funded by a Perl Foundation grant)
370 * InputOutput::ProhibitExplicitStdin
371 * RegularExpressions::ProhibitFixedStringMatches
372 * RegularExpressions::RequireBracesForMultiline
373 * RegularExpressions::ProhibitUnusualDelimiters
374 * RegularExpressions::ProhibitUnusedCapture
375 * RegularExpressions::ProhibitComplexRegexes
376 * RegularExpressions::ProhibitSingleCharAlternation
377 * RegularExpressions::ProhibitEscapedMetacharacters
378 * RegularExpressions::ProhibitEnumeratedClasses
379 * InputOutput::RequireBriefOpen
380 * InputOutput::RequireCheckedSyscalls
381
382 Other New Policies
383 * ControlStructures::ProhibitNegativeExpressionsInUnlessAndUntilConditions
384
385 Policy Changes:
386 * Variables::ProhibitConditionalDeclarations now permits you to local-ize
387 variables in conditional declarations. This makes sense, since
388 C<local> is actually a variable modifier, rather than a declaration.
389 Thanks to David Golden for reporting this.
390
391 New Developer Features:
392 * Perl::Critic::Utils::PPIRegexp encapsulates interaction with
393 the PPI Regexp token classes. Those classes have very sparse
394 APIs, so this package hides away the ugly fiddling with PPI
395 internals.
396 * Added a new optional_modules parameter for the .run syntax.
397
398 Bug fixes:
399 * PPI::Structure::List can now contain multiple children,
400 so P::C::Utils::parse_arg_list() needs to handle it.
401
402 This was done in the process of fixing
403 http://rt.cpan.org/Ticket/Display.html?id=24924, which was a problem
404 with TestingAndDebugging::RequireTestLabels.
405
406 * ValuesAndExpressions::ProhibitLongChainsOfMethodCalls wasn't resetting
407 chain length when it ran into the end of a sub-expression.
408
409 http://rt.cpan.org/Public/Bug/Display.html?id=30040
410
411 * ValuesAndExpressions::ProhibitCommaSeparatedStatements was reporting
412 false positives when builtins which accept both no and multiple
413 arguments were involved.
414
415 http://rt.cpan.org/Public/Bug/Display.html?id=27654
416
417 Internals:
418 * Removed all use of Carp in favor of exceptions.
419
420 Prerequisites:
421 * Now requires PPI 1.201. A number of workarounds for PPI bugs have been
422 removed.
423 * New dependency upon Exception::Class.
424
425 Installation:
426 * Use Devel::CheckOS to see whether Perl::Critic is being installed on
427 a Solaris system and warn about tar(1) chopping file names off if it
428 is.
a2f58b24 429
3c1084d4
ES
430[1.079_003] Released on 2007-10-22
431[1.079_002] Released on 2007-10-21
432[1.079_001] Released on 2007-10-09
433
2fa231f5
ES
434 Changes summarized into 1.080 above. For exact details, see Changes in
435 1.079_003 on BackPAN.
3c1084d4 436
b4d9a58e
ES
437[1.078] Released on 2007-09-19
438
2fa231f5
ES
439 Restore Perl::Critic::TestUtils::should_skip_author_tests() and
440 get_author_test_skip_message(). Some Perl::Critic add-on distributions
441 are using them.
b4d9a58e 442
496afbe0
ES
443[1.077] Released on 2007-09-15
444
2fa231f5
ES
445 Note: if you don't have any problems installing Perl::Critic 1.076, there
446 is no need to upgrade to this version. There are no functionality
447 changes. This release only contains changes related to installation that
448 a few people were experiencing.
496afbe0 449
2fa231f5
ES
450 Minor changes:
451 * Removed build-time use of Readonly, again, due to problems some people
452 were having when trying to compile the code by hand, rather than using
453 CPAN(PLUS)?.
454 * Don't run author tests if there's a .svn directory present because
455 users who grabbed the code from the source repository were executing
456 them and getting failures.
457 * Don't generate optional, module-hiding test wrappers if author tests
458 are not enabled.
496afbe0
ES
459
460
bb9f1668
ES
461[1.076] Released on 2007-09-07
462
2fa231f5
ES
463 It appears from reports on the 1.075_001 release that the subroutine
464 sigils were indeed the problem. Release to the general populace.
bb9f1668
ES
465
466
70f3f307
ES
467[1.075_001] Released on 2007-09-06
468
2fa231f5
ES
469 Bug Fixes:
470 Undo the changes in 1.073 and 1.074. Instead, stop using the subroutine
471 sigil in import and export lists. It is suspected that the problem lies
472 with Exporter stripping off ampersands.
70f3f307 473
a93bf8bd
ES
474[1.074] Released on 2007-09-04
475
2fa231f5
ES
476 Bug Fixes:
477 Repeat the Makefile.PL change on
478 t/generate_without_optional_dependencies_wrappers.PL.
479 I love CPAN Testers.
a93bf8bd 480
fb768776
ES
481[1.073] Released on 2007-09-04
482
2fa231f5
ES
483 Bug Fixes:
484 Work around problems with the combination of Exporter & Readonly in
485 Makefile.PL on some machines.
fb768776 486
5d0abeb9 487[1.072] Released on 2007-09-03
34cc6052 488
2fa231f5
ES
489 Bug Fixes:
490 * The Makefile generated by Makefile.PL was not syntactically correct
491 according to some versions of Solaris. Thanks to Diab Jerius
492 (DJERIUS) for discovery and testing.
493 * Fixed mis-definition of "quiet" value for the "--profile-strictness"
494 option.
495 * Enhanced testing with the absence of optional modules.
34cc6052 496
6d4236fe 497[1.071] Released on 2007-08-24
6a0a13da 498
2fa231f5 499 The "Brown Paper Bag" Release
caf00bc9 500
2fa231f5
ES
501 Bug Fixes:
502 * Tests would not pass in environments that did not have all optional
503 dependencies installed.
caf00bc9
ES
504
505[1.07] Released on 2007-08-21
506
2fa231f5
ES
507 New Policies: (funded by a Perl Foundation grant)
508 * BuiltinFunctions::ProhibitBooleanGrep
509 * BuiltinFunctions::ProhibitComplexMappings
510 * Documentation::PodSpelling
511 * InputOutput::ProhibitJoinedReadline
512 * Subroutines::ProhibitManyArgs
513 * Subroutines::RequireArgUnpacking
514 * ValuesAndExpressions::ProhibitImplicitNewlines
515 * Variables::RequireLocalizedPunctuationVars
516
517 Other New Policies
518 * Subroutines::ProhibitNestedSubs
519
520 New Features:
521 * The "perlcritic --profile-proto" output now includes the "add_themes"
522 parameter for each policy.
523 * The perlcritic "--strict-profile" option has been replaced with a
524 "--profile-strictness" option. This new option takes values of "warn"
525 (the default), "fatal", and "quiet", which controls what happens with
526 ignorable problems in a .perlcriticrc file.
527
528 New Developer Features:
529 * Perl::Critic::Policy now has an overridable initialize_if_enabled()
530 method which allows a Policy to perform expensive initialization after
531 it has been determined whether the user has it enabled or not. Also,
532 this method allows a Policy to say that it should be disabled
533 regardless of what the user says.
534
535 Actually, use of this method is now encouraged over using a
536 constructor.
537
538 Other Stuff:
539 * Now requires the Readonly module in order to be more self-compliant.
1852a12c 540
7e4ad2a0 541[1.061] Released on 2007-07-24
1852a12c 542
2fa231f5
ES
543 Bug Fixes:
544 * Fix P::C::Theme-- Exporter in Perl 5.6 does not export import(), so you
545 must subclass it. *sigh*
546 * Fix P::C::Config::_validate_and_save_theme()-- eval of an empty string
547 does not reset $@/$EVAL_ERROR in Perl 5.6.
839af03d 548
2fa231f5
ES
549 Big thanks to Anirvan Chatterjee for identifying and helping debug these
550 issues.
6a0a13da 551
a8552b47 552[1.06] Released on 2007-06-27
2e0f1c94 553
2fa231f5
ES
554 New Features:
555 * perlcritic now emits errors for all the problems it can find for the
556 global options in the command-line parameters and .perlcriticrc file,
557 rather than bailing on the first one it encounters.
2e0f1c94 558
2fa231f5
ES
559 * perlcritic now has a "--strict-profile" option which will make warnings
560 about problems in a profile fatal.
66186ba3 561
2fa231f5
ES
562 * perlcritic now has a "--statistics-only" option which suppresses the
563 display of individual violations and only shows the additional output
564 produced by the "--statistics" option.
738830ba 565
2fa231f5
ES
566 Feature requests:
567 * A value for "color" can now be specified in a .perlcriticrc.
568 http://rt.cpan.org/Ticket/Display.html?id=24877
25792f52 569
2fa231f5
ES
570 New Policies:
571 * ValuesAndExpressions::ProhibitQuotesAsQuotelikeOperatorDelimiters
572 As suggested in http://rt.cpan.org/Ticket/Display.html?id=23290.
573 * ValuesAndExpressions::ProhibitLongChainsOfMethodCalls
574 * Modules::ProhibitExcessMainComplexity
575 As suggested in http://rt.cpan.org/Ticket/Display.html?id=24699
68a933bc 576
2fa231f5
ES
577 Minor changes:
578 * The perlcritic "--profile-proto" option now emits the short names for
579 policies, rather than the full ones.
7b94eb6d 580
2fa231f5
ES
581 * The "-profileproto" and "-singlepolicy" options have been renamed to
582 "-profile-proto" and "-single-policy" in order to make the growing
583 number of command-line options comprehensible. The change of
584 "singlepolicy" also affects your F<.perlcriticrc> file.
738830ba 585
c5609030
JRT
586[1.053] Released on 2007-06-02
587
2fa231f5 588 *DEVELOPMENT RELEASE*
c5609030 589
2fa231f5
ES
590 Bug Fixes:
591 Fixed bug in 15_statustics.t test script, which caused the build
592 to fail on machines that don't have Perl::Tidy installed.
c5609030 593
8ff941e7 594[1.052] Released on 2007-06-01
e1a212fa 595
2fa231f5 596 *DEVELOPMENT RELEASE*
c5609030 597
2fa231f5
ES
598 New Features:
599 * perlcritic now emits a summary about the scanned code when enabled by
600 the "-statistics" option.
576f6411 601
2fa231f5
ES
602 Policy Enhancements:
603 * InputOutput::ProhibitBacktickOperators can now be configured to only
604 check in void contexts.
464d4c66 605
2fa231f5
ES
606 Bug Fixes:
607 * 27073: False positive in RequireUpperCaseHeredocTerminator
608 * 27065: CodeLayout::ProhibitTrailingWhitespace breaks under Perl 5.6.1
609 * 26462: ControlStructures::ProhibitCascadingIfElse pod typo
610 * ValuesAndExpressions::ProhibitCommaSeparatedStatements was complaining
611 about multiple values in the list to be iterated over by a foreach loop.
612 * Corrected PBP page numbers for some policies (Quinn Weaver).
db5e49e8 613
be3d6b0b
JRT
614[1.051] Released on 2007-04-12
615
2fa231f5 616 *DEVELOPMENT RELEASE*
be3d6b0b 617
2fa231f5
ES
618 No new policies.
619 No particular bug fixes.
f1a58c7c 620
2fa231f5
ES
621 Internals:
622 * Added several new utility functions to support the StricterSubs distro.
623 Also, some of the existing functions in Perl-Critic-Utils have
624 changed in ways that might break your custom policies.
f1a58c7c 625
2fa231f5
ES
626 Miscellanea:
627 * Updated Emacs plugin (Courtesy Josh ben Jore).
628 See extras/perlcritic.el for details.
629 * Added copy of BBEdit plugin (Courtesy of Josh Clark).
630 See extras/perl_critic_for_bbedit-1_0.zip for details
f1a58c7c 631
a65bc95d
JRT
632[1.05] Released on 2007-03-19
633
2fa231f5
ES
634 Bug Fixes:
635 * 25557: t/20_policy_prohibittrailingwhitespace.t fails on Perl 5.8.0
a65bc95d 636
47415a5b 637[1.04] Released on 2007-03-18
7e50c40d 638
2fa231f5
ES
639 Bug Fixes:
640 * 25008: Subroutines::RequireFinalReturn should allow "throw"
641 * 25085: False Positive - Heredoc terminator must be quoted
642 * 18423: VERSION check does not notice Readonly::Scalar version
643 * 25449: Proposal of $VERSION declaration (DUPLICATE)
7e50c40d 644
2fa231f5
ES
645 New Policies:
646 * CodeLayout::ProhibitTrailingWhitespace
647 * ValuesAndExpressions::ProhibitCommaSeparatedStatements
648 * Variables::ProhibitPerl4PackageNames
74dfa143 649
2fa231f5
ES
650 Policy Enhancements:
651 * Subroutines::RequireFinalReturn can now be configured to recognize
652 your custom functions that behave like "die" or "exit".
653 * Documentation::RequirePodSections can be configured to match
654 Module::Starter:PBP or to really match the PBP book.
7e50c40d 655
34883f65 656[1.03] Released on 2007-02-13
7807e1bf 657
2fa231f5
ES
658 Bug Fixes:
659 * Fixed a few more problems with the %f, %F, and %r format escapes.
660 * I forgot to put Conway's perlcriticrc file in the MANIFEST. Sorry.
2d106991 661
2fa231f5
ES
662 Interface Changes:
663 * Perl::Critic::Utils automatically exports everything. However,
664 this is deprecated. In the future, you must request your exports.
2d106991 665
2fa231f5
ES
666 Policy Changes:
667 * Duplicate violations of RequireExcplicitPackage are now squelched,
668 in the same way as RequireUseStrict and RequireUseWarnings.
7807e1bf 669
dd85a2e2 670[1.02] Released on 2007-02-11
7580d822 671
2fa231f5
ES
672 Bug Fixes:
673 * "undef" incorrectly triggered ProhibitMutatingListFunctions.
674 * 24876: %f and %F escapes not working in custom "verbose" format strings.
675 * 24875: Documentation bug in TestingAndDebugging::ProhibitNoStrict
7580d822 676
2fa231f5
ES
677 New Policies:
678 * InputOutput::RequireCheckedOpen
679 * InputOutput::RequireCheckedClose
9fb2d1dc 680
2fa231f5
ES
681 Other Cool Stuff:
682 * Added Conway's own suggested Perl::Critic configuration as
683 examples/perlcriticrc-conway.
dd85a2e2 684
2fa231f5
ES
685 * See the examples/ directory for some neat demonstrations of using
686 the Perl::Critic API. Contributed by Elliot Shank.
dd85a2e2 687
2fa231f5
ES
688 Interface Changes:
689 * Perl::Critic::Utils no longer exports anything by default. Policies
690 outside the distribution will need to specify what exactly they need
691 from this module. There are a number of tags that can be used in
692 addition to individual imports.
bbf4108c 693
839f3ee0
JRT
694[1.01] Released on 2007-01-24
695
2fa231f5
ES
696 PRODUCTION RELEASE: You may now consider the public Perl::Critic
697 API as "stable." Future minor releases will focus on bug fixes,
698 new policies, and internal refactoring.
16cfe89e 699
2fa231f5
ES
700 Bug Fixes:
701 * Fixed memory leak. This was reported by the Parrot team at
702 http://rt.perl.org/rt3/Ticket/Display.html?id=41230
16cfe89e 703
c10663c1 704[0.23] Released on 2007-01-19
e2d4c0f0 705
2fa231f5
ES
706 Bug Fixes:
707 * 23994: Test 56 in t/05_utils.t of Perl::Critic v0.22 fails
708 * 24005: test 95 in t/13_bundled_policies fails in 0.22
9eb1fee5 709
e2d4c0f0 710
2fa231f5
ES
711 Groovy New Features:
712 * Added '%F' to the Violation format specifications. This will
713 give you just the name of file where the violation occurred
714 (i.e. without the path).
34510f7e 715
2fa231f5
ES
716 * Improved validation of .perlcriticrc file. An invalid
717 default setting will now cause a fatal exception. A
718 strange-looking policy name will cause a warning.
0d63e03a 719
98768f5b 720
2fa231f5
ES
721 Interface Changes:
722 * The syntax for theme expressions has changed. Instead of using
723 mathematical operators qw(+ * -) you must now use the logical
724 operators qw(|| && !). See the Perl::Critic docs for more info.
496afbe0 725
2fa231f5
ES
726 * The @GLOBALS and @BUILTINS variables are no longer exported by
727 Perl::Critic::Utils. Use the is_perl_global() and is_perl_builtin()
728 functions instead.
98768f5b 729
2fa231f5
ES
730 * Perl::Critic::Policy::policy_parameters() has bee renamed to
731 Perl::Critic::Policy::supported_paramters(). This was an
732 undocumented feature anyway, so it shouldn't affect anyone.
98768f5b
JRT
733
734
2fa231f5
ES
735 Other Internal Changes:
736 * Perl::Critic now requires B::Keywords v1.05 or newer.
98768f5b 737
2fa231f5
ES
738 * A few internal classes have been refactored. As a result,
739 Set::Scalar is no longer a required dependency.
e2d4c0f0
JRT
740
741
59c20113 742[0.22] Released on 2006-12-15
4994405b 743
2fa231f5
ES
744 New Features:
745 * Introduced named severity levels: gentle, stern, harsh, cruel, brutal
746 You can use these named levels instead of the numeric ones.
747 For example: "perlcritic --severity=cruel MyModule.pm"
748 Or just: "perlcritic --cruel MyModule.pm"
fd5bd7b5 749
2fa231f5
ES
750 * For perlcritic, the "-List" option has been renamed to
751 "-profileproto". The output now includes the names of the
752 parameters that each Policy supports, if any.
fd5bd7b5 753
2fa231f5
ES
754 * Improved validation of Policy parameters in your F<.perlcriticrc>
755 Any invalid parameter now causes a fatal exception.
0bcb38c0 756
2fa231f5
ES
757 Major Changes:
758 * Reassigned themes for most policies. Now there are fewer
759 themes and they are organized around programming concepts
760 instead of severity levels. If you have assigned your own
761 themes to any Policies, they should still work as expected.
0bcb38c0 762
2fa231f5
ES
763 Policy Changes:
764 * ErrorHandling::RequireCarping will not complain if it can figure
765 out that the die or warn message will always end in a newline
766 ("\n"). The idea is that, if you put the newline there, you
767 don't indend for there to be any file/line/stack information
768 emitted, in which case you really don't want carp/croak.
e2365912 769
2fa231f5
ES
770 You can restore the old strict behavior by giving the policy
771 a false value for "allow_messages_ending_with_newlines" in your
772 configuration.
e97e0a99 773
2fa231f5 774 Misc Changes:
fd5bd7b5 775
2fa231f5 776 Added single-letter uppercase alternatives for some perlcritic options.
4994405b 777
82bdf993 778[0.21_01] Released on 2006-12-03
3f5f950c 779
2fa231f5
ES
780 New Policies:
781 * TestingAndDebugging::ProhibitProlongedStrictureOverride
782 * ControlStructures::ProhibitMutatingListFunctions
783
784 New Features:
785 * Say "perlcritic -List" to get an expanded listing of all Policies.
786 The format is suitable for use as your .perlcriticrc file.
787 * Say "perlcritic -doc PATTERN" to get the documentation for all
788 Policies that match m/PATTERN/imx. This is a little easier than
789 typing in the full name of the Policy module with "perldoc".
790 * Say "perlcritic --singlepolicy PATTERN" to use one and only one
791 policy.
792 * Can now specify exceptions to Variables::ProhibitPackageVars,
793 for packages like File::Find that only interface through
794 package variables.
795
796 Bug Fixes:
797 * 21713 false positive for parens used with substr and unpack.
798 * 22890 allow Rcs keywords in POD.
799
800 Internals:
801 * Testing system overhauled. Details on the Policy/subtest
802 framework is in t/run.t.
803 * Added Perl::Critic::Utils::words_from_string. This is safer
804 than plain old C<split /\s+/>.
095ee6e3 805
7f03b11b 806[0.21] Released on 2006-11-05
1876bbe8 807
2fa231f5
ES
808 New Policies:
809 * BuiltinFunctions::ProhibitReverseSortBlock
810 * BuiltinFunctions::ProhibitVoidGrep
811 * BuiltinFunctions::ProhibitVoidMap
812 * CodeLayout::RequireConsistentNewlines
813 * Modules::RequireFilenameMatchesPackage
814 * TestingAndDebugging::RequireTestLabels
815 * ValuesAndExpressions::ProhibitMismatchedOperators
816
817 New Features:
818 * Introduced policy "themes." Themes are arbitrary names that can
819 be used to identify a group of related Policies. You can select
820 your favorite policies by combining themes in a mathematic expression
821 such as "pbp * (danger + risky)". See POD for details.
822 * perlcritic output is colorized if you have Term::ANSIColor. This
823 only works on non-Win32 platforms. Use -nocolor switch to disable.
824 * Say "perlcritic -count" to get just the the total number of
825 violations per file. Use this feature to quickly identify hot-spots.
826 * Use the -only switch to choose only from policies mentioned in your
827 .perlcriticrc file. This is useful if you usually only want to
828 work with a small subset of the policies.
829 * Default values for most of the perlcritic and Perl::Critic options
830 can now be defined in your .perlcriticrc file. See POD for details.
831
832 Bug Fixes:
833 * 21236: wrong page number for "printing to filehandles"
834 * 21916: File handle ... wrong page reference in PBP [DUPE]
835 * 21714: false positive for capture var used in ternary condition
836 * 21718: No skip for File::Slurp in includes.t
837 * ProhibitBarewordFilehandles doesn't complain if you open
838 STDIN, STDOUT or STDERR.
839 * Parrot 40564: Subroutines::RequireFinalReturn should allow die,
840 exit, etc.
841 * Each "for" and "foreach" loop now adds one point to the McCabe
842 complexity score.
843
844 Other Stuff:
845 * The internals of Perl::Critic have been significantly refactored,
846 but should still be compatible with existing third-party Policies.
847 * Added author-only tests to the release, but disabled by default
848 * New Perl::Critic::Utils::shebang_line() method
849 * Support for filename-based policies
850 * Additional prerequisite: Set::Scalar
851 * Now requires PPI version 1.118
1876bbe8
CD
852
853[0.20] Released on 2006-09-10
9ee6a397 854
2fa231f5
ES
855 Perl::Critic now requires PPI version 1.117, which fixes
856 several bugs that were introduced in version 1.116.
9ee6a397 857
2fa231f5
ES
858 Bug Fixes:
859 * 21079: grep clears @SITE_POLICIES
860 * 21352: Test failures with PPI 1.117
861 * 11365: sub DESTROY detected as a builtin homonym
9ee6a397
JRT
862
863[0.19] Released on 2006-08-20
f7231315 864
2fa231f5
ES
865 New Policies:
866 * BuiltinFunctions::ProhibitStringySplit
867 * ControlStructures::ProhibitDeepNests
868 * RegularExpressions::ProhibitCaptureWithoutTest
869 * Variables::RequireLexicalLoopIterator
b22c8627 870
2fa231f5
ES
871 New Features:
872 * "perlcritic -quiet" suppresses the "source OK" message.
873 * Variables::ProhibitPunctuationVars is now configurable.
8b5892fc 874
2fa231f5
ES
875 Bug Fixes:
876 * 20965: "Hard tabs used at" shouldn't check __DATA__
877 * 21070: ProhibitNoisyQuotes hates overload
878 * Punctuation variables are now exempt from ProhibitLocalVars
c4a2374c 879
2fa231f5
ES
880 Other Stuff:
881 * Test coverage is now over 95%
876c81c6 882
be8538d2 883[0.18_01] Released on 2006-08-06
b22c8627 884
2fa231f5
ES
885 New Policies:
886 * Variables::RequireNegativeIndices
887 * InputOutput::ProhibitInteractiveTest
888 * ErrorHandling::RequireCarping
889
890 Bug Fixes:
891 * RequireTidyCode tests fail if user has custom .perltidyrc file
892 * 20612: RequirePerlTidy was ignoring HEREDOCs
893 * 20659: __END__ statement considered "unreachable"
894 * Fix for PPI::XS (no C<use overload '""'> support)
895 * Support for 'goto' in ProhibitAmpersandSigils and
896 Subroutines::RequireFinalReturn
897
898 Performance Enhancements:
899 * Introduced Perl::Critic::Document class. This is a facade for
900 PPI::Document which internally caches search results. This
901 reduces the running time by about 35%. The facade should be
902 invisible, unless you are doing something really sneaky.
903 * Extraction of the 'diagnostics' information is postponed
904 until it is really needed. Speedup has not been measured.
905 * Calls to helper-subs have been reordered for maximum efficiency.
906
907 Other Cool Stuff:
908 * Includes updated version of perlcritic mode for emacs. See
909 "extras/perlcritic.el" for details.
b22c8627 910
be8538d2 911[0.18] Released on 2006-07-16
0c43b2ce 912
2fa231f5
ES
913 Bug Fixes:
914 * 14855: Home discovery is dangerously naive.
915 * 20060: Incorrect page numbers in ProhibitLeadingZeros
916 and RequireNumberSeparator policies.
917 * 20068: .perlrc file - inconsistent documentation
918 * 20254: "use vars qw(@EXPORT_OK)" not recognized
919 * 20463: No-case heredoc terminator incorrectly detected as lower case.
920 * ProhibitOneArgBless doesn't understand "bless {} => $class;"
921 * ProhibitExcessComplexity doesn't count 'while' and 'until' stmnts
922 * ProhibitLeadingZeros was falsely hits '.0456'
923
924 Enhancements:
925 * If File::HomeDir is available, we use it to locate the
926 .perlcriticrc file. This should help make Perl::Critic
927 more portable to Win32 platforms. If File::HomeDir is
928 not installed, we resort to looking at the usual
929 environment variables.
930
931 Other Stuff:
932 * Added "perlcritic.el", which is a super-cool emacs minor-mode
933 that runs perl-critic on the current buffer and returns the
934 results in a sexy hot-linked "compiler" window. You can run
935 it on demand, or have it run automatically every time you
936 save the buffer. You can find this in the extras/ directory.
937 Thanks to Josh ben Jore for contributing this.
938
939 * Moved "Perl::Critic::TestUtils" into the installed build. This
940 module is only used for unit-testing Perl::Critic, but we
941 are putting it in the installation so folks who want to
942 extend Perl::Critic can make use of it.
6a1cac48 943
be8538d2 944[0.17] Released on 2006-06-13
08624963 945
2fa231f5
ES
946 Bug Fixes:
947 * 19836: Perl-Critic0.16 fails tests during install. This was
948 caused by a bug in version 3.01 of Module::Pluggable. See
949 http://rt.cpan.org/Ticket/Display.html?id=19857 for details.
950 * Fixed bug in no-critic pragma parser.
08624963 951
2fa231f5
ES
952 New Policies:
953 * ValuesAndExpressions::ProhibitEscapedCharacters
954 * BuiltinFunctions::RequireSimpleSortBlock
9c9fbe13 955
2fa231f5
ES
956 Enhancements:
957 * Perl::Critic can export critique() as a static function. This
958 may appeal to folks who dislike the object-oriented interface.
491e8b78 959
be8538d2 960[0.16] Released on 2006-05-14
15bfb880 961
2fa231f5
ES
962 Enhancements:
963 * Perl::Critic->critique() now accepts a PPI::Document as the
964 argument. This feature creates an additional dependency on
965 Scalar::Util, but that shouldn't be a problem because it is
966 included with List::Util, which we already use.
15bfb880 967
2fa231f5
ES
968 Miscellanea:
969 * Increased PPI dependency from v1.110 to v1.112
15bfb880 970
be8538d2 971[0.15_03] Released on 2006-05-07
4f7da5f8 972
2fa231f5
ES
973 Bug Fixes:
974 * The "## no critic" feature is now implemented without eval-ing
975 the code. This keeps Perl::Critic pure and safe :)
976 * 19082: Page number for AUTOLOAD is incorrect
4f7da5f8 977
2fa231f5
ES
978 New Policies:
979 * ControlStructures::ProhibitUnreachableCode (by Peter Guzis)
980 * Modules::ProhibitAutomaticExportation
981 * ValuesAndExpressions::ProhibitVersionStrings
4f7da5f8 982
be8538d2 983[0.15_02] Released on 2006-04-26
1bef6e21 984
2fa231f5
ES
985 Bug Fixes:
986 * Reimplemented the '##no critic' pragmas to have effect on the
987 line where the violation is reported, not on the line where
988 the candidate element lives. This is because some policies
989 may report violations that are nowhere near the element that
990 is being evaluated.
991 * RequireUseStrict, RequireUseWarnings, and RequireExplcitPackage
992 all emit violations for _every_ statement that violates the
993 Policy. This closes a loophole that allowed you to circumvent
994 the Policy by using '## no critic' on just the first statement
995 that violated the policy.
996 * Fixed the workaround for the magic shebang that is inserted
997 by EU::MM and M::B. This had stopped working around version 13.
998 * Fixed -noprofile option on 'perlcritic'. This also had stopped
999 working at some point.
350f4137 1000
be8538d2 1001[0.15_01] Released on 2006-04-16
520d94ce 1002
2fa231f5
ES
1003 Enhancements:
1004 * Added diagnostic messages if the .perlcriticrc contains entries
1005 for Policy modules that don't seem to exist.
1006 * Now you can specify which policies to disable with the
1007 "## no critic" pseudo-pragmas. This feature is still
1008 experimental. See docs for details.
1009 * perlcritic's directory searching now skips backup files, such
1010 as *.swp, *.bak and *~. It also ignores version control system
1011 directories, and the blib directory in module build directories.
9b32fc61 1012
2fa231f5
ES
1013 Bug Fixes:
1014 * 18386: Bad example in POD for Documentation::RequirePodSections
1015 * 18670: Test failure if Perl::Tidy is not installed
1016 * 18698: Policy idea ProhibitUniversalFunctions (see New Policies)
1017 * RequireInterpolationOfMetachars falsely hit strings like 'foo=s@'
1018 which are commonly used with Getopt::Long.
520d94ce 1019
2fa231f5
ES
1020 New Policies:
1021 * BuiltinFunctions::ProhibitUniversalCan (by Chris Dolan)
1022 * BuiltinFunctions::ProhibitUniversalIsa (by Chris Dolan)
520d94ce 1023
2fa231f5
ES
1024 Miscellanea:
1025 * All spurrious options for `perlcritic` are now fatal.
1026 * Changed several of the -verbose formats to be more readable.
1027 * Explicit -severity option now overrides -[12345] shortcuts instead
1028 of being the other way around.
55ae7242
JRT
1029
1030
a5eaeaa4 1031
be8538d2 1032[0.15] Released on 2006-03-26
df092b01 1033
2fa231f5
ES
1034 Bug Fixes:
1035 * 17964: Insists my code is not tidy (may not be fixed for all cases)
df092b01 1036
be8538d2 1037[0.14_02] Released on 2006-03-19
302ea648 1038
2fa231f5
ES
1039 Bug Fixes:
1040 * 15653: False positive in OneArgSelect (fixed for real this time)
b87b00dd 1041
2fa231f5
ES
1042 New Policies:
1043 * ClassHierarchies::ProhibitAutoloading
1044 * Documentation::RequirePodSections
1045 * InputOutput::RequireBracedFileHandleWithPrint
1046 * ValuesAndExpressions::ProhibitMixedBooleanOperators
1047 * Variables::RequireInitializationForLocalVars
5457cbc2 1048
be8538d2 1049[0.14_01] Released on 2006-03-05
fc1186f9 1050
2fa231f5
ES
1051 Bug Fixes:
1052 * 14731: False positive: Builtin function called with parens
1053 * 17554: False positive in CodeLayout::RequireTrailingCommas
20ceb4a0 1054
2fa231f5
ES
1055 New Policies:
1056 * ClassHierarchies::ProhibitExplicitISA
1057 * InputOutput::ProhibitReadlineInForLoop
1058 * Miscellanea::ProhibitFormats
1059 * Miscellanea::ProhibitTies
1060 * Variables::ProhibitConditionalDeclarations
fc1186f9 1061
be8538d2 1062[0.14] Released on 2006-01-29
f4814c30 1063
2fa231f5 1064 More documentation edits.
06d28f35 1065
2fa231f5
ES
1066 New Policies:
1067 * Documentation::RequirePodAtEnd
1068 * Subroutines::ProtectPrivateSubs
1069 * Variables::ProhibitMatchVars
1070 * Variables::ProtectPrivateVars
b672fd9e 1071
2fa231f5
ES
1072 Bug Fixes:
1073 * 15295: "## no critic" pragmas too aggresive on compound statements.
1074 * t/01_config.t failed in the presence of third-party policies
9ad4bbe8
JRT
1075
1076[0.13_05] Not released
1077
2fa231f5 1078 More documentation edits.
9ad4bbe8 1079
2fa231f5 1080 Implemented workaround for failing pod_coverage tests.
2e3c7424 1081
2fa231f5
ES
1082 Bug Fixes:
1083 * 16906: tr/// created false-postives with RegularExpression polices.
f4814c30 1084
be8538d2 1085[0.13_04] Released on 2005-12-31
a2969b87 1086
2fa231f5 1087 Moved DEVELOPER.pod file into the Perl/Critic dir.
a2969b87 1088
2fa231f5 1089 More documentation edits.
f4814c30 1090
e2ec15ae 1091[0.13_03] Released on 20051230
70d719da 1092
2fa231f5
ES
1093 perlcritic now prints 'source OK' if it doesn't find any
1094 violations. This gives folks a warm fuzzy feeling.
2d119dc9 1095
2fa231f5
ES
1096 Tweaked some test cases that were failing on my Solaris
1097 environment at work.
2d119dc9 1098
be8538d2 1099[0.13_02] Released on 2005-12-29
2d119dc9 1100
2fa231f5
ES
1101 Fixed Config to recognize fully-qualified module names in the
1102 .perlcriticrc file.
2d119dc9 1103
2fa231f5 1104 Various documentation edits.
70d719da 1105
be8538d2 1106[0.13_01] Released on 2005-12-28
5635926d 1107
2fa231f5
ES
1108 Replaced 'priority' concept with 'severity'. Now each Policy module
1109 has a predefined severity level ranging from 1 to 5. By default,
1110 perlcritic only reports the most severe violations. You can adjust
1111 the severity threshold at the command line, and you can change
1112 the severity for any Policy using the config file.
1113
1114 Chris implemented the applies_to() mechanism, which allows each Policy
1115 class to declare the types of PPI elements that it wants to examine.
1116 When traversing the document, Perl::Critic invokes the Policy only
1117 for elements that are of the correct type. This improves performance
1118 by about 33%.
1119
1120 Perl::Critic now uses a Plugin architecture to automatically
1121 discover Policy modules. So if you have custom Policies, all you
1122 have to do is install them in the Perl::Critic::Policy namespace --
1123 no need to add anything to your .perlcriticrc file. If you write
1124 policies in a different namespace, you can configure that too. See
1125 the Perl::Critic::Config docs for details.
1126
1127 New Policies:
1128 * Modules::RequireEndWithOne
1129 * NamingConventions::ProhibitAmbiguousNames
1130 * References::ProhibitDoubleSigils
1131 * Subroutines::RequireFinalReturn
1132 * Subroutines::ProhibitAmpersandSigils
1133 * Subroutines::ProhibitExcessComplexity
1134 * TestingAndDebugging::ProhibitNoStrict
1135 * TestingAndDebugging::ProhibitNoWarnings
1136
1137 Bug Fixes:
1138 * 15101: Plugin architecture improves support for 3rd-party code
1139 * 16319: Fixed incorrect PBP page number in ProhibitBarwordFilehandle
1140 * 16321: Lists of empty quotes are now allowed by ProhibitQuotedWordLists
1141 * 16288: Empty lists caused a fatal error RequireTrailingCommas
1142 * 15653: Fixed false positive in OneArgSelect.
496afbe0
ES
1143
1144[0.13] Released on 2005-10-31
59b05e08 1145
2fa231f5 1146 Official release of 0.12_03. No code major changes.
59b05e08
JRT
1147
1148[0.12_03] Not released
1149
2fa231f5
ES
1150 Renamed -Policy option to -include. Added -exclude to give the
1151 opposite effect.
59b05e08 1152
2fa231f5
ES
1153 Refactored constructor of Perl::Critic. Now, most of the work
1154 is delegated to Perl::Critic::Config. I'm not sure I like how
1155 this turned out, but we'll see how it goes.
59b05e08 1156
2fa231f5
ES
1157 Renamed some Policy modules to be a bit more comprehensible. Note
1158 that you may need to change your .perlcriticrc file accordingly.
1159 I also suggest removing your current Perl::Critic installation
1160 before installing this one.
59b05e08 1161
2fa231f5
ES
1162 Name Changes:
1163 * ProhibitUnpackagedCode => RequireExplicitPackage
1164 * RequireQuotedWords => ProhibitQuotedWordLists
59b05e08 1165
2fa231f5
ES
1166 Improved error message when Perl::Critic dies because PPI can't
1167 parsee the input code.
59b05e08 1168
2fa231f5 1169 Changed output of -help to be more terse.
59b05e08 1170
2fa231f5 1171 Edited POD.
59b05e08
JRT
1172
1173[0.12_02] Not released
1174
2fa231f5
ES
1175 Added -Policy option to perlcritic. The idea is to provide a
1176 compact interface for selecting Policy modules at the command-line.
1177 This feature is experimental and subject to change.
59b05e08 1178
2fa231f5
ES
1179 Added a warning message if -verbose value looks strange. In most
1180 applications, the -verbose option does not require a value, so people
1181 might be puzzled when they write 'perlcritic -verbose my_file.pm' and
1182 nothing seems to happen.
59b05e08 1183
2fa231f5
ES
1184 Command-line options to perlcritic are now case-sensitive. This
1185 makes it easier to abbreviate options that start with the same letters
1186 (e.g. 'Version' and 'verbose')
59b05e08 1187
2fa231f5
ES
1188 Fixed the new Policy modules that were misnamed and misplaced in the
1189 previous distribution.
59b05e08
JRT
1190
1191[0.12_01] Not released
1192
2fa231f5
ES
1193 Rewrote some of the ControlStructures and BuiltinFunction
1194 policies to be simpler (and probably a little faster).
1195
1196 Edited POD. Fixed some typos. Added PREREQUISITES section
1197 to Perl::Critic documentation.
1198
1199 Fixed the -verbose FORMAT option so that you can put metachars
1200 in the FORMAT specification. If using perlcritic, be careful to
1201 protect them from getting munged by the shell first.
1202
1203 Replaced ProhibitRequireStatements with RequireBarewordIncludes
1204 module. Courtesy of Chris Dolan <cdolan@cpan.org>
1205
1206 Added configuration to ProhibitInterpolationOfLiterals so that
1207 certain flavors of quotes can be exempt. This is for folks who
1208 have configured their editor to use special syntax highlighting
1209 for certain kinds of strings (SQL, for example).
1210
1211 perlcritic now accepts multiple file arguments, so now you can
1212 critique your entire distribution in one shot. As a result, the
1213 output-formats have changed slightly.
1214
1215 New Policy modules:
1216 * BuiltinFunctions::ProhibitLvalueSubstr
1217 * BuiltinFunctions::ProhibitSleepViaSelect
1218 * ClassHierarchies::ProhibitOneArgBless
1219 * CodeLayout::RequireTrailingCommas
1220 * CodeLayout::RequireQuotedWordLists
1221 * InputOutput::ProhibitTwoArgOpen
1222 * InputOutput::ProhibitOneArgSelect
1223 * InputOutput::ProhibitBarewordFileHandles
1224 * Miscellanea::RequireRcsKeywords
1225 * Modules::RequireVersionVar
1226 * RegularExpressions::RequireExtendedFormatting
1227 * RegularExpressions::RequireLineBoundaryMatching
1228
1229
1230 Bug fixes:
1231 14923: 'require' is now permitted. See RequireBarewordIncludes.
1232 15022: Fixed false-positives when keywords are used as hash keys.
1233 15023: Fixed spurious Violations by removing magic shebang.
1234 15031: Fixed spelling mistakes (and probably added some new ones).
1235 15233: Postfix 'if' is now allowed with 'die', 'croak', etc.
59b05e08 1236
be8538d2 1237[0.12] Released 2005-10-10
59b05e08 1238
2fa231f5
ES
1239 Redesigned the 'verbose' feature. Now the output format
1240 can be user-defined using a sprintf-like specification.
1241 perlciritc also has a predefined output format that is
1242 compatible with grep mode in editors like vim and emacs.
59b05e08 1243
2fa231f5
ES
1244 'return' is now exempt from ProhibitParensWithBuiltins. I may
1245 extend this exemption to all unary functions.
59b05e08 1246
2fa231f5
ES
1247 Edited POD. Added a super brief description of each policy
1248 in the main Perl::Critic documentation. Added details about
1249 editor integration.
59b05e08 1250
2fa231f5
ES
1251 Additional Prerequisites:
1252 * String::Format
59b05e08
JRT
1253
1254[0.11] Not released
1255
2fa231f5
ES
1256 The internal dynamics and API of Perl::Critic have changed
1257 considerably. The result is a 300% increase in performance.
1258 See the POD in Perl::Critic::Policy for details.
59b05e08 1259
2fa231f5
ES
1260 New Features:
1261 * Added -verbose option to put more stuff in the output. In the
1262 extreme, you can get the POD from Policy attached to each
1263 and every violation.
59b05e08 1264
2fa231f5
ES
1265 Additional Prerequisites:
1266 * IO::String
1267 * Pod::PlainText
59b05e08 1268
be8538d2 1269[0.10] Released 2005-10-05
59b05e08 1270
2fa231f5
ES
1271 Fixed stupid bug in newest Policy modules. They were returning
1272 PPI objects instead of Perl::Critic::Violation objects. Doh!
59b05e08 1273
2fa231f5
ES
1274 Fixed test scripts to prevent failures if the user already has a
1275 .perlcriticrc file.
59b05e08 1276
2fa231f5 1277 'ProhibitHardTabs' now allows leading tabs by default.
59b05e08 1278
2fa231f5
ES
1279 Put the Changes file in reverse-chronological order, so the most
1280 recent stuff is easy to find at the top of the file
59b05e08 1281
be8538d2 1282[0.09] Released 2005-10-04
59b05e08 1283
2fa231f5
ES
1284 Fixed several bugs:
1285 * 14810: Now you are allowed to create your own 'import' function,
1286 since this is frequently done with fancy modules.
1287 * 14817: Parens, brackets, and braces are now excluded from
1288 'ProhibitNoisyQuotes' since they look better in quotes anyway.
1289 * 14787: $1..$9 and '_' are exempt from ProhibitPunctuationVars
1290 * 14899: Object methods with the same name as a built-in can
1291 be called with parens (ProhibitParensWithBuiltins).
1292 * 14901: Normalized the exit status of perlcritic to 0, 1, or 2.
1293 See documentation for explanation.
1294 * 14855: Partially fixed home directory discovery. Still not
1295 completely portable, but at least doesn't create warnings.
1296
1297 New features:
1298 * 14734: Limit for number separators is now configurable
1299
1300 New Policy modules:
1301 * CodeLayout::ProhibitHardTabs
1302 * ControlStructures::ProhibitUnlessBlocks
1303 * ControlStructures::ProhibitUntilBlocks
1304 * ControlStructures::ProhibitCStyleForLoops
1305
1306 Changed the syntax for the magic comments. Adam had the
1307 idea of using a pragma-like notation. I liked it.
59b05e08 1308
be8538d2 1309[0.08_2] Released 2005-09-27
59b05e08 1310
2fa231f5
ES
1311 Fixed problems with Perl::Critic::Config that caused File::Spec
1312 to emit 'uninitialized value' warnings during the build.
59b05e08 1313
2fa231f5 1314 Added 1 Policy module contributed by Graham TerMarsch
59b05e08 1315
2fa231f5
ES
1316 Switched from File::Spec::Functions to plain File::Spec because
1317 I think its usage is more common.
59b05e08 1318
2fa231f5
ES
1319 Removed 'FindBin' from the test files so I can be sure that the
1320 right libraries are getting loaded. This means I'll have to
1321 use the -l option with C<prove>.
59b05e08 1322
2fa231f5 1323 Edited more POD.
59b05e08
JRT
1324
1325[0.08_01] Not released
1326
2fa231f5
ES
1327 Fixed "ProhibitParensWithBuiltins" to allow parens to be used with
1328 object method calls that have the same name as a builtin functions.
59b05e08 1329
2fa231f5
ES
1330 Introduced magical comments that allow developers to configure
1331 Perl::Critic on-the-fly from within their code.
59b05e08 1332
2fa231f5
ES
1333 Added META.yml files and POD tests to the build. I did this
1334 mostly just to boost the Kwalitee score on CPANTS.
59b05e08 1335
2fa231f5
ES
1336 Switched from "Config::Std" to "Config::Tiny" because it doesn't
1337 require those fancy Damian modules that don't seem to work on
1338 some older versions of Perl.
59b05e08 1339
be8538d2 1340[0.07] Released on 2005-09-21
59b05e08 1341
2fa231f5 1342 Fixed bugs in the ProhibitCascadingIfElse policy.
59b05e08 1343
2fa231f5 1344 Added ProhibitExplicitReturnUndef policy
59b05e08 1345
2fa231f5
ES
1346 Made ProhibitUnpackagedCode configurable so you can exempt scripts,
1347 which typically don't have an explicit 'package' statement.
59b05e08 1348
2fa231f5
ES
1349 ProhibitPackageVars policy now exempts vars in ALL_CAPS. This
1350 is to permit common package variables like @EXPORT and $VERSION.
59b05e08 1351
2fa231f5
ES
1352 Renamed "ProhibitStringyGrep and "ProhibitStringyMap" because
1353 the so-called string form doesn't really exist. Now called
1354 "RequireBlockGrep" and "RequireBlockMap"
59b05e08 1355
2fa231f5
ES
1356 Corrected documentation on defining Policy names within the
1357 configuration file. This still isn't very clear and needs
1358 to be rewritten.
59b05e08 1359
2fa231f5
ES
1360 Perl::Critic now requires PPI version 1.003, which has a few bug
1361 fixes of its own.
59b05e08 1362
2fa231f5 1363 Rewrite some code just to make Perl::Critic more self-compliant.
59b05e08 1364
2fa231f5
ES
1365 Added test cases to verify the configuration functionality. These
1366 are not completely thorough and need more work.
59b05e08 1367
be8538d2 1368[0.06] Released on 2005-09-17
59b05e08 1369
2fa231f5 1370 Now called 'Perl::Critic'.
496afbe0 1371
2fa231f5 1372 Added 4 new policy modules.
59b05e08 1373
2fa231f5 1374 Fixed bugs in build process.
59b05e08 1375
2fa231f5 1376 Added support for Module::Build.
59b05e08 1377
be8538d2 1378[0.05] Released on 2005-09-17
59b05e08 1379
2fa231f5
ES
1380 End of 'Perl::Review' releases. I have changed the name to
1381 'Perl::Critic' to avoid possible confusion with "The Perl Review"
1382 magazine.
59b05e08 1383
be8538d2 1384[0.04] Released on 2005-09-14
59b05e08 1385
2fa231f5 1386 Version 0.03 was a bust because I uploaded the wrong tarball to PAUSE.
59b05e08 1387
be8538d2 1388[0.03] Released on 2005-09-13.
59b05e08 1389
2fa231f5 1390 Fixed some POD links.
59b05e08 1391
2fa231f5 1392 Removed test cases for missing policy module.
59b05e08 1393
be8538d2 1394[0.02] Released on 2005-09-13.
59b05e08 1395
2fa231f5 1396 Major overhaul based on feedback from Perl community.
59b05e08 1397
2fa231f5
ES
1398 Factored coding standards into separate modules (known as
1399 Policies). The idea here is to allow other developers to easily
1400 contribute additional coding standards.
59b05e08 1401
2fa231f5
ES
1402 Reworked Perl::Review into a simple engine for loading and running
1403 Policy modules.
59b05e08 1404
2fa231f5
ES
1405 Gave perlreview a command-line interface and configuration file
1406 for selecting which Policy modules to use.
59b05e08 1407
be8538d2 1408[0.01] Released on 2005-08-16.
59b05e08 1409
2fa231f5 1410 Initial version.
a69e1617
ES
1411
1412##############################################################################
1413# $URL$
1414# $Date$
1415# $Author$
1416# $Revision$
1417##############################################################################
c25eb228
ES
1418
1419# ex: set ts=8 sts=4 sw=4 tw=78 ft= expandtab shiftround :