1 [1.xxx] Released on 2008-xx-xx
3 New Developer Features:
4 * Perl::Critic::Policy::is_document_exempt() has been renamed to
5 prepare_to_scan_document() and the sense of the return value has been
6 reversed in order to make it indicative of being more generally useful.
9 * Modules::ProhibitEvilModules now allows you to specify what the
10 description of a use of a bad module should be, to, say, suggest that
11 people use autodie instead of Fatal.
12 * InputOutput::RequireCheckedClose, InputOutput::RequireCheckedOpen, and
13 InputOutput::RequireCheckedSyscalls now all support autodie.
14 Unfortunately, autodie is currently treated like a module and not a
15 pragma, which means that the lexical scoping is not taken into account.
17 [1.093_01] Released on 2008-09-07
19 New Developer Features:
20 * Perl::Critic::Policy::is_document_exempt() is checked prior to scanning
21 and thus can speed things up.
24 * Miscellanea::RequireRcsKeywords couldn't find keywords after __END__
25 that didn't look like part of POD.
26 * Modules::RequireFilenameMatchesPackage would incorrectly complain about
27 programs. Yet more greatness contributed by Schwern. RT #39024.
29 [1.092] Released on 2008-09-02
32 * Fixed POD errors that were causing build failures. Sorry
35 [1.091] Released on 2008-09-01
38 * RegularExpressions::RequireDotMatchAnything
41 * perlcritic now supports a -pager option, so you can more easily
42 send the output to your favorite pager. You can set this option
43 on the command-line or in your .perlcriticrc file. See the
44 perlcritic perldoc for more details. Credit to Michael Schwern.
45 * The output from "perlcritic -doc PATTERN" will be automatically
46 sent to your pager if you have set the -pager option.
49 * CodeLayout::ProhibitQuotedWordLists no longer applies if the list
50 contains any non-words, by default. A non-word is anything that does
51 not match /[\w-]+/. You can restore the former behavior by setting the
52 "strict" option. RT #37886.
53 * CodeLayout::ProhibitQuotedWordLists also now applies to the import
54 arguments of a C<use> statement. RT #24467.
55 * ErrorHandling::RequireCheckingReturnValueOfEval now recognizes ternary
56 left-sides as valid checks.
57 * RegularExpressions::RequireExtendedFormatting gains a
58 minimum_regex_length_to_complain_about option. Also, regexes that
59 contain only word and whitespace characters are now exempt from this
60 policy, by default; you can make it complain about them by turning on
61 the new strict option. Contributed by Michael Schwern. RT #38531.
62 * TestingAndDebugging::ProhibitNoWarnings now supports a
63 allow_with_category_restriction option, thanks to Michael Schwern.
65 * CodeLayout::ProhibitHardTabs now allows leading tabs in qw() word lists
66 and regexes with the /x modifier. You can still configure this
67 policy to forbid all hard tabs, if you like. RT #32440
70 * perlcritic should now work under PAR. RT #38380.
71 * URL for our repository in META.yml now works for anonymous
72 checkout. The password is "" (empty). RT #38628.
73 * color for high-severity violations is now magenta because
74 it is more redable than yellow on white backgrounds. RT #38511.
76 [1.090] Released on 2008-07-22
79 * Test was incorrectly failing when Regexp::Parser wasn't installed.
81 [1.089] Released on 2008-07-21
84 * -s is now a synonym for --single-policy.
87 * Subroutines::ProhibitBuiltinHomonyms now also prohibits subroutines
88 with the same name as a Perl keyword (e.g. if, foreach, while).
89 Inspired by RT #37632.
90 * Subroutines::ProtectPrivateSubs now allows expressions like
91 "shift->_some_private_method();". Note that this *only* applies
92 to the "shift" function -- a private method call on the right of any
93 other bareword still causes a violation. RT #34713.
94 * Subroutines::RequireFinalReturn now includes exec in the set of things
95 that mark a successful return. RT #37672
96 * ValuesAndExpressions::ProhibitInterpolationOfLiterals now takes a
97 allow_if_string_contains_single_quote option. Contributed by Ed
98 Avis <ed@membled.com>. RT #36125.
99 * ValuesAndExpressions::RequireInterpolationOfMetachars now supports a
100 rcs_keywords option to allow for the common case where those require
104 * BuiltinFunctions::ProhibitSleepViaSelect would complain if there were
105 three undefs as arguments to select(), but one of them was the timeout.
107 * Reduced false positives in
108 RegularExpressions::ProhibitSingleCharAlternation. Thanks to
109 Andy Lester and Elliot Shank test cases.
110 * RegularExpressions::ProhibitUnusedCapture would complain if there were
111 multiple captures used in a substitution, e.g. s/(.)(.)/$2$1/.
112 * Subroutines::ProhibitAmpersandSigils no longer complains about
114 * Makefile.PL, Build.PL and other ".PL" scripts which typically do not
115 have a shebang are no longer mistaken as modules. This prevents
116 spurious warnings from Modules::RequireEndWithOne. RT #20481.
119 * Tests are now self compliant.
121 [1.088] Released on 2008-07-04
124 * ErrorHandling::RequireCheckingReturnValueOfEval
127 * ValuesAndExpressions::ProhibitLeadingZeros now accepts octal numbers
128 for the Unix permissions argument to chmod, dbmopen, mkdir, sysopen, or
129 umask, by default. Use the "strict" option to get the old behavior.
131 * Due to the consensus at YAPC::NA 2008,
132 Variables::ProhibitUnusedVariables default severity has been raised to
136 * The perlcritic "--Version" option is now "--version" in order to act
137 like the rest of the world.
139 [1.087] Released on 2008-06-21
142 * CodeLayout::ProhibitParensWithBuiltins no longer complains about
144 * TestingAndDebugging::RequireUseWarnings will not complain about files
145 that contain a "use 5.005" statement or similar for perls prior to 5.6.
146 Lesson of the day: computer conferences where you can meet in the real
147 world can clarify conversations greatly. Good to finally meet you Adam.
148 * InputOutput::ProhibitTwoArgOpen similarly will not complain if there's
149 a "use/require 5.005" statement in the file. RT #34385.
152 * Perl::Critic can now critique a file named "0". However, PPI will give
153 a parse error until the next version comes out. Fixes RT #36127.
154 * Moved detection of the lack of any enabled Policies from P::C::Config
155 to Perl::Critic. This was causing the perlcritic.t in Parrot to fail.
156 Note, however, there are plans afoot to change how Perl::Critic is
157 configured and things that depend upon that may break. Please contact
158 users@perlcritic.tigris.org and tell us how you're using P::C::Config
159 directly so that we can take your needs into account.
161 [1.086] Released on 2008-06-12
164 * NamingConventions::ProhibitAmbiguousNames now specifies the name that
165 it had problems with in its violation descriptions.
168 * The color option wasn't being correctly set from a .perlcriticrc.
172 * --colour is now a synonym for --color.
174 [1.085] Released on 2008-06-07
177 * Documentation::RequirePackageMatchesPodName
180 * Variables::ProhibitUnusedVariables detects a few more cases. It's
181 still very limited, though.
184 * ControlStructures::ProhibitUnreachableCode didn't notice "until" was an
185 conditional expression.
187 Minor documentation updates.
189 [1.084] Released on 2008-05-24
192 * perlcritic now supports a --list-themes option.
193 * You can specify the maximum number of violations you want per Policy
194 per document. Developers can give a default value for this for a
195 Policy by overriding default_maximum_violations_per_document().
196 See RequireUseStrict and ProhibitMagicNumbers for examples.
199 * The ValuesAndExpressions::ProhibitMagicNumbers policy has been moved
200 from Perl::Critic::More into the primary Perl::Critic distribution.
203 * Variables::ProhibitUnusedVariables (very dumb, limited initial
205 * ControlStructures::ProhibitLabelsWithSpecialBlockNames
206 Contributed by Mike O'Regan. Kickin' ass, Mike.
209 * ControlStructures::ProhibitUnreachableCode now handles the perl 5.10
210 "//" and "err" operators. RT #36080
211 * InputOutput::RequireBriefOpen now ignores opens of STDIN, STDOUT,
212 and STDERR. You're generally trying to make long-lasting global
213 effects when manipulating these. (RT #35774)
214 * RegularExpressions::ProhibitUnusualDelimiters now supports an
215 "allow_all_brackets" option.
216 * RegularExpressions::RequireBracesForMultiline now supports an
217 "allow_all_brackets" option.
218 * TestingAndDebugging::RequireUseStrict now accepts "use Moose::Role"
219 as equivalent to "use strict". (RT #34838)
220 * TestingAndDebugging::RequireUseWarnings now accepts "use Moose::Role"
221 as equivalent to "use warnings". (RT #34838)
222 * ValuesAndExpressions::ProhibitMagicNumbers now accepts constant
224 * Variables::ProhibitMatchVars no longer detects "use English;".
225 This problem is detected in a more clear way by
226 Modules::RequireNoMatchVarsWithUseEnglish.
227 * Variables::ProhibitPerl4PackageNames no longer complains about
228 $'/$POSTMATCH. RT #36059
229 * Variables::RequireLocalizedPunctuationVars now allows the use of "my".
233 * No longer falls over if a single file has a parse error.
235 New Developer Features:
236 * If a document specifies a minimum perl version, e.g. "use 5.008003",
237 P::C::Document::highest_explicit_perl_version() will tell you what it
239 * The parameter to P::C::Policy::initialize_if_enabled is now a
240 P::C::PolicyConfig object instead of a hash reference.
243 * LOTS of documentation updates.
244 * A few more statistics are emitted by perlcritic with the --statistics
246 * perlcritic --profile-proto now includes policy abstracts in its
250 * Now depends upon PPI 1.203.
251 * New dependency upon version.
253 [1.083_006] Released on 2008-05-20
254 [1.083_005] Released on 2008-05-19
255 [1.083_004] Released on 2008-05-18
256 [1.083_003] Released on 2008-05-17
257 [1.083_002] Released on 2008-05-17
258 [1.083_001] Released on 2008-04-13
260 Changes summarized into 1.084 above. For exact details, see Changes in
261 1.083_006 on BackPAN.
263 [1.082] Released on 2008-03-08
266 * A new metadata system for defining policy parameters/options has been
267 added. This makes the life of policy authors easier because
268 configuration validation and parsing can be taken care of
269 automatically, in most cases. This allows greater integration with
270 IDEs and allows the perlcritic "--profile-proto" option to produce
273 Note: This change does NOT REQUIRE ANY CHANGES to policies outside of
274 this distribution; they should continue to work as is. However, use
275 of this facility can reduce the size of your code and provide the
276 means for tools to discover more about your policy. If this change
277 does break any of your policies, please let us know.
279 To learn how to take advantage of this facility, read
280 Perl::Critic::DEVELOPER and look at the source of any of the
281 configurable policies included in this distribution.
283 There is a discussion of the design considerations for this facility in
284 the source repository under doc/PolicyParameter_Notes.pod.
286 * Added support for "criticism-fatal" option in your perlcriticrc
287 file. This will be used by the criticism pragma to cause execution
288 to abort if the file contains any violations.
291 * Module::RequireNoMatchVarsWithUseEnglish
294 * Added an allow_last_statement_to_be_comma_separated_in_map_and_grep
295 option to ValuesAndExpressions::ProhibitCommaSeparatedStatements.
296 Partial response to http://rt.cpan.org/Public/Bug/Display.html?id=27654.
297 * ControlStructures::ProhibitPostfixControls gains the ability to have
298 the flow control statements allowed to be modified. This in response
300 * TestingAndDebugging::RequireUseStrict now accepts "use Moose" as
301 equivalent to "use strict".
302 * TestingAndDebugging::RequireUseWarnings now accepts "use Moose" as
303 equivalent to "use warnings".
306 * RT #31281 perlcritic doesn't recognize "#!/bin/env perl" shebang
307 * Replace usage of Unicode property escapes with POSIX character classes
308 order to restore 5.6 compatability.
309 * RT #30388 ValuesAndExpressions::ProhibitVersionStrings complained
310 about numbered directories in "use lib".
311 * Fixed handling of badly behaved spelling programs in PodSpelling.
313 [1.081_006] Released on 2008-03-02
314 [1.081_005] Released on 2007-12-29
315 [1.081_004] Released on 2007-12-20
316 [1.081_003] Released on 2007-12-16
317 [1.081_002] Released on 2007-12-16
318 [1.081_001] Released on 2007-12-15
320 Changes summarized into 1.082 above. For exact details, see Changes in
321 1.081_006 on BackPAN.
323 [1.080] Released on 2007-11-11
326 * Allow a "## no critic" statement after a shebang on line 1 of a
327 file. This allows users to block violations that apply to
328 whole files and still allow shebangs.
330 New Policies: (funded by a Perl Foundation grant)
331 * InputOutput::ProhibitExplicitStdin
332 * RegularExpressions::ProhibitFixedStringMatches
333 * RegularExpressions::RequireBracesForMultiline
334 * RegularExpressions::ProhibitUnusualDelimiters
335 * RegularExpressions::ProhibitUnusedCapture
336 * RegularExpressions::ProhibitComplexRegexes
337 * RegularExpressions::ProhibitSingleCharAlternation
338 * RegularExpressions::ProhibitEscapedMetacharacters
339 * RegularExpressions::ProhibitEnumeratedClasses
340 * InputOutput::RequireBriefOpen
341 * InputOutput::RequireCheckedSyscalls
344 * ControlStructures::ProhibitNegativeExpressionsInUnlessAndUntilConditions
347 * Variables::ProhibitConditionalDeclarations now permits you to local-ize
348 variables in conditional declarations. This makes sense, since
349 C<local> is actually a variable modifier, rather than a declaration.
350 Thanks to David Golden for reporting this.
352 New Developer Features:
353 * Perl::Critic::Utils::PPIRegexp encapsulates interaction with
354 the PPI Regexp token classes. Those classes have very sparse
355 APIs, so this package hides away the ugly fiddling with PPI
357 * Added a new optional_modules parameter for the .run syntax.
360 * PPI::Structure::List can now contain multiple children,
361 so P::C::Utils::parse_arg_list() needs to handle it.
363 This was done in the process of fixing
364 http://rt.cpan.org/Ticket/Display.html?id=24924, which was a problem
365 with TestingAndDebugging::RequireTestLabels.
367 * ValuesAndExpressions::ProhibitLongChainsOfMethodCalls wasn't resetting
368 chain length when it ran into the end of a sub-expression.
370 http://rt.cpan.org/Public/Bug/Display.html?id=30040
372 * ValuesAndExpressions::ProhibitCommaSeparatedStatements was reporting
373 false positives when builtins which accept both no and multiple
374 arguments were involved.
376 http://rt.cpan.org/Public/Bug/Display.html?id=27654
379 * Removed all use of Carp in favor of exceptions.
382 * Now requires PPI 1.201. A number of workarounds for PPI bugs have been
384 * New dependency upon Exception::Class.
387 * Use Devel::CheckOS to see whether Perl::Critic is being installed on
388 a Solaris system and warn about tar(1) chopping file names off if it
391 [1.079_003] Released on 2007-10-22
392 [1.079_002] Released on 2007-10-21
393 [1.079_001] Released on 2007-10-09
395 Changes summarized into 1.080 above. For exact details, see Changes in
396 1.079_003 on BackPAN.
398 [1.078] Released on 2007-09-19
400 Restore Perl::Critic::TestUtils::should_skip_author_tests() and
401 get_author_test_skip_message(). Some Perl::Critic add-on distributions
404 [1.077] Released on 2007-09-15
406 Note: if you don't have any problems installing Perl::Critic 1.076, there
407 is no need to upgrade to this version. There are no functionality
408 changes. This release only contains changes related to installation that
409 a few people were experiencing.
412 * Removed build-time use of Readonly, again, due to problems some people
413 were having when trying to compile the code by hand, rather than using
415 * Don't run author tests if there's a .svn directory present because
416 users who grabbed the code from the source repository were executing
417 them and getting failures.
418 * Don't generate optional, module-hiding test wrappers if author tests
422 [1.076] Released on 2007-09-07
424 It appears from reports on the 1.075_001 release that the subroutine
425 sigils were indeed the problem. Release to the general populace.
428 [1.075_001] Released on 2007-09-06
431 Undo the changes in 1.073 and 1.074. Instead, stop using the subroutine
432 sigil in import and export lists. It is suspected that the problem lies
433 with Exporter stripping off ampersands.
435 [1.074] Released on 2007-09-04
438 Repeat the Makefile.PL change on
439 t/generate_without_optional_dependencies_wrappers.PL.
442 [1.073] Released on 2007-09-04
445 Work around problems with the combination of Exporter & Readonly in
446 Makefile.PL on some machines.
448 [1.072] Released on 2007-09-03
451 * The Makefile generated by Makefile.PL was not syntactically correct
452 according to some versions of Solaris. Thanks to Diab Jerius
453 (DJERIUS) for discovery and testing.
454 * Fixed mis-definition of "quiet" value for the "--profile-strictness"
456 * Enhanced testing with the absence of optional modules.
458 [1.071] Released on 2007-08-24
460 The "Brown Paper Bag" Release
463 * Tests would not pass in environments that did not have all optional
464 dependencies installed.
466 [1.07] Released on 2007-08-21
468 New Policies: (funded by a Perl Foundation grant)
469 * BuiltinFunctions::ProhibitBooleanGrep
470 * BuiltinFunctions::ProhibitComplexMappings
471 * Documentation::PodSpelling
472 * InputOutput::ProhibitJoinedReadline
473 * Subroutines::ProhibitManyArgs
474 * Subroutines::RequireArgUnpacking
475 * ValuesAndExpressions::ProhibitImplicitNewlines
476 * Variables::RequireLocalizedPunctuationVars
479 * Subroutines::ProhibitNestedSubs
482 * The "perlcritic --profile-proto" output now includes the "add_themes"
483 parameter for each policy.
484 * The perlcritic "--strict-profile" option has been replaced with a
485 "--profile-strictness" option. This new option takes values of "warn"
486 (the default), "fatal", and "quiet", which controls what happens with
487 ignorable problems in a .perlcriticrc file.
489 New Developer Features:
490 * Perl::Critic::Policy now has an overridable initialize_if_enabled()
491 method which allows a Policy to perform expensive initialization after
492 it has been determined whether the user has it enabled or not. Also,
493 this method allows a Policy to say that it should be disabled
494 regardless of what the user says.
496 Actually, use of this method is now encouraged over using a
500 * Now requires the Readonly module in order to be more self-compliant.
502 [1.061] Released on 2007-07-24
505 * Fix P::C::Theme-- Exporter in Perl 5.6 does not export import(), so you
506 must subclass it. *sigh*
507 * Fix P::C::Config::_validate_and_save_theme()-- eval of an empty string
508 does not reset $@/$EVAL_ERROR in Perl 5.6.
510 Big thanks to Anirvan Chatterjee for identifying and helping debug these
513 [1.06] Released on 2007-06-27
516 * perlcritic now emits errors for all the problems it can find for the
517 global options in the command-line parameters and .perlcriticrc file,
518 rather than bailing on the first one it encounters.
520 * perlcritic now has a "--strict-profile" option which will make warnings
521 about problems in a profile fatal.
523 * perlcritic now has a "--statistics-only" option which suppresses the
524 display of individual violations and only shows the additional output
525 produced by the "--statistics" option.
528 * A value for "color" can now be specified in a .perlcriticrc.
529 http://rt.cpan.org/Ticket/Display.html?id=24877
532 * ValuesAndExpressions::ProhibitQuotesAsQuotelikeOperatorDelimiters
533 As suggested in http://rt.cpan.org/Ticket/Display.html?id=23290.
534 * ValuesAndExpressions::ProhibitLongChainsOfMethodCalls
535 * Modules::ProhibitExcessMainComplexity
536 As suggested in http://rt.cpan.org/Ticket/Display.html?id=24699
539 * The perlcritic "--profile-proto" option now emits the short names for
540 policies, rather than the full ones.
542 * The "-profileproto" and "-singlepolicy" options have been renamed to
543 "-profile-proto" and "-single-policy" in order to make the growing
544 number of command-line options comprehensible. The change of
545 "singlepolicy" also affects your F<.perlcriticrc> file.
547 [1.053] Released on 2007-06-02
549 *DEVELOPMENT RELEASE*
552 Fixed bug in 15_statustics.t test script, which caused the build
553 to fail on machines that don't have Perl::Tidy installed.
555 [1.052] Released on 2007-06-01
557 *DEVELOPMENT RELEASE*
560 * perlcritic now emits a summary about the scanned code when enabled by
561 the "-statistics" option.
564 * InputOutput::ProhibitBacktickOperators can now be configured to only
565 check in void contexts.
568 * 27073: False positive in RequireUpperCaseHeredocTerminator
569 * 27065: CodeLayout::ProhibitTrailingWhitespace breaks under Perl 5.6.1
570 * 26462: ControlStructures::ProhibitCascadingIfElse pod typo
571 * ValuesAndExpressions::ProhibitCommaSeparatedStatements was complaining
572 about multiple values in the list to be iterated over by a foreach loop.
573 * Corrected PBP page numbers for some policies (Quinn Weaver).
575 [1.051] Released on 2007-04-12
577 *DEVELOPMENT RELEASE*
580 No particular bug fixes.
583 * Added several new utility functions to support the StricterSubs distro.
584 Also, some of the existing functions in Perl-Critic-Utils have
585 changed in ways that might break your custom policies.
588 * Updated Emacs plugin (Courtesy Josh ben Jore).
589 See extras/perlcritic.el for details.
590 * Added copy of BBEdit plugin (Courtesy of Josh Clark).
591 See extras/perl_critic_for_bbedit-1_0.zip for details
593 [1.05] Released on 2007-03-19
596 * 25557: t/20_policy_prohibittrailingwhitespace.t fails on Perl 5.8.0
598 [1.04] Released on 2007-03-18
601 * 25008: Subroutines::RequireFinalReturn should allow "throw"
602 * 25085: False Positive - Heredoc terminator must be quoted
603 * 18423: VERSION check does not notice Readonly::Scalar version
604 * 25449: Proposal of $VERSION declaration (DUPLICATE)
607 * CodeLayout::ProhibitTrailingWhitespace
608 * ValuesAndExpressions::ProhibitCommaSeparatedStatements
609 * Variables::ProhibitPerl4PackageNames
612 * Subroutines::RequireFinalReturn can now be configured to recognize
613 your custom functions that behave like "die" or "exit".
614 * Documentation::RequirePodSections can be configured to match
615 Module::Starter:PBP or to really match the PBP book.
617 [1.03] Released on 2007-02-13
620 * Fixed a few more problems with the %f, %F, and %r format escapes.
621 * I forgot to put Conway's perlcriticrc file in the MANIFEST. Sorry.
624 * Perl::Critic::Utils automatically exports everything. However,
625 this is deprecated. In the future, you must request your exports.
628 * Duplicate violations of RequireExcplicitPackage are now squelched,
629 in the same way as RequireUseStrict and RequireUseWarnings.
631 [1.02] Released on 2007-02-11
634 * "undef" incorrectly triggered ProhibitMutatingListFunctions.
635 * 24876: %f and %F escapes not working in custom "verbose" format strings.
636 * 24875: Documentation bug in TestingAndDebugging::ProhibitNoStrict
639 * InputOutput::RequireCheckedOpen
640 * InputOutput::RequireCheckedClose
643 * Added Conway's own suggested Perl::Critic configuration as
644 examples/perlcriticrc-conway.
646 * See the examples/ directory for some neat demonstrations of using
647 the Perl::Critic API. Contributed by Elliot Shank.
650 * Perl::Critic::Utils no longer exports anything by default. Policies
651 outside the distribution will need to specify what exactly they need
652 from this module. There are a number of tags that can be used in
653 addition to individual imports.
655 [1.01] Released on 2007-01-24
657 PRODUCTION RELEASE: You may now consider the public Perl::Critic
658 API as "stable." Future minor releases will focus on bug fixes,
659 new policies, and internal refactoring.
662 * Fixed memory leak. This was reported by the Parrot team at
663 http://rt.perl.org/rt3/Ticket/Display.html?id=41230
665 [0.23] Released on 2007-01-19
668 * 23994: Test 56 in t/05_utils.t of Perl::Critic v0.22 fails
669 * 24005: test 95 in t/13_bundled_policies fails in 0.22
673 * Added '%F' to the Violation format specifications. This will
674 give you just the name of file where the violation occurred
675 (i.e. without the path).
677 * Improved validation of .perlcriticrc file. An invalid
678 default setting will now cause a fatal exception. A
679 strange-looking policy name will cause a warning.
683 * The syntax for theme expressions has changed. Instead of using
684 mathematical operators qw(+ * -) you must now use the logical
685 operators qw(|| && !). See the Perl::Critic docs for more info.
687 * The @GLOBALS and @BUILTINS variables are no longer exported by
688 Perl::Critic::Utils. Use the is_perl_global() and is_perl_builtin()
691 * Perl::Critic::Policy::policy_parameters() has bee renamed to
692 Perl::Critic::Policy::supported_paramters(). This was an
693 undocumented feature anyway, so it shouldn't affect anyone.
696 Other Internal Changes:
697 * Perl::Critic now requires B::Keywords v1.05 or newer.
699 * A few internal classes have been refactored. As a result,
700 Set::Scalar is no longer a required dependency.
703 [0.22] Released on 2006-12-15
706 * Introduced named severity levels: gentle, stern, harsh, cruel, brutal
707 You can use these named levels instead of the numeric ones.
708 For example: "perlcritic --severity=cruel MyModule.pm"
709 Or just: "perlcritic --cruel MyModule.pm"
711 * For perlcritic, the "-List" option has been renamed to
712 "-profileproto". The output now includes the names of the
713 parameters that each Policy supports, if any.
715 * Improved validation of Policy parameters in your F<.perlcriticrc>
716 Any invalid parameter now causes a fatal exception.
719 * Reassigned themes for most policies. Now there are fewer
720 themes and they are organized around programming concepts
721 instead of severity levels. If you have assigned your own
722 themes to any Policies, they should still work as expected.
725 * ErrorHandling::RequireCarping will not complain if it can figure
726 out that the die or warn message will always end in a newline
727 ("\n"). The idea is that, if you put the newline there, you
728 don't indend for there to be any file/line/stack information
729 emitted, in which case you really don't want carp/croak.
731 You can restore the old strict behavior by giving the policy
732 a false value for "allow_messages_ending_with_newlines" in your
737 Added single-letter uppercase alternatives for some perlcritic options.
739 [0.21_01] Released on 2006-12-03
742 * TestingAndDebugging::ProhibitProlongedStrictureOverride
743 * ControlStructures::ProhibitMutatingListFunctions
746 * Say "perlcritic -List" to get an expanded listing of all Policies.
747 The format is suitable for use as your .perlcriticrc file.
748 * Say "perlcritic -doc PATTERN" to get the documentation for all
749 Policies that match m/PATTERN/imx. This is a little easier than
750 typing in the full name of the Policy module with "perldoc".
751 * Say "perlcritic --singlepolicy PATTERN" to use one and only one
753 * Can now specify exceptions to Variables::ProhibitPackageVars,
754 for packages like File::Find that only interface through
758 * 21713 false positive for parens used with substr and unpack.
759 * 22890 allow Rcs keywords in POD.
762 * Testing system overhauled. Details on the Policy/subtest
763 framework is in t/run.t.
764 * Added Perl::Critic::Utils::words_from_string. This is safer
765 than plain old C<split /\s+/>.
767 [0.21] Released on 2006-11-05
770 * BuiltinFunctions::ProhibitReverseSortBlock
771 * BuiltinFunctions::ProhibitVoidGrep
772 * BuiltinFunctions::ProhibitVoidMap
773 * CodeLayout::RequireConsistentNewlines
774 * Modules::RequireFilenameMatchesPackage
775 * TestingAndDebugging::RequireTestLabels
776 * ValuesAndExpressions::ProhibitMismatchedOperators
779 * Introduced policy "themes." Themes are arbitrary names that can
780 be used to identify a group of related Policies. You can select
781 your favorite policies by combining themes in a mathematic expression
782 such as "pbp * (danger + risky)". See POD for details.
783 * perlcritic output is colorized if you have Term::ANSIColor. This
784 only works on non-Win32 platforms. Use -nocolor switch to disable.
785 * Say "perlcritic -count" to get just the the total number of
786 violations per file. Use this feature to quickly identify hot-spots.
787 * Use the -only switch to choose only from policies mentioned in your
788 .perlcriticrc file. This is useful if you usually only want to
789 work with a small subset of the policies.
790 * Default values for most of the perlcritic and Perl::Critic options
791 can now be defined in your .perlcriticrc file. See POD for details.
794 * 21236: wrong page number for "printing to filehandles"
795 * 21916: File handle ... wrong page reference in PBP [DUPE]
796 * 21714: false positive for capture var used in ternary condition
797 * 21718: No skip for File::Slurp in includes.t
798 * ProhibitBarewordFilehandles doesn't complain if you open
799 STDIN, STDOUT or STDERR.
800 * Parrot 40564: Subroutines::RequireFinalReturn should allow die,
802 * Each "for" and "foreach" loop now adds one point to the McCabe
806 * The internals of Perl::Critic have been significantly refactored,
807 but should still be compatible with existing third-party Policies.
808 * Added author-only tests to the release, but disabled by default
809 * New Perl::Critic::Utils::shebang_line() method
810 * Support for filename-based policies
811 * Additional prerequisite: Set::Scalar
812 * Now requires PPI version 1.118
814 [0.20] Released on 2006-09-10
816 Perl::Critic now requires PPI version 1.117, which fixes
817 several bugs that were introduced in version 1.116.
820 * 21079: grep clears @SITE_POLICIES
821 * 21352: Test failures with PPI 1.117
822 * 11365: sub DESTROY detected as a builtin homonym
824 [0.19] Released on 2006-08-20
827 * BuiltinFunctions::ProhibitStringySplit
828 * ControlStructures::ProhibitDeepNests
829 * RegularExpressions::ProhibitCaptureWithoutTest
830 * Variables::RequireLexicalLoopIterator
833 * "perlcritic -quiet" suppresses the "source OK" message.
834 * Variables::ProhibitPunctuationVars is now configurable.
837 * 20965: "Hard tabs used at" shouldn't check __DATA__
838 * 21070: ProhibitNoisyQuotes hates overload
839 * Punctuation variables are now exempt from ProhibitLocalVars
842 * Test coverage is now over 95%
844 [0.18_01] Released on 2006-08-06
847 * Variables::RequireNegativeIndices
848 * InputOutput::ProhibitInteractiveTest
849 * ErrorHandling::RequireCarping
852 * RequireTidyCode tests fail if user has custom .perltidyrc file
853 * 20612: RequirePerlTidy was ignoring HEREDOCs
854 * 20659: __END__ statement considered "unreachable"
855 * Fix for PPI::XS (no C<use overload '""'> support)
856 * Support for 'goto' in ProhibitAmpersandSigils and
857 Subroutines::RequireFinalReturn
859 Performance Enhancements:
860 * Introduced Perl::Critic::Document class. This is a facade for
861 PPI::Document which internally caches search results. This
862 reduces the running time by about 35%. The facade should be
863 invisible, unless you are doing something really sneaky.
864 * Extraction of the 'diagnostics' information is postponed
865 until it is really needed. Speedup has not been measured.
866 * Calls to helper-subs have been reordered for maximum efficiency.
869 * Includes updated version of perlcritic mode for emacs. See
870 "extras/perlcritic.el" for details.
872 [0.18] Released on 2006-07-16
875 * 14855: Home discovery is dangerously naive.
876 * 20060: Incorrect page numbers in ProhibitLeadingZeros
877 and RequireNumberSeparator policies.
878 * 20068: .perlrc file - inconsistent documentation
879 * 20254: "use vars qw(@EXPORT_OK)" not recognized
880 * 20463: No-case heredoc terminator incorrectly detected as lower case.
881 * ProhibitOneArgBless doesn't understand "bless {} => $class;"
882 * ProhibitExcessComplexity doesn't count 'while' and 'until' stmnts
883 * ProhibitLeadingZeros was falsely hits '.0456'
886 * If File::HomeDir is available, we use it to locate the
887 .perlcriticrc file. This should help make Perl::Critic
888 more portable to Win32 platforms. If File::HomeDir is
889 not installed, we resort to looking at the usual
890 environment variables.
893 * Added "perlcritic.el", which is a super-cool emacs minor-mode
894 that runs perl-critic on the current buffer and returns the
895 results in a sexy hot-linked "compiler" window. You can run
896 it on demand, or have it run automatically every time you
897 save the buffer. You can find this in the extras/ directory.
898 Thanks to Josh ben Jore for contributing this.
900 * Moved "Perl::Critic::TestUtils" into the installed build. This
901 module is only used for unit-testing Perl::Critic, but we
902 are putting it in the installation so folks who want to
903 extend Perl::Critic can make use of it.
905 [0.17] Released on 2006-06-13
908 * 19836: Perl-Critic0.16 fails tests during install. This was
909 caused by a bug in version 3.01 of Module::Pluggable. See
910 http://rt.cpan.org/Ticket/Display.html?id=19857 for details.
911 * Fixed bug in no-critic pragma parser.
914 * ValuesAndExpressions::ProhibitEscapedCharacters
915 * BuiltinFunctions::RequireSimpleSortBlock
918 * Perl::Critic can export critique() as a static function. This
919 may appeal to folks who dislike the object-oriented interface.
921 [0.16] Released on 2006-05-14
924 * Perl::Critic->critique() now accepts a PPI::Document as the
925 argument. This feature creates an additional dependency on
926 Scalar::Util, but that shouldn't be a problem because it is
927 included with List::Util, which we already use.
930 * Increased PPI dependency from v1.110 to v1.112
932 [0.15_03] Released on 2006-05-07
935 * The "## no critic" feature is now implemented without eval-ing
936 the code. This keeps Perl::Critic pure and safe :)
937 * 19082: Page number for AUTOLOAD is incorrect
940 * ControlStructures::ProhibitUnreachableCode (by Peter Guzis)
941 * Modules::ProhibitAutomaticExportation
942 * ValuesAndExpressions::ProhibitVersionStrings
944 [0.15_02] Released on 2006-04-26
947 * Reimplemented the '##no critic' pragmas to have effect on the
948 line where the violation is reported, not on the line where
949 the candidate element lives. This is because some policies
950 may report violations that are nowhere near the element that
952 * RequireUseStrict, RequireUseWarnings, and RequireExplcitPackage
953 all emit violations for _every_ statement that violates the
954 Policy. This closes a loophole that allowed you to circumvent
955 the Policy by using '## no critic' on just the first statement
956 that violated the policy.
957 * Fixed the workaround for the magic shebang that is inserted
958 by EU::MM and M::B. This had stopped working around version 13.
959 * Fixed -noprofile option on 'perlcritic'. This also had stopped
960 working at some point.
962 [0.15_01] Released on 2006-04-16
965 * Added diagnostic messages if the .perlcriticrc contains entries
966 for Policy modules that don't seem to exist.
967 * Now you can specify which policies to disable with the
968 "## no critic" pseudo-pragmas. This feature is still
969 experimental. See docs for details.
970 * perlcritic's directory searching now skips backup files, such
971 as *.swp, *.bak and *~. It also ignores version control system
972 directories, and the blib directory in module build directories.
975 * 18386: Bad example in POD for Documentation::RequirePodSections
976 * 18670: Test failure if Perl::Tidy is not installed
977 * 18698: Policy idea ProhibitUniversalFunctions (see New Policies)
978 * RequireInterpolationOfMetachars falsely hit strings like 'foo=s@'
979 which are commonly used with Getopt::Long.
982 * BuiltinFunctions::ProhibitUniversalCan (by Chris Dolan)
983 * BuiltinFunctions::ProhibitUniversalIsa (by Chris Dolan)
986 * All spurrious options for `perlcritic` are now fatal.
987 * Changed several of the -verbose formats to be more readable.
988 * Explicit -severity option now overrides -[12345] shortcuts instead
989 of being the other way around.
993 [0.15] Released on 2006-03-26
996 * 17964: Insists my code is not tidy (may not be fixed for all cases)
998 [0.14_02] Released on 2006-03-19
1001 * 15653: False positive in OneArgSelect (fixed for real this time)
1004 * ClassHierarchies::ProhibitAutoloading
1005 * Documentation::RequirePodSections
1006 * InputOutput::RequireBracedFileHandleWithPrint
1007 * ValuesAndExpressions::ProhibitMixedBooleanOperators
1008 * Variables::RequireInitializationForLocalVars
1010 [0.14_01] Released on 2006-03-05
1013 * 14731: False positive: Builtin function called with parens
1014 * 17554: False positive in CodeLayout::RequireTrailingCommas
1017 * ClassHierarchies::ProhibitExplicitISA
1018 * InputOutput::ProhibitReadlineInForLoop
1019 * Miscellanea::ProhibitFormats
1020 * Miscellanea::ProhibitTies
1021 * Variables::ProhibitConditionalDeclarations
1023 [0.14] Released on 2006-01-29
1025 More documentation edits.
1028 * Documentation::RequirePodAtEnd
1029 * Subroutines::ProtectPrivateSubs
1030 * Variables::ProhibitMatchVars
1031 * Variables::ProtectPrivateVars
1034 * 15295: "## no critic" pragmas too aggresive on compound statements.
1035 * t/01_config.t failed in the presence of third-party policies
1037 [0.13_05] Not released
1039 More documentation edits.
1041 Implemented workaround for failing pod_coverage tests.
1044 * 16906: tr/// created false-postives with RegularExpression polices.
1046 [0.13_04] Released on 2005-12-31
1048 Moved DEVELOPER.pod file into the Perl/Critic dir.
1050 More documentation edits.
1052 [0.13_03] Released on 20051230
1054 perlcritic now prints 'source OK' if it doesn't find any
1055 violations. This gives folks a warm fuzzy feeling.
1057 Tweaked some test cases that were failing on my Solaris
1058 environment at work.
1060 [0.13_02] Released on 2005-12-29
1062 Fixed Config to recognize fully-qualified module names in the
1065 Various documentation edits.
1067 [0.13_01] Released on 2005-12-28
1069 Replaced 'priority' concept with 'severity'. Now each Policy module
1070 has a predefined severity level ranging from 1 to 5. By default,
1071 perlcritic only reports the most severe violations. You can adjust
1072 the severity threshold at the command line, and you can change
1073 the severity for any Policy using the config file.
1075 Chris implemented the applies_to() mechanism, which allows each Policy
1076 class to declare the types of PPI elements that it wants to examine.
1077 When traversing the document, Perl::Critic invokes the Policy only
1078 for elements that are of the correct type. This improves performance
1081 Perl::Critic now uses a Plugin architecture to automatically
1082 discover Policy modules. So if you have custom Policies, all you
1083 have to do is install them in the Perl::Critic::Policy namespace --
1084 no need to add anything to your .perlcriticrc file. If you write
1085 policies in a different namespace, you can configure that too. See
1086 the Perl::Critic::Config docs for details.
1089 * Modules::RequireEndWithOne
1090 * NamingConventions::ProhibitAmbiguousNames
1091 * References::ProhibitDoubleSigils
1092 * Subroutines::RequireFinalReturn
1093 * Subroutines::ProhibitAmpersandSigils
1094 * Subroutines::ProhibitExcessComplexity
1095 * TestingAndDebugging::ProhibitNoStrict
1096 * TestingAndDebugging::ProhibitNoWarnings
1099 * 15101: Plugin architecture improves support for 3rd-party code
1100 * 16319: Fixed incorrect PBP page number in ProhibitBarwordFilehandle
1101 * 16321: Lists of empty quotes are now allowed by ProhibitQuotedWordLists
1102 * 16288: Empty lists caused a fatal error RequireTrailingCommas
1103 * 15653: Fixed false positive in OneArgSelect.
1105 [0.13] Released on 2005-10-31
1107 Official release of 0.12_03. No code major changes.
1109 [0.12_03] Not released
1111 Renamed -Policy option to -include. Added -exclude to give the
1114 Refactored constructor of Perl::Critic. Now, most of the work
1115 is delegated to Perl::Critic::Config. I'm not sure I like how
1116 this turned out, but we'll see how it goes.
1118 Renamed some Policy modules to be a bit more comprehensible. Note
1119 that you may need to change your .perlcriticrc file accordingly.
1120 I also suggest removing your current Perl::Critic installation
1121 before installing this one.
1124 * ProhibitUnpackagedCode => RequireExplicitPackage
1125 * RequireQuotedWords => ProhibitQuotedWordLists
1127 Improved error message when Perl::Critic dies because PPI can't
1128 parsee the input code.
1130 Changed output of -help to be more terse.
1134 [0.12_02] Not released
1136 Added -Policy option to perlcritic. The idea is to provide a
1137 compact interface for selecting Policy modules at the command-line.
1138 This feature is experimental and subject to change.
1140 Added a warning message if -verbose value looks strange. In most
1141 applications, the -verbose option does not require a value, so people
1142 might be puzzled when they write 'perlcritic -verbose my_file.pm' and
1143 nothing seems to happen.
1145 Command-line options to perlcritic are now case-sensitive. This
1146 makes it easier to abbreviate options that start with the same letters
1147 (e.g. 'Version' and 'verbose')
1149 Fixed the new Policy modules that were misnamed and misplaced in the
1150 previous distribution.
1152 [0.12_01] Not released
1154 Rewrote some of the ControlStructures and BuiltinFunction
1155 policies to be simpler (and probably a little faster).
1157 Edited POD. Fixed some typos. Added PREREQUISITES section
1158 to Perl::Critic documentation.
1160 Fixed the -verbose FORMAT option so that you can put metachars
1161 in the FORMAT specification. If using perlcritic, be careful to
1162 protect them from getting munged by the shell first.
1164 Replaced ProhibitRequireStatements with RequireBarewordIncludes
1165 module. Courtesy of Chris Dolan <cdolan@cpan.org>
1167 Added configuration to ProhibitInterpolationOfLiterals so that
1168 certain flavors of quotes can be exempt. This is for folks who
1169 have configured their editor to use special syntax highlighting
1170 for certain kinds of strings (SQL, for example).
1172 perlcritic now accepts multiple file arguments, so now you can
1173 critique your entire distribution in one shot. As a result, the
1174 output-formats have changed slightly.
1177 * BuiltinFunctions::ProhibitLvalueSubstr
1178 * BuiltinFunctions::ProhibitSleepViaSelect
1179 * ClassHierarchies::ProhibitOneArgBless
1180 * CodeLayout::RequireTrailingCommas
1181 * CodeLayout::RequireQuotedWordLists
1182 * InputOutput::ProhibitTwoArgOpen
1183 * InputOutput::ProhibitOneArgSelect
1184 * InputOutput::ProhibitBarewordFileHandles
1185 * Miscellanea::RequireRcsKeywords
1186 * Modules::RequireVersionVar
1187 * RegularExpressions::RequireExtendedFormatting
1188 * RegularExpressions::RequireLineBoundaryMatching
1192 14923: 'require' is now permitted. See RequireBarewordIncludes.
1193 15022: Fixed false-positives when keywords are used as hash keys.
1194 15023: Fixed spurious Violations by removing magic shebang.
1195 15031: Fixed spelling mistakes (and probably added some new ones).
1196 15233: Postfix 'if' is now allowed with 'die', 'croak', etc.
1198 [0.12] Released 2005-10-10
1200 Redesigned the 'verbose' feature. Now the output format
1201 can be user-defined using a sprintf-like specification.
1202 perlciritc also has a predefined output format that is
1203 compatible with grep mode in editors like vim and emacs.
1205 'return' is now exempt from ProhibitParensWithBuiltins. I may
1206 extend this exemption to all unary functions.
1208 Edited POD. Added a super brief description of each policy
1209 in the main Perl::Critic documentation. Added details about
1212 Additional Prerequisites:
1217 The internal dynamics and API of Perl::Critic have changed
1218 considerably. The result is a 300% increase in performance.
1219 See the POD in Perl::Critic::Policy for details.
1222 * Added -verbose option to put more stuff in the output. In the
1223 extreme, you can get the POD from Policy attached to each
1224 and every violation.
1226 Additional Prerequisites:
1230 [0.10] Released 2005-10-05
1232 Fixed stupid bug in newest Policy modules. They were returning
1233 PPI objects instead of Perl::Critic::Violation objects. Doh!
1235 Fixed test scripts to prevent failures if the user already has a
1238 'ProhibitHardTabs' now allows leading tabs by default.
1240 Put the Changes file in reverse-chronological order, so the most
1241 recent stuff is easy to find at the top of the file
1243 [0.09] Released 2005-10-04
1246 * 14810: Now you are allowed to create your own 'import' function,
1247 since this is frequently done with fancy modules.
1248 * 14817: Parens, brackets, and braces are now excluded from
1249 'ProhibitNoisyQuotes' since they look better in quotes anyway.
1250 * 14787: $1..$9 and '_' are exempt from ProhibitPunctuationVars
1251 * 14899: Object methods with the same name as a built-in can
1252 be called with parens (ProhibitParensWithBuiltins).
1253 * 14901: Normalized the exit status of perlcritic to 0, 1, or 2.
1254 See documentation for explanation.
1255 * 14855: Partially fixed home directory discovery. Still not
1256 completely portable, but at least doesn't create warnings.
1259 * 14734: Limit for number separators is now configurable
1262 * CodeLayout::ProhibitHardTabs
1263 * ControlStructures::ProhibitUnlessBlocks
1264 * ControlStructures::ProhibitUntilBlocks
1265 * ControlStructures::ProhibitCStyleForLoops
1267 Changed the syntax for the magic comments. Adam had the
1268 idea of using a pragma-like notation. I liked it.
1270 [0.08_2] Released 2005-09-27
1272 Fixed problems with Perl::Critic::Config that caused File::Spec
1273 to emit 'uninitialized value' warnings during the build.
1275 Added 1 Policy module contributed by Graham TerMarsch
1277 Switched from File::Spec::Functions to plain File::Spec because
1278 I think its usage is more common.
1280 Removed 'FindBin' from the test files so I can be sure that the
1281 right libraries are getting loaded. This means I'll have to
1282 use the -l option with C<prove>.
1286 [0.08_01] Not released
1288 Fixed "ProhibitParensWithBuiltins" to allow parens to be used with
1289 object method calls that have the same name as a builtin functions.
1291 Introduced magical comments that allow developers to configure
1292 Perl::Critic on-the-fly from within their code.
1294 Added META.yml files and POD tests to the build. I did this
1295 mostly just to boost the Kwalitee score on CPANTS.
1297 Switched from "Config::Std" to "Config::Tiny" because it doesn't
1298 require those fancy Damian modules that don't seem to work on
1299 some older versions of Perl.
1301 [0.07] Released on 2005-09-21
1303 Fixed bugs in the ProhibitCascadingIfElse policy.
1305 Added ProhibitExplicitReturnUndef policy
1307 Made ProhibitUnpackagedCode configurable so you can exempt scripts,
1308 which typically don't have an explicit 'package' statement.
1310 ProhibitPackageVars policy now exempts vars in ALL_CAPS. This
1311 is to permit common package variables like @EXPORT and $VERSION.
1313 Renamed "ProhibitStringyGrep and "ProhibitStringyMap" because
1314 the so-called string form doesn't really exist. Now called
1315 "RequireBlockGrep" and "RequireBlockMap"
1317 Corrected documentation on defining Policy names within the
1318 configuration file. This still isn't very clear and needs
1321 Perl::Critic now requires PPI version 1.003, which has a few bug
1324 Rewrite some code just to make Perl::Critic more self-compliant.
1326 Added test cases to verify the configuration functionality. These
1327 are not completely thorough and need more work.
1329 [0.06] Released on 2005-09-17
1331 Now called 'Perl::Critic'.
1333 Added 4 new policy modules.
1335 Fixed bugs in build process.
1337 Added support for Module::Build.
1339 [0.05] Released on 2005-09-17
1341 End of 'Perl::Review' releases. I have changed the name to
1342 'Perl::Critic' to avoid possible confusion with "The Perl Review"
1345 [0.04] Released on 2005-09-14
1347 Version 0.03 was a bust because I uploaded the wrong tarball to PAUSE.
1349 [0.03] Released on 2005-09-13.
1351 Fixed some POD links.
1353 Removed test cases for missing policy module.
1355 [0.02] Released on 2005-09-13.
1357 Major overhaul based on feedback from Perl community.
1359 Factored coding standards into separate modules (known as
1360 Policies). The idea here is to allow other developers to easily
1361 contribute additional coding standards.
1363 Reworked Perl::Review into a simple engine for loading and running
1366 Gave perlreview a command-line interface and configuration file
1367 for selecting which Policy modules to use.
1369 [0.01] Released on 2005-08-16.
1373 ##############################################################################
1378 ##############################################################################
1380 # ex: set ts=8 sts=4 sw=4 tw=78 ft= expandtab shiftround :