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