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