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

Perl::Critic::Policy::Modules::RequireBarewordIncludes(3User Contributed Perl DocumentaPerl::Critic::Policy::Modules::RequireBarewordIncludes(3pm)

NAME

       Perl::Critic::Policy::Modules::RequireBarewordIncludes - Write "require Module" instead of "require 'Module.pm'".

AFFILIATION

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

DESCRIPTION

       When including another module (or library) via the "require" or "use" statements, it is best to identify the module (or library) using a
       bareword rather than an explicit path.  This is because paths are usually not portable from one machine to another.  Also, Perl
       automatically assumes that the filename ends in '.pm' when the library is expressed as a bareword.  So as a side-effect, this Policy
       encourages people to write '*.pm' modules instead of the old-school '*.pl' libraries.

	   use 'My/Perl/Module.pm';  #not ok
	   use My::Perl::Module;     #ok

CONFIGURATION

       This Policy is not configurable except for the standard options.

NOTES

       This Policy is a replacement for "ProhibitRequireStatements", which completely banned the use of "require" for the sake of eliminating the
       old '*.pl' libraries from Perl4.  Upon further consideration, I realized that "require" is quite useful and necessary to enable run-time
       loading.  Thus, "RequireBarewordIncludes" does allow you to use "require", but still encourages you to write '*.pm' modules.

       Sometimes, you may want to load modules at run-time, but you don't know at design-time exactly which module you will need to load
       (Perl::Critic is an example of this).  In that case, just attach the '## no critic' annotation like so:

	   require $module_name;  ## no critic

CREDITS

       Chris Dolan <cdolan@cpan.org> was instrumental in identifying the correct motivation for and behavior of this Policy.  Thanks Chris.

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::Modules::RequireBarewordIncludes(3pm)

Check Out this Related Man Page

Perl::Critic::Policy::Modules::ProhibitConditionalUseStaUsernContributed Perl DoPerl::Critic::Policy::Modules::ProhibitConditionalUseStatements(3)

NAME

       Perl::Critic::Policy::Modules::ProhibitConditionalUseStatements - Avoid putting conditional logic around compile-time includes.

AFFILIATION

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

DESCRIPTION

       Modules included via "use" are loaded at compile-time.  Placing conditional logic around the "use" statement has no effect on whether the
       module will be loaded.  Doing so can also serve to confuse the reader as to the author's original intent.

       If you need to conditionally load a module you should be using "require" instead.

       This policy will catch the following forms of conditional "use" statements:

	   # if-elsif-else
	   if ($a == 1) { use Module; }
	   if ($a == 1) { } elsif ($a == 2) { use Module; }
	   if ($a == 1) { } else { use Module; }

	   # for/foreach
	   for (1..$a) { use Module; }
	   foreach (@a) { use Module; }

	   # while
	   while ($a == 1) { use Module; }

	   # unless
	   unless ($a == 1) { use Module; }

	   # until
	   until ($a == 1) { use Module; }

	   # do-condition
	   do { use Module; } if $a == 1;
	   do { use Module; } while $a == 1;
	   do { use Module; } unless $a == 1;
	   do { use Module; } until $a == 1;

	   # operator-do
	   $a == 1 || do { use Module; };
	   $a == 1 && do { use Module; };
	   $a == 1 or do { use Module; };
	   $a == 1 and do { use Module; };

	   # non-string eval
	   eval { use Module; };

       Including a module via "use" in bare blocks, standalone do blocks, or string evals is allowed.

	   # bare block
	   { use Module; }

	   # do
	   do { use Module; }

	   # string eval
	   eval "use Module";

CONFIGURATION

       This Policy is not configurable except for the standard options.

AUTHOR

       Peter Guzis <pguzis@cpan.org>

COPYRIGHT

       Copyright (c) 2010-2011 Peter Guzis.  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::Modules::ProhibitConditionalUseStatements(3)
Man Page