Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

perl::critic::policy::valuesandexpressions::prohibitinterpolatio(3) [centos man page]

Perl::Critic::Policy::ValuesAndExpressions::ProhibitInteUseraContribPerl::Critic::Policy::ValuesAndExpressions::ProhibitInterpolationOfLiterals(3)

NAME

       Perl::Critic::Policy::ValuesAndExpressions::ProhibitInterpolationOfLiterals - Always use single quotes for literal strings.

AFFILIATION

       This Policy is part of the core Perl::Critic distribution.

DESCRIPTION

       Don't use double-quotes or "qq//" if your string doesn't require interpolation.	This saves the interpreter a bit of work and it lets the
       reader know that you really did intend the string to be literal.

	   print "foobar";     #not ok
	   print 'foobar';     #ok
	   print qq/foobar/;   #not ok
	   print q/foobar/;    #ok

	   print "$foobar";    #ok
	   print "foobar
";   #ok
	   print qq/$foobar/;  #ok
	   print qq/foobar
/; #ok

	   print qq{$foobar};  #preferred
	   print qq{foobar
}; #preferred

       Use of double-quotes might be reasonable if the string contains single quote (') characters:

	   print "it's me";    # ok, if configuration flag set

CONFIGURATION

       The types of quoting styles to exempt from this policy can be configured via the "allow" option.  This must be a whitespace-delimited
       combination of some or all of the following styles: "qq{}", "qq()", "qq[]", and "qq//".

       This is useful because some folks have configured their editor to apply special syntax highlighting within certain styles of quotes.  For
       example, you can tweak "vim" to use SQL highlighting for everything that appears within "qq{}" or "qq[]" quotes.  But if those strings are
       literal, Perl::Critic will complain.  To prevent this, put the following in your .perlcriticrc file:

	   [ValuesAndExpressions::ProhibitInterpolationOfLiterals]
	   allow = qq{} qq[]

       The flag "allow_if_string_contains_single_quote" permits double-quoted strings if the string contains a single quote (') character.  It
       defaults to off; to turn it on put the following in your .perlcriticrc file:

	   [ValuesAndExpressions::ProhibitInterpolationOfLiterals]
	   allow_if_string_contains_single_quote = 1

SEE ALSO

       Perl::Critic::Policy::ValuesAndExpressions::RequireInterpolationOfMetachars

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							    Perl::Critic::Policy::ValuesAndExpressions::ProhibitInterpolationOfLiterals(3)

Check Out this Related Man Page

Perl::Critic::Policy::ValuesAndExpressions::RequireInterUsertContrPerl::Critic::Policy::ValuesAndExpressions::RequireInterpolationOfMetachars(3pm)

NAME

       Perl::Critic::Policy::ValuesAndExpressions::RequireInterpolationOfMetachars - Warns that you might have used single quotes when you really
       wanted double-quotes.

AFFILIATION

       This Policy is part of the core Perl::Critic distribution.

DESCRIPTION

       This policy warns you if you use single-quotes or "q//" with a string that has unescaped metacharacters that may need interpolation. Its
       hard to know for sure if a string really should be interpolated without looking into the symbol table.  This policy just makes an educated
       guess by looking for metacharacters and sigils which usually indicate that the string should be interpolated.

   Exceptions
       o   Variable names to "use vars":

	       use vars '$x';	       # ok
	       use vars ('$y', '$z');  # ok
	       use vars qw< $a $b >;   # ok

       o   Things that look like e-mail addresses:

	       print 'john@foo.com';	       # ok
	       $address = 'suzy.bar@baz.net';  # ok

CONFIGURATION

       The "rcs_keywords" option allows you to stop this policy from complaining about things that look like RCS variables, for example, in
       deriving values for $VERSION variables.

       For example, if you've got code like

	   our ($VERSION) = (q<$Revision: 4106 $> =~ m/(d+)/mx);

       You can specify

	   [ValuesAndExpressions::RequireInterpolationOfMetachars]
	   rcs_keywords = Revision

       in your .perlcriticrc to provide an exemption.

NOTES

       Perl's own "warnings" pragma also warns you about this.

SEE ALSO

       Perl::Critic::Policy::ValuesAndExpressions::ProhibitInterpolationOfLiterals

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							  Perl::Critic::Policy::ValuesAndExpressions::RequireInterpolationOfMetachars(3pm)
Man Page