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

Check Out this Related Man Page

Perl::Critic::Policy::ValuesAndExpressions::RequireInterUsertContrPerl::Critic::Policy::ValuesAndExpressions::RequireInterpolationOfMetachars(3pm)

NAME

       Perl::Critic::Policy::ValuesAndExpressions::RequireInterpolationOfMetachars - Warns that you might have used single quotes when you really
       wanted double-quotes.

AFFILIATION

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

DESCRIPTION

       This policy warns you if you use single-quotes or "q//" with a string that has unescaped metacharacters that may need interpolation. Its
       hard to know for sure if a string really should be interpolated without looking into the symbol table.  This policy just makes an educated
       guess by looking for metacharacters and sigils which usually indicate that the string should be interpolated.

   Exceptions
       o   Variable names to "use vars":

	       use vars '$x';	       # ok
	       use vars ('$y', '$z');  # ok
	       use vars qw< $a $b >;   # ok

       o   Things that look like e-mail addresses:

	       print 'john@foo.com';	       # ok
	       $address = 'suzy.bar@baz.net';  # ok

CONFIGURATION

       The "rcs_keywords" option allows you to stop this policy from complaining about things that look like RCS variables, for example, in
       deriving values for $VERSION variables.

       For example, if you've got code like

	   our ($VERSION) = (q<$Revision: 4106 $> =~ m/(d+)/mx);

       You can specify

	   [ValuesAndExpressions::RequireInterpolationOfMetachars]
	   rcs_keywords = Revision

       in your .perlcriticrc to provide an exemption.

NOTES

       Perl's own "warnings" pragma also warns you about this.

SEE ALSO

       Perl::Critic::Policy::ValuesAndExpressions::ProhibitInterpolationOfLiterals

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							  Perl::Critic::Policy::ValuesAndExpressions::RequireInterpolationOfMetachars(3pm)

Linux and UNIX Man Pages

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

Check Out this Related Man Page