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::Miscellanea::ProhibitUnrestrictedNUsertContributed Perl Perl::Critic::Policy::Miscellanea::ProhibitUnrestrictedNoCritic(3pm) NAME
Perl::Critic::Policy::Miscellanea::ProhibitUnrestrictedNoCritic - Forbid a bare "## no critic" AFFILIATION
This Policy is part of the core Perl::Critic distribution. DESCRIPTION
A bare "## no critic" annotation will disable all the active Policies. This creates holes for other, unintended violations to appear in your code. It is better to disable only the particular Policies that you need to get around. By putting Policy names in a comma-separated list after the "## no critic" annotation, then it will only disable the named Policies. Policy names are matched as regular expressions, so you can use shortened Policy names, or patterns that match several Policies. This Policy generates a violation any time that an unrestricted "## no critic" annotation appears. ## no critic # not ok ## no critic '' # not ok ## no critic () # not ok ## no critic qw() # not ok ## no critic (Policy1, Policy2) # ok ## no critic (Policy1 Policy2) # ok (can use spaces to separate) ## no critic qw(Policy1 Policy2) # ok (the preferred style) NOTE
Unfortunately, Perl::Critic is very sloppy about parsing the Policy names that appear after a "##no critic" annotation. For example, you might be using one of these broken syntaxes... ## no critic Policy1 Policy2 ## no critic 'Policy1, Policy2' ## no critic "Policy1, Policy2" ## no critic "Policy1", "Policy2" In all of these cases, Perl::Critic will silently disable all Policies, rather than just the ones you requested. But if you use the "ProhibitUnrestrictedNoCritic" Policy, all of these will generate violations. That way, you can track them down and correct them to use the correct syntax, as shown above in the "DESCRIPTION". If you've been using the syntax that is shown throughout the Perl::Critic documentation for the last few years, then you should be fine. CONFIGURATION
This Policy is not configurable except for the standard options. AUTHOR
Jeffrey Ryan Thalhammer <jeff@imaginative-software.com> COPYRIGHT
Copyright (c) 2008-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-07Perl::Critic::Policy::Miscellanea::ProhibitUnrestrictedNoCritic(3pm)