perl::critic::policy::modules::requireversionvar(3pm) [debian 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)

Check Out this Related Man Page

Perl::Critic::Policy::Variables::ProhibitLocalVars(3)	User Contributed Perl Documentation  Perl::Critic::Policy::Variables::ProhibitLocalVars(3)

NAME

       Perl::Critic::Policy::Variables::ProhibitLocalVars - Use "my" instead of "local", except when you have to.

AFFILIATION

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

DESCRIPTION

       Since Perl 5, there are very few reasons to declare "local" variables.  The most common exceptions are Perl's magical global variables.	If
       you do need to modify one of those global variables, you should localize it first.  You should also use the English module to give those
       variables more meaningful names.

	   local $foo;	 #not ok
	   my $foo;	 #ok

	   use English qw(-no_match_vars);
	   local $INPUT_RECORD_SEPARATOR    #ok
	   local $RS			    #ok
	   local $/;			    #not ok

CONFIGURATION

       This Policy is not configurable except for the standard options.

NOTES

       If an external module uses package variables as its interface, then using "local" is actually a pretty sensible thing to do.  So
       Perl::Critic will not complain if you "local"-ize variables with a fully qualified name such as $Some::Package::foo.  However, if you're in
       a position to dictate the module's interface, I strongly suggest using accessor methods instead.

SEE ALSO

       Perl::Critic::Policy::Variables::ProhibitPunctuationVars

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::Variables::ProhibitLocalVars(3)

Linux and UNIX Man Pages

perl::critic::policy::modules::requireversionvar(3pm) [debian man page]

Check Out this Related Man Page