perl::critic::policy::regularexpressions::requireextendedformatt(3pm) [debian man page]
Perl::Critic::Policy::RegularExpressions::RequireExtendeUsermContributed PPerl::Critic::Policy::RegularExpressions::RequireExtendedFormatting(3pm) NAME
Perl::Critic::Policy::RegularExpressions::RequireExtendedFormatting - Always use the "/x" modifier with regular expressions. AFFILIATION
This Policy is part of the core Perl::Critic distribution. DESCRIPTION
Extended regular expression formatting allows you mix whitespace and comments into the pattern, thus making them much more readable. # Match a single-quoted string efficiently... m{'[^\']*(?:\.[^\']*)*'}; #Huh? # Same thing with extended format... m{ ' # an opening single quote [^\'] # any non-special chars (i.e. not backslash or single quote) (?: # then all of... \ . # any explicitly backslashed char [^\']* # followed by an non-special chars )* # ...repeated zero or more times ' # a closing single quote }x; CONFIGURATION
You might find that putting a "/x" on short regular expressions to be excessive. An exception can be made for them by setting "minimum_regex_length_to_complain_about" to the minimum match length you'll allow without a "/x". The length only counts the regular expression, not the braces or operators. [RegularExpressions::RequireExtendedFormatting] minimum_regex_length_to_complain_about = 5 $num =~ m<(d+)>; # ok, only 5 characters $num =~ m<d.(d+)>; # not ok, 9 characters This option defaults to 0. Because using "/x" on a regex which has whitespace in it can make it harder to read (you have to escape all that innocent whitespace), by default, you can have a regular expression that only contains whitespace and word characters without the modifier. If you want to restrict this, turn on the "strict" option. [RegularExpressions::RequireExtendedFormatting] strict = 1 $string =~ m/Basset hounds got long ears/; # no longer ok This option defaults to false. NOTES
For common regular expressions like e-mail addresses, phone numbers, dates, etc., have a look at the Regexp::Common module. Also, be cautions about slapping modifier flags onto existing regular expressions, as they can drastically alter their meaning. See <http://www.perlmonks.org/?node_id=484238> for an interesting discussion on the effects of blindly modifying regular expression flags. TO DO
Add an exemption for regular expressions that contain "Q" at the front and don't use "E" until the very end, if at all. AUTHOR
Jeffrey Ryan Thalhammer <jeff@imaginative-software.com> COPYRIGHT
Copyright (c) 2005-2011 Imaginative Software Systems. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of this license can be found in the LICENSE file included with this module. perl v5.14.2 2012-0Perl::Critic::Policy::RegularExpressions::RequireExtendedFormatting(3pm)
Check Out this Related Man Page
Perl::Critic::Policy::Miscellanea::ProhibitUselessNoCritUser)Contributed Perl DocumenPerl::Critic::Policy::Miscellanea::ProhibitUselessNoCritic(3) NAME
Perl::Critic::Policy::Miscellanea::ProhibitUselessNoCritic - Remove ineffective "## no critic" annotations. AFFILIATION
This Policy is part of the core Perl::Critic distribution. DESCRIPTION
Sometimes, you may need to use a "## no critic" annotation to work around a false-positive bug in Perl::Critic. But eventually, that bug might get fixed, leaving your code with extra "## no critic" annotations lying about. Or you may use them to locally disable a Policy, but then later decide to permanently remove that Policy entirely from your profile, making some of those "## no critic" annotations pointless. Or, you may accidentally disable too many Policies at once, creating an opportunity for new violations to slip in unnoticed. This Policy will emit violations if you have a "## no critic" annotation in your source code that does not actually suppress any violations given your current profile. To resolve this, you should either remove the annotation entirely, or adjust the Policy name patterns in the annotation to match only the Policies that are actually being violated in your code. EXAMPLE
For example, let's say I have a regex, but I don't want to use the "/x" flag, which violates the "RegularExpressions::RequireExtendedFormatting" policy. In the following code, the "## no critic" annotation will suppress violations of that Policy and ALL Policies that match "m/RegularExpressions/imx" my $re = qr/foo bar baz/ms; ## no critic (RegularExpressions) However, this creates a potential loop-hole for someone to introduce additional violations in the future, without explicitly acknowledging them. This Policy is designed to catch these situations by warning you that you've disabled more Policies than the situation really requires. The above code should be remedied like this: my $re = qr/foo bar baz/ms; ## no critic (RequireExtendedFormatting) Notice how the "RequireExtendedFormatting" pattern more precisely matches the name of the Policy that I'm trying to suppress. NOTE
Changing your .perlcriticrc file and disabling policies globally or running at a higher (i.e. less restrictive) severity level may cause this Policy to emit additional violations. So you might want to defer using this Policy until you have a fairly stable profile. CONFIGURATION
This Policy is not configurable except for the standard options. ACKNOWLEDGMENT
This Policy was inspired by Adam Kennedy's article at <http://use.perl.org/article.pl?sid=08/09/24/1957256>. AUTHOR
Jeffrey Ryan Thalhammer <jeff@imaginative-software.com> COPYRIGHT
Copyright (c) 2005-2011 Imaginative Software Systems. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of this license can be found in the LICENSE file included with this module. perl v5.16.3 2014-06-09 Perl::Critic::Policy::Miscellanea::ProhibitUselessNoCritic(3)