perl::critic::policy::modules::requireexplicitpackage(3) [centos man page]

Perl::Critic::Policy::Modules::RequireExplicitPackage(3)User Contributed Perl DocumentatioPerl::Critic::Policy::Modules::RequireExplicitPackage(3)

NAME

       Perl::Critic::Policy::Modules::RequireExplicitPackage - Always make the "package" explicit.

AFFILIATION

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

DESCRIPTION

       In general, the first statement of any Perl module or library should be a "package" statement.  Otherwise, all the code that comes before
       the "package" statement is getting executed in the caller's package, and you have no idea who that is.  Good encapsulation and common
       decency require your module to keep its innards to itself.

       There are some valid reasons for not having a "package" statement at all.  But make sure you understand them before assuming that you
       should do it too.

       The maximum number of violations per document for this policy defaults to 1.

CONFIGURATION

       As for programs, most people understand that the default package is "main", so this Policy doesn't apply to files that begin with a perl
       shebang.  If you want to require an explicit "package" declaration in all files, including programs, then add the following to your
       .perlcriticrc file

	   [Modules::RequireExplicitPackage]
	   exempt_scripts = 0

       Some users may find it desirable to exempt the load of specific modules from this policy. For example, Perl does not support Unicode module
       names because of portability problems. Users who are not concerned about this and intend to use "UTF-8" module names will need to specify
       "use utf8;" before the package declaration. To do this, add the following to your .perlcriticrc file

	   [Modules::RequireExplicitPackage]
	   allow_import_of = utf8

       The "allow_import_of" configuration option takes multiple module names, separated by spaces.

IMPORTANT CHANGES

       This policy was formerly called "ProhibitUnpackagedCode" which sounded a bit odd.  If you get lots of "Cannot load policy module" errors,
       then you probably need to change "ProhibitUnpackagedCode" to "RequireExplicitPackage" 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::Modules::RequireExplicitPackage(3)

Check Out this Related Man Page

Perl::Critic::Policy::Modules::RequireVersionVar(3pm)	User Contributed Perl Documentation  Perl::Critic::Policy::Modules::RequireVersionVar(3pm)

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: 4106 $" keyword to automatically define the $VERSION variable like this:

	   our ($VERSION) = '$Revision: 4106 $' =~ 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.14.2							    2012-06-07		     Perl::Critic::Policy::Modules::RequireVersionVar(3pm)

Linux and UNIX Man Pages

perl::critic::policy::modules::requireexplicitpackage(3) [centos man page]

Check Out this Related Man Page