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