.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" 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::RegularExpressions::RequireBracesForMultiline 3pm"
.TH Perl::Critic::Policy::RegularExpressions::RequireBracesForMultiline 3pm 2024-12-15 "perl v5.40.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::RegularExpressions::RequireBracesForMultiline \- Use "{" and "}" to delimit multi\-line regexps.
.SH AFFILIATION
.IX Header "AFFILIATION"
This Policy is part of the core Perl::Critic
distribution.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Long regular expressions are hard to read.  A good practice is to use
the \f(CW\*(C`x\*(C'\fR modifier and break the regex into multiple lines with
comments explaining the parts.  But, with the usual \f(CW\*(C`//\*(C'\fR delimiters,
the beginning and end can be hard to match, especially in a \f(CW\*(C`s///\*(C'\fR
regexp.  Instead, try using \f(CW\*(C`{}\*(C'\fR characters to delimit your
expressions.
.PP
Compare these:
.PP
.Vb 5
\&    s/
\&       <a \es+ href="([^"]+)">
\&        (.*?)
\&       </a>
\&     /link=$1, text=$2/xms;
.Ve
.PP
vs.
.PP
.Vb 6
\&    s{
\&       <a \es+ href="([^"]+)">
\&        (.*?)
\&       </a>
\&     }
\&     {link=$1, text=$2}xms;
.Ve
.PP
Is that an improvement?  Marginally, but yes.  The curly braces lead
the eye better.
.SH CONFIGURATION
.IX Header "CONFIGURATION"
There is one option for this policy, \f(CW\*(C`allow_all_brackets\*(C'\fR.  If this
is true, then, in addition to allowing \f(CW\*(C`{}\*(C'\fR, the other matched pairs
of \f(CW\*(C`()\*(C'\fR, \f(CW\*(C`[]\*(C'\fR, and \f(CW\*(C`<>\*(C'\fR are allowed.
.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\-2023 Chris Dolan
.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