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(3pm) [debian man page]

Perl::Critic::Policy::CodeLayout::ProhibitQuotedWordListUsermContributed Perl DocumePerl::Critic::Policy::CodeLayout::ProhibitQuotedWordLists(3pm)

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.14.2							    2012-06-07	    Perl::Critic::Policy::CodeLayout::ProhibitQuotedWordLists(3pm)

Check Out this Related Man Page

Perl::Critic::Policy::CodeLayout::ProhibitHardTabs(3)	User Contributed Perl Documentation  Perl::Critic::Policy::CodeLayout::ProhibitHardTabs(3)

NAME

       Perl::Critic::Policy::CodeLayout::ProhibitHardTabs - Use spaces instead of tabs.

AFFILIATION

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

DESCRIPTION

       Putting hard tabs in your source code (or POD) is one of the worst things you can do to your co-workers and colleagues, especially if those
       tabs are anywhere other than a leading position.  Because various applications and devices represent tabs differently, they can cause you
       code to look vastly different to other people.  Any decent editor can be configured to expand tabs into spaces.	Perl::Tidy also does this
       for you.

       This Policy catches all tabs in your source code, including POD, quotes, and HEREDOCs.  The contents of the "__DATA__" section are not
       examined.

CONFIGURATION

       Hard tabs in a string are always forbidden (use "	" instead).  But hard tabs in a leading position are allowed when they are used to
       indent code statements, "qw()" word lists, and regular expressions with the "/x" modifier.  However, if you want to forbid all tabs
       everywhere, then add this to your .perlcriticrc file:

	   [CodeLayout::ProhibitHardTabs]
	   allow_leading_tabs = 0

NOTES

       Beware that Perl::Critic may report the location of the string that contains the tab, not the actual location of the tab, so you may need
       to do some hunting.  I'll try and fix this in the future.

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::ProhibitHardTabs(3)
Man Page