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::codelayout::prohibitquotedwordlists(3) [centos man page]

Perl::Critic::Policy::CodeLayout::ProhibitQuotedWordListUser Contributed Perl DocumentPerl::Critic::Policy::CodeLayout::ProhibitQuotedWordLists(3)

NAME

       Perl::Critic::Policy::CodeLayout::ProhibitQuotedWordLists - Write "qw(foo bar baz)" instead of "('foo', 'bar', 'baz')".

AFFILIATION

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

DESCRIPTION

       Conway doesn't mention this, but I think "qw()" is an underused feature of Perl.  Whenever you need to declare a list of one-word literals,
       the "qw()" operator is wonderfully concise, and makes it easy to add to the list in the future.

	   @list = ('foo', 'bar', 'baz');  #not ok
	   @list = qw(foo bar baz);	   #ok

	   use Foo ('foo', 'bar', 'baz');  #not ok
	   use Foo qw(foo bar baz);	   #ok

CONFIGURATION

       This policy can be configured to only pay attention to word lists with at least a particular number of elements.  By default, this value is
       2, which means that lists containing zero or one elements are ignored.  The minimum list size to be looked at can be specified by giving a
       value for "min_elements" in .perlcriticrc like this:

	   [CodeLayout::ProhibitQuotedWordLists]
	   min_elements = 4

       This would cause this policy to only complain about lists containing four or more words.

       By default, this policy won't complain if any of the values in the list contain non-word characters.  If you want it to, set the "strict"
       option to a true value.

	   [CodeLayout::ProhibitQuotedWordLists]
	   strict = 1

NOTES

       In the PPI parlance, a "list" is almost anything with parentheses.  I've tried to make this Policy smart by targeting only "lists" that
       could be sensibly expressed with "qw()".  However, there may be some edge cases that I haven't covered.	If you find one, send me a note.

IMPORTANT CHANGES

       This policy was formerly called "RequireQuotedWords" which seemed a little counter-intuitive.  If you get lots of "Cannot load policy
       module" errors, then you probably need to change "RequireQuotedWords" to "ProhibitQuotedWordLists" in your .perlcriticrc file.

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::CodeLayout::ProhibitQuotedWordLists(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