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