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::RequireVersionVar(3) User Contributed Perl Documentation Perl::Critic::Policy::Modules::RequireVersionVar(3) NAME
Perl::Critic::Policy::Modules::RequireVersionVar - Give every module a "$VERSION" number. AFFILIATION
This Policy is part of the core Perl::Critic distribution. DESCRIPTION
Every Perl file (modules, libraries, and programs) should have a package-scoped $VERSION variable. The $VERSION allows clients to insist on a particular revision of your file like this: use SomeModule 2.4; #Only loads version 2.4 This Policy scans your file for any package variable named $VERSION. I'm assuming that you are using "strict", so you'll have to declare it like one of these: our $VERSION = 1.0611; $MyPackage::VERSION = 1.061; use vars qw($VERSION); use version; our $VERSION = qv(1.0611); Perl's version system does not recognize lexical variables such as my $VERSION = 1.0611; so they are not accepted by this policy. A common practice is to use the "$Revision: 4126 $" keyword to automatically define the $VERSION variable like this: our ($VERSION) = '$Revision: 4126 $' =~ m{ $Revision: s+ (S+) }x; CONFIGURATION
This Policy is not configurable except for the standard options. NOTES
Conway recommends using the "version" pragma instead of raw numbers or 'v-strings.' However, this Policy only insists that the $VERSION be defined somehow. I may try to extend this in the future. TO DO
Add check that $VERSION is independently evaluatable. In particular, prohibit this: our $VERSION = $Other::Module::VERSION; This doesn't work because PAUSE and other tools literally copy your version declaration out of your module and evaluates it in isolation, at which point there's nothing in "Other::Module", and so the $VERSION is undefined. 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::Modules::RequireVersionVar(3)