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