git.maemo.org Git - pkg-perl/blob - deb-src/libperl-critic-perl/libperl-critic-perl-1.088/lib/Perl/Critic/Utils/Constants.pm

   1 ##############################################################################
   2 #      $URL: http://perlcritic.tigris.org/svn/perlcritic/trunk/Perl-Critic/lib/Perl/Critic/Utils/Constants.pm $
   3 #     $Date: 2008-07-03 10:19:10 -0500 (Thu, 03 Jul 2008) $
   4 #   $Author: clonezone $
   5 # $Revision: 2489 $
   6 ##############################################################################
   7
   8 package Perl::Critic::Utils::Constants;
   9
  10 use 5.006001;
  11 use strict;
  12 use warnings;
  13 use Readonly;
  14
  15 use Perl::Critic::Utils qw{ hashify };
  16
  17 use base 'Exporter';
  18
  19 our $VERSION = '1.088';
  20
  21 #-----------------------------------------------------------------------------
  22
  23 our @EXPORT_OK = qw{
  24     $PROFILE_STRICTNESS_WARN
  25     $PROFILE_STRICTNESS_FATAL
  26     $PROFILE_STRICTNESS_QUIET
  27     $PROFILE_STRICTNESS_DEFAULT
  28     %PROFILE_STRICTNESSES
  29 };
  30
  31 our %EXPORT_TAGS = (
  32     all => \@EXPORT_OK,
  33     profile_strictness => [
  34         qw{
  35             $PROFILE_STRICTNESS_WARN
  36             $PROFILE_STRICTNESS_FATAL
  37             $PROFILE_STRICTNESS_QUIET
  38             $PROFILE_STRICTNESS_DEFAULT
  39             %PROFILE_STRICTNESSES
  40         }
  41     ],
  42 );
  43
  44 #-----------------------------------------------------------------------------
  45
  46 Readonly::Scalar our $PROFILE_STRICTNESS_WARN    => 'warn';
  47 Readonly::Scalar our $PROFILE_STRICTNESS_FATAL   => 'fatal';
  48 Readonly::Scalar our $PROFILE_STRICTNESS_QUIET   => 'quiet';
  49 Readonly::Scalar our $PROFILE_STRICTNESS_DEFAULT => $PROFILE_STRICTNESS_WARN;
  50
  51 Readonly::Hash our %PROFILE_STRICTNESSES =>
  52     hashify(
  53         $PROFILE_STRICTNESS_WARN,
  54         $PROFILE_STRICTNESS_FATAL,
  55         $PROFILE_STRICTNESS_QUIET,
  56     );
  57
  58 #-----------------------------------------------------------------------------
  59
  60 1;
  61
  62 __END__
  63
  64 #-----------------------------------------------------------------------------
  65
  66 =pod
  67
  68 =for stopwords
  69
  70 =head1 NAME
  71
  72 Perl::Critic::Utils::Constants - Global constants.
  73
  74 =head1 DESCRIPTION
  75
  76 Defines commonly used constants for L<Perl::Critic>.
  77
  78
  79 =head1 IMPORTABLE CONSTANTS
  80
  81 =over
  82
  83 =item C<$PROFILE_STRICTNESS_WARN>
  84
  85 =item C<$PROFILE_STRICTNESS_FATAL>
  86
  87 =item C<$PROFILE_STRICTNESS_QUIET>
  88
  89 =item C<$PROFILE_STRICTNESS_DEFAULT>
  90
  91 =item C<%PROFILE_STRICTNESSES>
  92
  93 Valid values for the L<perlcritic/"-profile-strictness"> option.
  94 Determines whether recoverable problems found in a profile file appear
  95 as warnings, are fatal, or are ignored.
  96 C<$PROFILE_STRICTNESS_DEFAULT> is set to C<$PROFILE_STRICTNESS_WARN>.
  97 Importable via the C<:profile_strictness> tag.
  98
  99
 100 =back
 101
 102
 103 =head1 AUTHOR
 104
 105 Elliot Shank <perl@galumph.com>
 106
 107
 108 =head1 COPYRIGHT
 109
 110 Copyright (c) 2007-2008 Elliot Shank.  All rights reserved.
 111
 112 This program is free software; you can redistribute it and/or modify
 113 it under the same terms as Perl itself.  The full text of this license
 114 can be found in the LICENSE file included with this module.
 115
 116 =cut
 117
 118 # Local Variables:
 119 #   mode: cperl
 120 #   cperl-indent-level: 4
 121 #   fill-column: 78
 122 #   indent-tabs-mode: nil
 123 #   c-indentation-style: bsd
 124 # End:
 125 # ex: set ts=8 sts=4 sw=4 tw=78 ft=perl expandtab shiftround :