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