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