1 [1.xxx] Released on 2008-xx-xx
4 * The deprecated $FORMAT variables for Perl::Critic::Policy and
5 Perl::Critic::Violation no longer exist. Use the corresponding
6 get_format() and set_format() functions instead.
8 New Developer Features:
9 * Perl::Critic::Policy::is_document_exempt() has been renamed to
10 prepare_to_scan_document() and the sense of the return value has been
11 reversed in order to make it indicative of being more generally useful.
14 * InputOutput::RequireCheckedClose, InputOutput::RequireCheckedOpen, and
15 InputOutput::RequireCheckedSyscalls now all support autodie.
16 Unfortunately, autodie is currently treated like a module and not a
17 pragma, which means that the lexical scoping is not taken into account.
18 * Modules::ProhibitEvilModules now allows you to specify what the
19 description of a use of a bad module should be, to, say, suggest that
20 people use autodie instead of Fatal.
21 * Subroutine::ProhibitExcessComplexity violation descriptions now include
22 the name of the subroutine, thanks to Andreas Koenig, RT #40070.
25 * Miscellanea::ProhibitUnrestrictedNoCritic
26 * Variables::ProhibitReusedNames
28 [1.093_01] Released on 2008-09-07
30 New Developer Features:
31 * Perl::Critic::Policy::is_document_exempt() is checked prior to scanning
32 and thus can speed things up.
35 * Miscellanea::RequireRcsKeywords couldn't find keywords after __END__
36 that didn't look like part of POD.
37 * Modules::RequireFilenameMatchesPackage would incorrectly complain about
38 programs. Yet more greatness contributed by Schwern. RT #39024.
40 [1.092] Released on 2008-09-02
43 * Fixed POD errors that were causing build failures. Sorry
46 [1.091] Released on 2008-09-01
49 * RegularExpressions::RequireDotMatchAnything
52 * perlcritic now supports a -pager option, so you can more easily
53 send the output to your favorite pager. You can set this option
54 on the command-line or in your .perlcriticrc file. See the
55 perlcritic perldoc for more details. Credit to Michael Schwern.
56 * The output from "perlcritic -doc PATTERN" will be automatically
57 sent to your pager if you have set the -pager option.
60 * CodeLayout::ProhibitQuotedWordLists no longer applies if the list
61 contains any non-words, by default. A non-word is anything that does
62 not match /[\w-]+/. You can restore the former behavior by setting the
63 "strict" option. RT #37886.
64 * CodeLayout::ProhibitQuotedWordLists also now applies to the import
65 arguments of a C<use> statement. RT #24467.
66 * ErrorHandling::RequireCheckingReturnValueOfEval now recognizes ternary
67 left-sides as valid checks.
68 * RegularExpressions::RequireExtendedFormatting gains a
69 minimum_regex_length_to_complain_about option. Also, regexes that
70 contain only word and whitespace characters are now exempt from this
71 policy, by default; you can make it complain about them by turning on
72 the new strict option. Contributed by Michael Schwern. RT #38531.
73 * TestingAndDebugging::ProhibitNoWarnings now supports a
74 allow_with_category_restriction option, thanks to Michael Schwern.
76 * CodeLayout::ProhibitHardTabs now allows leading tabs in qw() word lists
77 and regexes with the /x modifier. You can still configure this
78 policy to forbid all hard tabs, if you like. RT #32440
81 * perlcritic should now work under PAR. RT #38380.
82 * URL for our repository in META.yml now works for anonymous
83 checkout. The password is "" (empty). RT #38628.
84 * color for high-severity violations is now magenta because
85 it is more redable than yellow on white backgrounds. RT #38511.
87 [1.090] Released on 2008-07-22
90 * Test was incorrectly failing when Regexp::Parser wasn't installed.
92 [1.089] Released on 2008-07-21
95 * -s is now a synonym for --single-policy.
98 * Subroutines::ProhibitBuiltinHomonyms now also prohibits subroutines
99 with the same name as a Perl keyword (e.g. if, foreach, while).
100 Inspired by RT #37632.
101 * Subroutines::ProtectPrivateSubs now allows expressions like
102 "shift->_some_private_method();". Note that this *only* applies
103 to the "shift" function -- a private method call on the right of any
104 other bareword still causes a violation. RT #34713.
105 * Subroutines::RequireFinalReturn now includes exec in the set of things
106 that mark a successful return. RT #37672
107 * ValuesAndExpressions::ProhibitInterpolationOfLiterals now takes a
108 allow_if_string_contains_single_quote option. Contributed by Ed
109 Avis <ed@membled.com>. RT #36125.
110 * ValuesAndExpressions::RequireInterpolationOfMetachars now supports a
111 rcs_keywords option to allow for the common case where those require
115 * BuiltinFunctions::ProhibitSleepViaSelect would complain if there were
116 three undefs as arguments to select(), but one of them was the timeout.
118 * Reduced false positives in
119 RegularExpressions::ProhibitSingleCharAlternation. Thanks to
120 Andy Lester and Elliot Shank test cases.
121 * RegularExpressions::ProhibitUnusedCapture would complain if there were
122 multiple captures used in a substitution, e.g. s/(.)(.)/$2$1/.
123 * Subroutines::ProhibitAmpersandSigils no longer complains about
125 * Makefile.PL, Build.PL and other ".PL" scripts which typically do not
126 have a shebang are no longer mistaken as modules. This prevents
127 spurious warnings from Modules::RequireEndWithOne. RT #20481.
130 * Tests are now self compliant.
132 [1.088] Released on 2008-07-04
135 * ErrorHandling::RequireCheckingReturnValueOfEval
138 * ValuesAndExpressions::ProhibitLeadingZeros now accepts octal numbers
139 for the Unix permissions argument to chmod, dbmopen, mkdir, sysopen, or
140 umask, by default. Use the "strict" option to get the old behavior.
142 * Due to the consensus at YAPC::NA 2008,
143 Variables::ProhibitUnusedVariables default severity has been raised to
147 * The perlcritic "--Version" option is now "--version" in order to act
148 like the rest of the world.
150 [1.087] Released on 2008-06-21
153 * CodeLayout::ProhibitParensWithBuiltins no longer complains about
155 * TestingAndDebugging::RequireUseWarnings will not complain about files
156 that contain a "use 5.005" statement or similar for perls prior to 5.6.
157 Lesson of the day: computer conferences where you can meet in the real
158 world can clarify conversations greatly. Good to finally meet you Adam.
159 * InputOutput::ProhibitTwoArgOpen similarly will not complain if there's
160 a "use/require 5.005" statement in the file. RT #34385.
163 * Perl::Critic can now critique a file named "0". However, PPI will give
164 a parse error until the next version comes out. Fixes RT #36127.
165 * Moved detection of the lack of any enabled Policies from P::C::Config
166 to Perl::Critic. This was causing the perlcritic.t in Parrot to fail.
167 Note, however, there are plans afoot to change how Perl::Critic is
168 configured and things that depend upon that may break. Please contact
169 users@perlcritic.tigris.org and tell us how you're using P::C::Config
170 directly so that we can take your needs into account.
172 [1.086] Released on 2008-06-12
175 * NamingConventions::ProhibitAmbiguousNames now specifies the name that
176 it had problems with in its violation descriptions.
179 * The color option wasn't being correctly set from a .perlcriticrc.
183 * --colour is now a synonym for --color.
185 [1.085] Released on 2008-06-07
188 * Documentation::RequirePackageMatchesPodName
191 * Variables::ProhibitUnusedVariables detects a few more cases. It's
192 still very limited, though.
195 * ControlStructures::ProhibitUnreachableCode didn't notice "until" was an
196 conditional expression.
198 Minor documentation updates.
200 [1.084] Released on 2008-05-24
203 * perlcritic now supports a --list-themes option.
204 * You can specify the maximum number of violations you want per Policy
205 per document. Developers can give a default value for this for a
206 Policy by overriding default_maximum_violations_per_document().
207 See RequireUseStrict and ProhibitMagicNumbers for examples.
210 * The ValuesAndExpressions::ProhibitMagicNumbers policy has been moved
211 from Perl::Critic::More into the primary Perl::Critic distribution.
214 * Variables::ProhibitUnusedVariables (very dumb, limited initial
216 * ControlStructures::ProhibitLabelsWithSpecialBlockNames
217 Contributed by Mike O'Regan. Kickin' ass, Mike.
220 * ControlStructures::ProhibitUnreachableCode now handles the perl 5.10
221 "//" and "err" operators. RT #36080
222 * InputOutput::RequireBriefOpen now ignores opens of STDIN, STDOUT,
223 and STDERR. You're generally trying to make long-lasting global
224 effects when manipulating these. (RT #35774)
225 * RegularExpressions::ProhibitUnusualDelimiters now supports an
226 "allow_all_brackets" option.
227 * RegularExpressions::RequireBracesForMultiline now supports an
228 "allow_all_brackets" option.
229 * TestingAndDebugging::RequireUseStrict now accepts "use Moose::Role"
230 as equivalent to "use strict". (RT #34838)
231 * TestingAndDebugging::RequireUseWarnings now accepts "use Moose::Role"
232 as equivalent to "use warnings". (RT #34838)
233 * ValuesAndExpressions::ProhibitMagicNumbers now accepts constant
235 * Variables::ProhibitMatchVars no longer detects "use English;".
236 This problem is detected in a more clear way by
237 Modules::RequireNoMatchVarsWithUseEnglish.
238 * Variables::ProhibitPerl4PackageNames no longer complains about
239 $'/$POSTMATCH. RT #36059
240 * Variables::RequireLocalizedPunctuationVars now allows the use of "my".
244 * No longer falls over if a single file has a parse error.
246 New Developer Features:
247 * If a document specifies a minimum perl version, e.g. "use 5.008003",
248 P::C::Document::highest_explicit_perl_version() will tell you what it
250 * The parameter to P::C::Policy::initialize_if_enabled is now a
251 P::C::PolicyConfig object instead of a hash reference.
254 * LOTS of documentation updates.
255 * A few more statistics are emitted by perlcritic with the --statistics
257 * perlcritic --profile-proto now includes policy abstracts in its
261 * Now depends upon PPI 1.203.
262 * New dependency upon version.
264 [1.083_006] Released on 2008-05-20
265 [1.083_005] Released on 2008-05-19
266 [1.083_004] Released on 2008-05-18
267 [1.083_003] Released on 2008-05-17
268 [1.083_002] Released on 2008-05-17
269 [1.083_001] Released on 2008-04-13
271 Changes summarized into 1.084 above. For exact details, see Changes in
272 1.083_006 on BackPAN.
274 [1.082] Released on 2008-03-08
277 * A new metadata system for defining policy parameters/options has been
278 added. This makes the life of policy authors easier because
279 configuration validation and parsing can be taken care of
280 automatically, in most cases. This allows greater integration with
281 IDEs and allows the perlcritic "--profile-proto" option to produce
284 Note: This change does NOT REQUIRE ANY CHANGES to policies outside of
285 this distribution; they should continue to work as is. However, use
286 of this facility can reduce the size of your code and provide the
287 means for tools to discover more about your policy. If this change
288 does break any of your policies, please let us know.
290 To learn how to take advantage of this facility, read
291 Perl::Critic::DEVELOPER and look at the source of any of the
292 configurable policies included in this distribution.
294 There is a discussion of the design considerations for this facility in
295 the source repository under doc/PolicyParameter_Notes.pod.
297 * Added support for "criticism-fatal" option in your perlcriticrc
298 file. This will be used by the criticism pragma to cause execution
299 to abort if the file contains any violations.
302 * Module::RequireNoMatchVarsWithUseEnglish
305 * Added an allow_last_statement_to_be_comma_separated_in_map_and_grep
306 option to ValuesAndExpressions::ProhibitCommaSeparatedStatements.
307 Partial response to http://rt.cpan.org/Public/Bug/Display.html?id=27654.
308 * ControlStructures::ProhibitPostfixControls gains the ability to have
309 the flow control statements allowed to be modified. This in response
311 * TestingAndDebugging::RequireUseStrict now accepts "use Moose" as
312 equivalent to "use strict".
313 * TestingAndDebugging::RequireUseWarnings now accepts "use Moose" as
314 equivalent to "use warnings".
317 * RT #31281 perlcritic doesn't recognize "#!/bin/env perl" shebang
318 * Replace usage of Unicode property escapes with POSIX character classes
319 order to restore 5.6 compatability.
320 * RT #30388 ValuesAndExpressions::ProhibitVersionStrings complained
321 about numbered directories in "use lib".
322 * Fixed handling of badly behaved spelling programs in PodSpelling.
324 [1.081_006] Released on 2008-03-02
325 [1.081_005] Released on 2007-12-29
326 [1.081_004] Released on 2007-12-20
327 [1.081_003] Released on 2007-12-16
328 [1.081_002] Released on 2007-12-16
329 [1.081_001] Released on 2007-12-15
331 Changes summarized into 1.082 above. For exact details, see Changes in
332 1.081_006 on BackPAN.
334 [1.080] Released on 2007-11-11
337 * Allow a "## no critic" statement after a shebang on line 1 of a
338 file. This allows users to block violations that apply to
339 whole files and still allow shebangs.
341 New Policies: (funded by a Perl Foundation grant)
342 * InputOutput::ProhibitExplicitStdin
343 * RegularExpressions::ProhibitFixedStringMatches
344 * RegularExpressions::RequireBracesForMultiline
345 * RegularExpressions::ProhibitUnusualDelimiters
346 * RegularExpressions::ProhibitUnusedCapture
347 * RegularExpressions::ProhibitComplexRegexes
348 * RegularExpressions::ProhibitSingleCharAlternation
349 * RegularExpressions::ProhibitEscapedMetacharacters
350 * RegularExpressions::ProhibitEnumeratedClasses
351 * InputOutput::RequireBriefOpen
352 * InputOutput::RequireCheckedSyscalls
355 * ControlStructures::ProhibitNegativeExpressionsInUnlessAndUntilConditions
358 * Variables::ProhibitConditionalDeclarations now permits you to local-ize
359 variables in conditional declarations. This makes sense, since
360 C<local> is actually a variable modifier, rather than a declaration.
361 Thanks to David Golden for reporting this.
363 New Developer Features:
364 * Perl::Critic::Utils::PPIRegexp encapsulates interaction with
365 the PPI Regexp token classes. Those classes have very sparse
366 APIs, so this package hides away the ugly fiddling with PPI
368 * Added a new optional_modules parameter for the .run syntax.
371 * PPI::Structure::List can now contain multiple children,
372 so P::C::Utils::parse_arg_list() needs to handle it.
374 This was done in the process of fixing
375 http://rt.cpan.org/Ticket/Display.html?id=24924, which was a problem
376 with TestingAndDebugging::RequireTestLabels.
378 * ValuesAndExpressions::ProhibitLongChainsOfMethodCalls wasn't resetting
379 chain length when it ran into the end of a sub-expression.
381 http://rt.cpan.org/Public/Bug/Display.html?id=30040
383 * ValuesAndExpressions::ProhibitCommaSeparatedStatements was reporting
384 false positives when builtins which accept both no and multiple
385 arguments were involved.
387 http://rt.cpan.org/Public/Bug/Display.html?id=27654
390 * Removed all use of Carp in favor of exceptions.
393 * Now requires PPI 1.201. A number of workarounds for PPI bugs have been
395 * New dependency upon Exception::Class.
398 * Use Devel::CheckOS to see whether Perl::Critic is being installed on
399 a Solaris system and warn about tar(1) chopping file names off if it
402 [1.079_003] Released on 2007-10-22
403 [1.079_002] Released on 2007-10-21
404 [1.079_001] Released on 2007-10-09
406 Changes summarized into 1.080 above. For exact details, see Changes in
407 1.079_003 on BackPAN.
409 [1.078] Released on 2007-09-19
411 Restore Perl::Critic::TestUtils::should_skip_author_tests() and
412 get_author_test_skip_message(). Some Perl::Critic add-on distributions
415 [1.077] Released on 2007-09-15
417 Note: if you don't have any problems installing Perl::Critic 1.076, there
418 is no need to upgrade to this version. There are no functionality
419 changes. This release only contains changes related to installation that
420 a few people were experiencing.
423 * Removed build-time use of Readonly, again, due to problems some people
424 were having when trying to compile the code by hand, rather than using
426 * Don't run author tests if there's a .svn directory present because
427 users who grabbed the code from the source repository were executing
428 them and getting failures.
429 * Don't generate optional, module-hiding test wrappers if author tests
433 [1.076] Released on 2007-09-07
435 It appears from reports on the 1.075_001 release that the subroutine
436 sigils were indeed the problem. Release to the general populace.
439 [1.075_001] Released on 2007-09-06
442 Undo the changes in 1.073 and 1.074. Instead, stop using the subroutine
443 sigil in import and export lists. It is suspected that the problem lies
444 with Exporter stripping off ampersands.
446 [1.074] Released on 2007-09-04
449 Repeat the Makefile.PL change on
450 t/generate_without_optional_dependencies_wrappers.PL.
453 [1.073] Released on 2007-09-04
456 Work around problems with the combination of Exporter & Readonly in
457 Makefile.PL on some machines.
459 [1.072] Released on 2007-09-03
462 * The Makefile generated by Makefile.PL was not syntactically correct
463 according to some versions of Solaris. Thanks to Diab Jerius
464 (DJERIUS) for discovery and testing.
465 * Fixed mis-definition of "quiet" value for the "--profile-strictness"
467 * Enhanced testing with the absence of optional modules.
469 [1.071] Released on 2007-08-24
471 The "Brown Paper Bag" Release
474 * Tests would not pass in environments that did not have all optional
475 dependencies installed.
477 [1.07] Released on 2007-08-21
479 New Policies: (funded by a Perl Foundation grant)
480 * BuiltinFunctions::ProhibitBooleanGrep
481 * BuiltinFunctions::ProhibitComplexMappings
482 * Documentation::PodSpelling
483 * InputOutput::ProhibitJoinedReadline
484 * Subroutines::ProhibitManyArgs
485 * Subroutines::RequireArgUnpacking
486 * ValuesAndExpressions::ProhibitImplicitNewlines
487 * Variables::RequireLocalizedPunctuationVars
490 * Subroutines::ProhibitNestedSubs
493 * The "perlcritic --profile-proto" output now includes the "add_themes"
494 parameter for each policy.
495 * The perlcritic "--strict-profile" option has been replaced with a
496 "--profile-strictness" option. This new option takes values of "warn"
497 (the default), "fatal", and "quiet", which controls what happens with
498 ignorable problems in a .perlcriticrc file.
500 New Developer Features:
501 * Perl::Critic::Policy now has an overridable initialize_if_enabled()
502 method which allows a Policy to perform expensive initialization after
503 it has been determined whether the user has it enabled or not. Also,
504 this method allows a Policy to say that it should be disabled
505 regardless of what the user says.
507 Actually, use of this method is now encouraged over using a
511 * Now requires the Readonly module in order to be more self-compliant.
513 [1.061] Released on 2007-07-24
516 * Fix P::C::Theme-- Exporter in Perl 5.6 does not export import(), so you
517 must subclass it. *sigh*
518 * Fix P::C::Config::_validate_and_save_theme()-- eval of an empty string
519 does not reset $@/$EVAL_ERROR in Perl 5.6.
521 Big thanks to Anirvan Chatterjee for identifying and helping debug these
524 [1.06] Released on 2007-06-27
527 * perlcritic now emits errors for all the problems it can find for the
528 global options in the command-line parameters and .perlcriticrc file,
529 rather than bailing on the first one it encounters.
531 * perlcritic now has a "--strict-profile" option which will make warnings
532 about problems in a profile fatal.
534 * perlcritic now has a "--statistics-only" option which suppresses the
535 display of individual violations and only shows the additional output
536 produced by the "--statistics" option.
539 * A value for "color" can now be specified in a .perlcriticrc.
540 http://rt.cpan.org/Ticket/Display.html?id=24877
543 * ValuesAndExpressions::ProhibitQuotesAsQuotelikeOperatorDelimiters
544 As suggested in http://rt.cpan.org/Ticket/Display.html?id=23290.
545 * ValuesAndExpressions::ProhibitLongChainsOfMethodCalls
546 * Modules::ProhibitExcessMainComplexity
547 As suggested in http://rt.cpan.org/Ticket/Display.html?id=24699
550 * The perlcritic "--profile-proto" option now emits the short names for
551 policies, rather than the full ones.
553 * The "-profileproto" and "-singlepolicy" options have been renamed to
554 "-profile-proto" and "-single-policy" in order to make the growing
555 number of command-line options comprehensible. The change of
556 "singlepolicy" also affects your F<.perlcriticrc> file.
558 [1.053] Released on 2007-06-02
560 *DEVELOPMENT RELEASE*
563 Fixed bug in 15_statustics.t test script, which caused the build
564 to fail on machines that don't have Perl::Tidy installed.
566 [1.052] Released on 2007-06-01
568 *DEVELOPMENT RELEASE*
571 * perlcritic now emits a summary about the scanned code when enabled by
572 the "-statistics" option.
575 * InputOutput::ProhibitBacktickOperators can now be configured to only
576 check in void contexts.
579 * 27073: False positive in RequireUpperCaseHeredocTerminator
580 * 27065: CodeLayout::ProhibitTrailingWhitespace breaks under Perl 5.6.1
581 * 26462: ControlStructures::ProhibitCascadingIfElse pod typo
582 * ValuesAndExpressions::ProhibitCommaSeparatedStatements was complaining
583 about multiple values in the list to be iterated over by a foreach loop.
584 * Corrected PBP page numbers for some policies (Quinn Weaver).
586 [1.051] Released on 2007-04-12
588 *DEVELOPMENT RELEASE*
591 No particular bug fixes.
594 * Added several new utility functions to support the StricterSubs distro.
595 Also, some of the existing functions in Perl-Critic-Utils have
596 changed in ways that might break your custom policies.
599 * Updated Emacs plugin (Courtesy Josh ben Jore).
600 See extras/perlcritic.el for details.
601 * Added copy of BBEdit plugin (Courtesy of Josh Clark).
602 See extras/perl_critic_for_bbedit-1_0.zip for details
604 [1.05] Released on 2007-03-19
607 * 25557: t/20_policy_prohibittrailingwhitespace.t fails on Perl 5.8.0
609 [1.04] Released on 2007-03-18
612 * 25008: Subroutines::RequireFinalReturn should allow "throw"
613 * 25085: False Positive - Heredoc terminator must be quoted
614 * 18423: VERSION check does not notice Readonly::Scalar version
615 * 25449: Proposal of $VERSION declaration (DUPLICATE)
618 * CodeLayout::ProhibitTrailingWhitespace
619 * ValuesAndExpressions::ProhibitCommaSeparatedStatements
620 * Variables::ProhibitPerl4PackageNames
623 * Subroutines::RequireFinalReturn can now be configured to recognize
624 your custom functions that behave like "die" or "exit".
625 * Documentation::RequirePodSections can be configured to match
626 Module::Starter:PBP or to really match the PBP book.
628 [1.03] Released on 2007-02-13
631 * Fixed a few more problems with the %f, %F, and %r format escapes.
632 * I forgot to put Conway's perlcriticrc file in the MANIFEST. Sorry.
635 * Perl::Critic::Utils automatically exports everything. However,
636 this is deprecated. In the future, you must request your exports.
639 * Duplicate violations of RequireExcplicitPackage are now squelched,
640 in the same way as RequireUseStrict and RequireUseWarnings.
642 [1.02] Released on 2007-02-11
645 * "undef" incorrectly triggered ProhibitMutatingListFunctions.
646 * 24876: %f and %F escapes not working in custom "verbose" format strings.
647 * 24875: Documentation bug in TestingAndDebugging::ProhibitNoStrict
650 * InputOutput::RequireCheckedOpen
651 * InputOutput::RequireCheckedClose
654 * Added Conway's own suggested Perl::Critic configuration as
655 examples/perlcriticrc-conway.
657 * See the examples/ directory for some neat demonstrations of using
658 the Perl::Critic API. Contributed by Elliot Shank.
661 * Perl::Critic::Utils no longer exports anything by default. Policies
662 outside the distribution will need to specify what exactly they need
663 from this module. There are a number of tags that can be used in
664 addition to individual imports.
666 [1.01] Released on 2007-01-24
668 PRODUCTION RELEASE: You may now consider the public Perl::Critic
669 API as "stable." Future minor releases will focus on bug fixes,
670 new policies, and internal refactoring.
673 * Fixed memory leak. This was reported by the Parrot team at
674 http://rt.perl.org/rt3/Ticket/Display.html?id=41230
676 [0.23] Released on 2007-01-19
679 * 23994: Test 56 in t/05_utils.t of Perl::Critic v0.22 fails
680 * 24005: test 95 in t/13_bundled_policies fails in 0.22
684 * Added '%F' to the Violation format specifications. This will
685 give you just the name of file where the violation occurred
686 (i.e. without the path).
688 * Improved validation of .perlcriticrc file. An invalid
689 default setting will now cause a fatal exception. A
690 strange-looking policy name will cause a warning.
694 * The syntax for theme expressions has changed. Instead of using
695 mathematical operators qw(+ * -) you must now use the logical
696 operators qw(|| && !). See the Perl::Critic docs for more info.
698 * The @GLOBALS and @BUILTINS variables are no longer exported by
699 Perl::Critic::Utils. Use the is_perl_global() and is_perl_builtin()
702 * Perl::Critic::Policy::policy_parameters() has bee renamed to
703 Perl::Critic::Policy::supported_paramters(). This was an
704 undocumented feature anyway, so it shouldn't affect anyone.
707 Other Internal Changes:
708 * Perl::Critic now requires B::Keywords v1.05 or newer.
710 * A few internal classes have been refactored. As a result,
711 Set::Scalar is no longer a required dependency.
714 [0.22] Released on 2006-12-15
717 * Introduced named severity levels: gentle, stern, harsh, cruel, brutal
718 You can use these named levels instead of the numeric ones.
719 For example: "perlcritic --severity=cruel MyModule.pm"
720 Or just: "perlcritic --cruel MyModule.pm"
722 * For perlcritic, the "-List" option has been renamed to
723 "-profileproto". The output now includes the names of the
724 parameters that each Policy supports, if any.
726 * Improved validation of Policy parameters in your F<.perlcriticrc>
727 Any invalid parameter now causes a fatal exception.
730 * Reassigned themes for most policies. Now there are fewer
731 themes and they are organized around programming concepts
732 instead of severity levels. If you have assigned your own
733 themes to any Policies, they should still work as expected.
736 * ErrorHandling::RequireCarping will not complain if it can figure
737 out that the die or warn message will always end in a newline
738 ("\n"). The idea is that, if you put the newline there, you
739 don't indend for there to be any file/line/stack information
740 emitted, in which case you really don't want carp/croak.
742 You can restore the old strict behavior by giving the policy
743 a false value for "allow_messages_ending_with_newlines" in your
748 Added single-letter uppercase alternatives for some perlcritic options.
750 [0.21_01] Released on 2006-12-03
753 * TestingAndDebugging::ProhibitProlongedStrictureOverride
754 * ControlStructures::ProhibitMutatingListFunctions
757 * Say "perlcritic -List" to get an expanded listing of all Policies.
758 The format is suitable for use as your .perlcriticrc file.
759 * Say "perlcritic -doc PATTERN" to get the documentation for all
760 Policies that match m/PATTERN/imx. This is a little easier than
761 typing in the full name of the Policy module with "perldoc".
762 * Say "perlcritic --singlepolicy PATTERN" to use one and only one
764 * Can now specify exceptions to Variables::ProhibitPackageVars,
765 for packages like File::Find that only interface through
769 * 21713 false positive for parens used with substr and unpack.
770 * 22890 allow Rcs keywords in POD.
773 * Testing system overhauled. Details on the Policy/subtest
774 framework is in t/run.t.
775 * Added Perl::Critic::Utils::words_from_string. This is safer
776 than plain old C<split /\s+/>.
778 [0.21] Released on 2006-11-05
781 * BuiltinFunctions::ProhibitReverseSortBlock
782 * BuiltinFunctions::ProhibitVoidGrep
783 * BuiltinFunctions::ProhibitVoidMap
784 * CodeLayout::RequireConsistentNewlines
785 * Modules::RequireFilenameMatchesPackage
786 * TestingAndDebugging::RequireTestLabels
787 * ValuesAndExpressions::ProhibitMismatchedOperators
790 * Introduced policy "themes." Themes are arbitrary names that can
791 be used to identify a group of related Policies. You can select
792 your favorite policies by combining themes in a mathematic expression
793 such as "pbp * (danger + risky)". See POD for details.
794 * perlcritic output is colorized if you have Term::ANSIColor. This
795 only works on non-Win32 platforms. Use -nocolor switch to disable.
796 * Say "perlcritic -count" to get just the the total number of
797 violations per file. Use this feature to quickly identify hot-spots.
798 * Use the -only switch to choose only from policies mentioned in your
799 .perlcriticrc file. This is useful if you usually only want to
800 work with a small subset of the policies.
801 * Default values for most of the perlcritic and Perl::Critic options
802 can now be defined in your .perlcriticrc file. See POD for details.
805 * 21236: wrong page number for "printing to filehandles"
806 * 21916: File handle ... wrong page reference in PBP [DUPE]
807 * 21714: false positive for capture var used in ternary condition
808 * 21718: No skip for File::Slurp in includes.t
809 * ProhibitBarewordFilehandles doesn't complain if you open
810 STDIN, STDOUT or STDERR.
811 * Parrot 40564: Subroutines::RequireFinalReturn should allow die,
813 * Each "for" and "foreach" loop now adds one point to the McCabe
817 * The internals of Perl::Critic have been significantly refactored,
818 but should still be compatible with existing third-party Policies.
819 * Added author-only tests to the release, but disabled by default
820 * New Perl::Critic::Utils::shebang_line() method
821 * Support for filename-based policies
822 * Additional prerequisite: Set::Scalar
823 * Now requires PPI version 1.118
825 [0.20] Released on 2006-09-10
827 Perl::Critic now requires PPI version 1.117, which fixes
828 several bugs that were introduced in version 1.116.
831 * 21079: grep clears @SITE_POLICIES
832 * 21352: Test failures with PPI 1.117
833 * 11365: sub DESTROY detected as a builtin homonym
835 [0.19] Released on 2006-08-20
838 * BuiltinFunctions::ProhibitStringySplit
839 * ControlStructures::ProhibitDeepNests
840 * RegularExpressions::ProhibitCaptureWithoutTest
841 * Variables::RequireLexicalLoopIterator
844 * "perlcritic -quiet" suppresses the "source OK" message.
845 * Variables::ProhibitPunctuationVars is now configurable.
848 * 20965: "Hard tabs used at" shouldn't check __DATA__
849 * 21070: ProhibitNoisyQuotes hates overload
850 * Punctuation variables are now exempt from ProhibitLocalVars
853 * Test coverage is now over 95%
855 [0.18_01] Released on 2006-08-06
858 * Variables::RequireNegativeIndices
859 * InputOutput::ProhibitInteractiveTest
860 * ErrorHandling::RequireCarping
863 * RequireTidyCode tests fail if user has custom .perltidyrc file
864 * 20612: RequirePerlTidy was ignoring HEREDOCs
865 * 20659: __END__ statement considered "unreachable"
866 * Fix for PPI::XS (no C<use overload '""'> support)
867 * Support for 'goto' in ProhibitAmpersandSigils and
868 Subroutines::RequireFinalReturn
870 Performance Enhancements:
871 * Introduced Perl::Critic::Document class. This is a facade for
872 PPI::Document which internally caches search results. This
873 reduces the running time by about 35%. The facade should be
874 invisible, unless you are doing something really sneaky.
875 * Extraction of the 'diagnostics' information is postponed
876 until it is really needed. Speedup has not been measured.
877 * Calls to helper-subs have been reordered for maximum efficiency.
880 * Includes updated version of perlcritic mode for emacs. See
881 "extras/perlcritic.el" for details.
883 [0.18] Released on 2006-07-16
886 * 14855: Home discovery is dangerously naive.
887 * 20060: Incorrect page numbers in ProhibitLeadingZeros
888 and RequireNumberSeparator policies.
889 * 20068: .perlrc file - inconsistent documentation
890 * 20254: "use vars qw(@EXPORT_OK)" not recognized
891 * 20463: No-case heredoc terminator incorrectly detected as lower case.
892 * ProhibitOneArgBless doesn't understand "bless {} => $class;"
893 * ProhibitExcessComplexity doesn't count 'while' and 'until' stmnts
894 * ProhibitLeadingZeros was falsely hits '.0456'
897 * If File::HomeDir is available, we use it to locate the
898 .perlcriticrc file. This should help make Perl::Critic
899 more portable to Win32 platforms. If File::HomeDir is
900 not installed, we resort to looking at the usual
901 environment variables.
904 * Added "perlcritic.el", which is a super-cool emacs minor-mode
905 that runs perl-critic on the current buffer and returns the
906 results in a sexy hot-linked "compiler" window. You can run
907 it on demand, or have it run automatically every time you
908 save the buffer. You can find this in the extras/ directory.
909 Thanks to Josh ben Jore for contributing this.
911 * Moved "Perl::Critic::TestUtils" into the installed build. This
912 module is only used for unit-testing Perl::Critic, but we
913 are putting it in the installation so folks who want to
914 extend Perl::Critic can make use of it.
916 [0.17] Released on 2006-06-13
919 * 19836: Perl-Critic0.16 fails tests during install. This was
920 caused by a bug in version 3.01 of Module::Pluggable. See
921 http://rt.cpan.org/Ticket/Display.html?id=19857 for details.
922 * Fixed bug in no-critic pragma parser.
925 * ValuesAndExpressions::ProhibitEscapedCharacters
926 * BuiltinFunctions::RequireSimpleSortBlock
929 * Perl::Critic can export critique() as a static function. This
930 may appeal to folks who dislike the object-oriented interface.
932 [0.16] Released on 2006-05-14
935 * Perl::Critic->critique() now accepts a PPI::Document as the
936 argument. This feature creates an additional dependency on
937 Scalar::Util, but that shouldn't be a problem because it is
938 included with List::Util, which we already use.
941 * Increased PPI dependency from v1.110 to v1.112
943 [0.15_03] Released on 2006-05-07
946 * The "## no critic" feature is now implemented without eval-ing
947 the code. This keeps Perl::Critic pure and safe :)
948 * 19082: Page number for AUTOLOAD is incorrect
951 * ControlStructures::ProhibitUnreachableCode (by Peter Guzis)
952 * Modules::ProhibitAutomaticExportation
953 * ValuesAndExpressions::ProhibitVersionStrings
955 [0.15_02] Released on 2006-04-26
958 * Reimplemented the '##no critic' pragmas to have effect on the
959 line where the violation is reported, not on the line where
960 the candidate element lives. This is because some policies
961 may report violations that are nowhere near the element that
963 * RequireUseStrict, RequireUseWarnings, and RequireExplcitPackage
964 all emit violations for _every_ statement that violates the
965 Policy. This closes a loophole that allowed you to circumvent
966 the Policy by using '## no critic' on just the first statement
967 that violated the policy.
968 * Fixed the workaround for the magic shebang that is inserted
969 by EU::MM and M::B. This had stopped working around version 13.
970 * Fixed -noprofile option on 'perlcritic'. This also had stopped
971 working at some point.
973 [0.15_01] Released on 2006-04-16
976 * Added diagnostic messages if the .perlcriticrc contains entries
977 for Policy modules that don't seem to exist.
978 * Now you can specify which policies to disable with the
979 "## no critic" pseudo-pragmas. This feature is still
980 experimental. See docs for details.
981 * perlcritic's directory searching now skips backup files, such
982 as *.swp, *.bak and *~. It also ignores version control system
983 directories, and the blib directory in module build directories.
986 * 18386: Bad example in POD for Documentation::RequirePodSections
987 * 18670: Test failure if Perl::Tidy is not installed
988 * 18698: Policy idea ProhibitUniversalFunctions (see New Policies)
989 * RequireInterpolationOfMetachars falsely hit strings like 'foo=s@'
990 which are commonly used with Getopt::Long.
993 * BuiltinFunctions::ProhibitUniversalCan (by Chris Dolan)
994 * BuiltinFunctions::ProhibitUniversalIsa (by Chris Dolan)
997 * All spurrious options for `perlcritic` are now fatal.
998 * Changed several of the -verbose formats to be more readable.
999 * Explicit -severity option now overrides -[12345] shortcuts instead
1000 of being the other way around.
1004 [0.15] Released on 2006-03-26
1007 * 17964: Insists my code is not tidy (may not be fixed for all cases)
1009 [0.14_02] Released on 2006-03-19
1012 * 15653: False positive in OneArgSelect (fixed for real this time)
1015 * ClassHierarchies::ProhibitAutoloading
1016 * Documentation::RequirePodSections
1017 * InputOutput::RequireBracedFileHandleWithPrint
1018 * ValuesAndExpressions::ProhibitMixedBooleanOperators
1019 * Variables::RequireInitializationForLocalVars
1021 [0.14_01] Released on 2006-03-05
1024 * 14731: False positive: Builtin function called with parens
1025 * 17554: False positive in CodeLayout::RequireTrailingCommas
1028 * ClassHierarchies::ProhibitExplicitISA
1029 * InputOutput::ProhibitReadlineInForLoop
1030 * Miscellanea::ProhibitFormats
1031 * Miscellanea::ProhibitTies
1032 * Variables::ProhibitConditionalDeclarations
1034 [0.14] Released on 2006-01-29
1036 More documentation edits.
1039 * Documentation::RequirePodAtEnd
1040 * Subroutines::ProtectPrivateSubs
1041 * Variables::ProhibitMatchVars
1042 * Variables::ProtectPrivateVars
1045 * 15295: "## no critic" pragmas too aggresive on compound statements.
1046 * t/01_config.t failed in the presence of third-party policies
1048 [0.13_05] Not released
1050 More documentation edits.
1052 Implemented workaround for failing pod_coverage tests.
1055 * 16906: tr/// created false-postives with RegularExpression polices.
1057 [0.13_04] Released on 2005-12-31
1059 Moved DEVELOPER.pod file into the Perl/Critic dir.
1061 More documentation edits.
1063 [0.13_03] Released on 20051230
1065 perlcritic now prints 'source OK' if it doesn't find any
1066 violations. This gives folks a warm fuzzy feeling.
1068 Tweaked some test cases that were failing on my Solaris
1069 environment at work.
1071 [0.13_02] Released on 2005-12-29
1073 Fixed Config to recognize fully-qualified module names in the
1076 Various documentation edits.
1078 [0.13_01] Released on 2005-12-28
1080 Replaced 'priority' concept with 'severity'. Now each Policy module
1081 has a predefined severity level ranging from 1 to 5. By default,
1082 perlcritic only reports the most severe violations. You can adjust
1083 the severity threshold at the command line, and you can change
1084 the severity for any Policy using the config file.
1086 Chris implemented the applies_to() mechanism, which allows each Policy
1087 class to declare the types of PPI elements that it wants to examine.
1088 When traversing the document, Perl::Critic invokes the Policy only
1089 for elements that are of the correct type. This improves performance
1092 Perl::Critic now uses a Plugin architecture to automatically
1093 discover Policy modules. So if you have custom Policies, all you
1094 have to do is install them in the Perl::Critic::Policy namespace --
1095 no need to add anything to your .perlcriticrc file. If you write
1096 policies in a different namespace, you can configure that too. See
1097 the Perl::Critic::Config docs for details.
1100 * Modules::RequireEndWithOne
1101 * NamingConventions::ProhibitAmbiguousNames
1102 * References::ProhibitDoubleSigils
1103 * Subroutines::RequireFinalReturn
1104 * Subroutines::ProhibitAmpersandSigils
1105 * Subroutines::ProhibitExcessComplexity
1106 * TestingAndDebugging::ProhibitNoStrict
1107 * TestingAndDebugging::ProhibitNoWarnings
1110 * 15101: Plugin architecture improves support for 3rd-party code
1111 * 16319: Fixed incorrect PBP page number in ProhibitBarwordFilehandle
1112 * 16321: Lists of empty quotes are now allowed by ProhibitQuotedWordLists
1113 * 16288: Empty lists caused a fatal error RequireTrailingCommas
1114 * 15653: Fixed false positive in OneArgSelect.
1116 [0.13] Released on 2005-10-31
1118 Official release of 0.12_03. No code major changes.
1120 [0.12_03] Not released
1122 Renamed -Policy option to -include. Added -exclude to give the
1125 Refactored constructor of Perl::Critic. Now, most of the work
1126 is delegated to Perl::Critic::Config. I'm not sure I like how
1127 this turned out, but we'll see how it goes.
1129 Renamed some Policy modules to be a bit more comprehensible. Note
1130 that you may need to change your .perlcriticrc file accordingly.
1131 I also suggest removing your current Perl::Critic installation
1132 before installing this one.
1135 * ProhibitUnpackagedCode => RequireExplicitPackage
1136 * RequireQuotedWords => ProhibitQuotedWordLists
1138 Improved error message when Perl::Critic dies because PPI can't
1139 parsee the input code.
1141 Changed output of -help to be more terse.
1145 [0.12_02] Not released
1147 Added -Policy option to perlcritic. The idea is to provide a
1148 compact interface for selecting Policy modules at the command-line.
1149 This feature is experimental and subject to change.
1151 Added a warning message if -verbose value looks strange. In most
1152 applications, the -verbose option does not require a value, so people
1153 might be puzzled when they write 'perlcritic -verbose my_file.pm' and
1154 nothing seems to happen.
1156 Command-line options to perlcritic are now case-sensitive. This
1157 makes it easier to abbreviate options that start with the same letters
1158 (e.g. 'Version' and 'verbose')
1160 Fixed the new Policy modules that were misnamed and misplaced in the
1161 previous distribution.
1163 [0.12_01] Not released
1165 Rewrote some of the ControlStructures and BuiltinFunction
1166 policies to be simpler (and probably a little faster).
1168 Edited POD. Fixed some typos. Added PREREQUISITES section
1169 to Perl::Critic documentation.
1171 Fixed the -verbose FORMAT option so that you can put metachars
1172 in the FORMAT specification. If using perlcritic, be careful to
1173 protect them from getting munged by the shell first.
1175 Replaced ProhibitRequireStatements with RequireBarewordIncludes
1176 module. Courtesy of Chris Dolan <cdolan@cpan.org>
1178 Added configuration to ProhibitInterpolationOfLiterals so that
1179 certain flavors of quotes can be exempt. This is for folks who
1180 have configured their editor to use special syntax highlighting
1181 for certain kinds of strings (SQL, for example).
1183 perlcritic now accepts multiple file arguments, so now you can
1184 critique your entire distribution in one shot. As a result, the
1185 output-formats have changed slightly.
1188 * BuiltinFunctions::ProhibitLvalueSubstr
1189 * BuiltinFunctions::ProhibitSleepViaSelect
1190 * ClassHierarchies::ProhibitOneArgBless
1191 * CodeLayout::RequireTrailingCommas
1192 * CodeLayout::RequireQuotedWordLists
1193 * InputOutput::ProhibitTwoArgOpen
1194 * InputOutput::ProhibitOneArgSelect
1195 * InputOutput::ProhibitBarewordFileHandles
1196 * Miscellanea::RequireRcsKeywords
1197 * Modules::RequireVersionVar
1198 * RegularExpressions::RequireExtendedFormatting
1199 * RegularExpressions::RequireLineBoundaryMatching
1203 14923: 'require' is now permitted. See RequireBarewordIncludes.
1204 15022: Fixed false-positives when keywords are used as hash keys.
1205 15023: Fixed spurious Violations by removing magic shebang.
1206 15031: Fixed spelling mistakes (and probably added some new ones).
1207 15233: Postfix 'if' is now allowed with 'die', 'croak', etc.
1209 [0.12] Released 2005-10-10
1211 Redesigned the 'verbose' feature. Now the output format
1212 can be user-defined using a sprintf-like specification.
1213 perlciritc also has a predefined output format that is
1214 compatible with grep mode in editors like vim and emacs.
1216 'return' is now exempt from ProhibitParensWithBuiltins. I may
1217 extend this exemption to all unary functions.
1219 Edited POD. Added a super brief description of each policy
1220 in the main Perl::Critic documentation. Added details about
1223 Additional Prerequisites:
1228 The internal dynamics and API of Perl::Critic have changed
1229 considerably. The result is a 300% increase in performance.
1230 See the POD in Perl::Critic::Policy for details.
1233 * Added -verbose option to put more stuff in the output. In the
1234 extreme, you can get the POD from Policy attached to each
1235 and every violation.
1237 Additional Prerequisites:
1241 [0.10] Released 2005-10-05
1243 Fixed stupid bug in newest Policy modules. They were returning
1244 PPI objects instead of Perl::Critic::Violation objects. Doh!
1246 Fixed test scripts to prevent failures if the user already has a
1249 'ProhibitHardTabs' now allows leading tabs by default.
1251 Put the Changes file in reverse-chronological order, so the most
1252 recent stuff is easy to find at the top of the file
1254 [0.09] Released 2005-10-04
1257 * 14810: Now you are allowed to create your own 'import' function,
1258 since this is frequently done with fancy modules.
1259 * 14817: Parens, brackets, and braces are now excluded from
1260 'ProhibitNoisyQuotes' since they look better in quotes anyway.
1261 * 14787: $1..$9 and '_' are exempt from ProhibitPunctuationVars
1262 * 14899: Object methods with the same name as a built-in can
1263 be called with parens (ProhibitParensWithBuiltins).
1264 * 14901: Normalized the exit status of perlcritic to 0, 1, or 2.
1265 See documentation for explanation.
1266 * 14855: Partially fixed home directory discovery. Still not
1267 completely portable, but at least doesn't create warnings.
1270 * 14734: Limit for number separators is now configurable
1273 * CodeLayout::ProhibitHardTabs
1274 * ControlStructures::ProhibitUnlessBlocks
1275 * ControlStructures::ProhibitUntilBlocks
1276 * ControlStructures::ProhibitCStyleForLoops
1278 Changed the syntax for the magic comments. Adam had the
1279 idea of using a pragma-like notation. I liked it.
1281 [0.08_2] Released 2005-09-27
1283 Fixed problems with Perl::Critic::Config that caused File::Spec
1284 to emit 'uninitialized value' warnings during the build.
1286 Added 1 Policy module contributed by Graham TerMarsch
1288 Switched from File::Spec::Functions to plain File::Spec because
1289 I think its usage is more common.
1291 Removed 'FindBin' from the test files so I can be sure that the
1292 right libraries are getting loaded. This means I'll have to
1293 use the -l option with C<prove>.
1297 [0.08_01] Not released
1299 Fixed "ProhibitParensWithBuiltins" to allow parens to be used with
1300 object method calls that have the same name as a builtin functions.
1302 Introduced magical comments that allow developers to configure
1303 Perl::Critic on-the-fly from within their code.
1305 Added META.yml files and POD tests to the build. I did this
1306 mostly just to boost the Kwalitee score on CPANTS.
1308 Switched from "Config::Std" to "Config::Tiny" because it doesn't
1309 require those fancy Damian modules that don't seem to work on
1310 some older versions of Perl.
1312 [0.07] Released on 2005-09-21
1314 Fixed bugs in the ProhibitCascadingIfElse policy.
1316 Added ProhibitExplicitReturnUndef policy
1318 Made ProhibitUnpackagedCode configurable so you can exempt scripts,
1319 which typically don't have an explicit 'package' statement.
1321 ProhibitPackageVars policy now exempts vars in ALL_CAPS. This
1322 is to permit common package variables like @EXPORT and $VERSION.
1324 Renamed "ProhibitStringyGrep and "ProhibitStringyMap" because
1325 the so-called string form doesn't really exist. Now called
1326 "RequireBlockGrep" and "RequireBlockMap"
1328 Corrected documentation on defining Policy names within the
1329 configuration file. This still isn't very clear and needs
1332 Perl::Critic now requires PPI version 1.003, which has a few bug
1335 Rewrite some code just to make Perl::Critic more self-compliant.
1337 Added test cases to verify the configuration functionality. These
1338 are not completely thorough and need more work.
1340 [0.06] Released on 2005-09-17
1342 Now called 'Perl::Critic'.
1344 Added 4 new policy modules.
1346 Fixed bugs in build process.
1348 Added support for Module::Build.
1350 [0.05] Released on 2005-09-17
1352 End of 'Perl::Review' releases. I have changed the name to
1353 'Perl::Critic' to avoid possible confusion with "The Perl Review"
1356 [0.04] Released on 2005-09-14
1358 Version 0.03 was a bust because I uploaded the wrong tarball to PAUSE.
1360 [0.03] Released on 2005-09-13.
1362 Fixed some POD links.
1364 Removed test cases for missing policy module.
1366 [0.02] Released on 2005-09-13.
1368 Major overhaul based on feedback from Perl community.
1370 Factored coding standards into separate modules (known as
1371 Policies). The idea here is to allow other developers to easily
1372 contribute additional coding standards.
1374 Reworked Perl::Review into a simple engine for loading and running
1377 Gave perlreview a command-line interface and configuration file
1378 for selecting which Policy modules to use.
1380 [0.01] Released on 2005-08-16.
1384 ##############################################################################
1389 ##############################################################################
1391 # ex: set ts=8 sts=4 sw=4 tw=78 ft= expandtab shiftround :