.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Perl::Critic::Utils::Constants 3pm"
.TH Perl::Critic::Utils::Constants 3pm 2023-07-26 "perl v5.38.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Perl::Critic::Utils::Constants \- Global constants.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Defines commonly used constants for Perl::Critic.
.SH "INTERFACE SUPPORT"
.IX Header "INTERFACE SUPPORT"
This is considered to be a public module.  Any changes to its
interface will go through a deprecation cycle.
.SH "IMPORTABLE CONSTANTS"
.IX Header "IMPORTABLE CONSTANTS"
.ie n .IP $PROFILE_STRICTNESS_WARN 4
.el .IP \f(CW$PROFILE_STRICTNESS_WARN\fR 4
.IX Item "$PROFILE_STRICTNESS_WARN"
.PD 0
.ie n .IP $PROFILE_STRICTNESS_FATAL 4
.el .IP \f(CW$PROFILE_STRICTNESS_FATAL\fR 4
.IX Item "$PROFILE_STRICTNESS_FATAL"
.ie n .IP $PROFILE_STRICTNESS_QUIET 4
.el .IP \f(CW$PROFILE_STRICTNESS_QUIET\fR 4
.IX Item "$PROFILE_STRICTNESS_QUIET"
.ie n .IP $PROFILE_STRICTNESS_DEFAULT 4
.el .IP \f(CW$PROFILE_STRICTNESS_DEFAULT\fR 4
.IX Item "$PROFILE_STRICTNESS_DEFAULT"
.ie n .IP %PROFILE_STRICTNESSES 4
.el .IP \f(CW%PROFILE_STRICTNESSES\fR 4
.IX Item "%PROFILE_STRICTNESSES"
.PD
Valid values for the "\-profile\-strictness" in perlcritic option.
Determines whether recoverable problems found in a profile file appear
as warnings, are fatal, or are ignored.
\&\f(CW$PROFILE_STRICTNESS_DEFAULT\fR is set to \f(CW$PROFILE_STRICTNESS_WARN\fR.
Importable via the \f(CW\*(C`:profile_strictness\*(C'\fR tag.
.ie n .IP $PROFILE_COLOR_SEVERITY_HIGHEST_DEFAULT 4
.el .IP \f(CW$PROFILE_COLOR_SEVERITY_HIGHEST_DEFAULT\fR 4
.IX Item "$PROFILE_COLOR_SEVERITY_HIGHEST_DEFAULT"
Default for the \-color\-severity\-highest option. Importable via the
\&\f(CW\*(C`:color_severity\*(C'\fR tag.
.ie n .IP $PROFILE_COLOR_SEVERITY_HIGH_DEFAULT 4
.el .IP \f(CW$PROFILE_COLOR_SEVERITY_HIGH_DEFAULT\fR 4
.IX Item "$PROFILE_COLOR_SEVERITY_HIGH_DEFAULT"
Default for the \-color\-severity\-high option. Importable via the
\&\f(CW\*(C`:color_severity\*(C'\fR tag.
.ie n .IP $PROFILE_COLOR_SEVERITY_MEDIUM_DEFAULT 4
.el .IP \f(CW$PROFILE_COLOR_SEVERITY_MEDIUM_DEFAULT\fR 4
.IX Item "$PROFILE_COLOR_SEVERITY_MEDIUM_DEFAULT"
Default for the \-color\-severity\-medium option. Importable via the
\&\f(CW\*(C`:color_severity\*(C'\fR tag.
.ie n .IP $PROFILE_COLOR_SEVERITY_LOW_DEFAULT 4
.el .IP \f(CW$PROFILE_COLOR_SEVERITY_LOW_DEFAULT\fR 4
.IX Item "$PROFILE_COLOR_SEVERITY_LOW_DEFAULT"
Default for the \-color\-severity\-low option. Importable via the
\&\f(CW\*(C`:color_severity\*(C'\fR tag.
.ie n .IP $PROFILE_COLOR_SEVERITY_LOWEST_DEFAULT 4
.el .IP \f(CW$PROFILE_COLOR_SEVERITY_LOWEST_DEFAULT\fR 4
.IX Item "$PROFILE_COLOR_SEVERITY_LOWEST_DEFAULT"
Default for the \-color\-severity\-lowest option. Importable via the
\&\f(CW\*(C`:color_severity\*(C'\fR tag.
.ie n .IP @STRICT_EQUIVALENT_MODULES 4
.el .IP \f(CW@STRICT_EQUIVALENT_MODULES\fR 4
.IX Item "@STRICT_EQUIVALENT_MODULES"
.PD 0
.ie n .IP @WARNINGS_EQUIVALENT_MODULES 4
.el .IP \f(CW@WARNINGS_EQUIVALENT_MODULES\fR 4
.IX Item "@WARNINGS_EQUIVALENT_MODULES"
.PD
As the names suggest, these are lists of modules that are equivalent to
applying the strict or warnings pragma when loaded. At
the moment, both lists are exactly the same. \fBNote:\fR These lists are not
exhaustive; they only include the most commonly used modules. Policies that
use these lists should permit configuration of additional modules.
.SH AUTHOR
.IX Header "AUTHOR"
Elliot Shank <perl@galumph.com>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (c) 2007\-2011 Elliot Shank.
.PP
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.