Perl::Critic::Policy::Modules::RequireVersionVar - Give every module a $VERSION number.
This Policy is part of the core Perl::Critic distribution.
Every Perl file (modules, libraries, and programs) should have a
$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);
A common practice is to use the $Revision: 2489 $ keyword to automatically
define the $VERSION variable like this:
our ($VERSION) = '$Revision: 2489 $' =~ m{ \$Revision: \s+ (\S+) }x;
This Policy is not configurable except for the standard options.
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.
Jeffrey Ryan Thalhammer <thaljef@cpan.org>
Copyright (c) 2005-2008 Jeffrey Ryan Thalhammer. 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.