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