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