.\" -*- 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::Policy::Variables::RequireLocalizedPunctuationVars 3pm"
.TH Perl::Critic::Policy::Variables::RequireLocalizedPunctuationVars 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::Policy::Variables::RequireLocalizedPunctuationVars \- Magic variables should be assigned as "local".
.SH AFFILIATION
.IX Header "AFFILIATION"
This Policy is part of the core Perl::Critic
distribution.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Punctuation variables (and their English.pm equivalents) are global
variables.  Messing with globals is dangerous in a complex program as
it can lead to very subtle and hard to fix bugs.  If you must change a
magic variable in a non-trivial program, do it in a local scope.
.PP
For example, to slurp a filehandle into a scalar, it's common to set
the record separator to undef instead of a newline.  If you choose to
do this (instead of using Path::Tiny!) then be sure to
localize the global and change it for as short a time as possible.
.PP
.Vb 3
\&    # BAD:
\&    $/ = undef;
\&    my $content = <$fh>;
\&
\&    # BETTER:
\&    my $content;
\&    {
\&        local $/ = undef;
\&        $content = <$fh>;
\&    }
\&
\&    # A popular idiom:
\&    my $content = do { local $/ = undef; <$fh> };
.Ve
.PP
This policy also allows the use of \f(CW\*(C`my\*(C'\fR.  Perl prevents using \f(CW\*(C`my\*(C'\fR
with "proper" punctuation variables, but allows \f(CW$a\fR, \f(CW@ARGV\fR, the
names declared by English, etc.  This is not a good coding
practice, however it is not the concern of this specific policy to
complain about that.
.PP
There are exemptions for \f(CW$_\fR and \f(CW@_\fR, and the English equivalent
\&\f(CW$ARG\fR.
.SH CONFIGURATION
.IX Header "CONFIGURATION"
You can configure your own exemptions using the \f(CW\*(C`allow\*(C'\fR option:
.PP
.Vb 2
\&    [Variables::RequireLocalizedPunctuationVars]
\&    allow = @ARGV $ARGV
.Ve
.PP
These are added to the default exemptions.
.SH CREDITS
.IX Header "CREDITS"
Initial development of this policy was supported by a grant from the
Perl Foundation.
.SH AUTHOR
.IX Header "AUTHOR"
Chris Dolan <cdolan@cpan.org>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (c) 2007\-2011 Chris Dolan.  Many rights reserved.
.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.