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