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