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