.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 "Test::Regexp::Pattern 3pm"
.TH Test::Regexp::Pattern 3pm "2021-07-24" "perl v5.32.1" "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"
Test::Regexp::Pattern \- Test Regexp::Pattern patterns
.SH "VERSION"
.IX Header "VERSION"
This document describes version 0.009 of Test::Regexp::Pattern (from Perl distribution Test-Regexp-Pattern), released on 2021\-07\-21.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
To check all regexp patterns in a module:
.PP
.Vb 2
\& use Test::Regexp::Pattern;
\& regexp_patterns_in_module_ok("Foo::Bar", {opt => ...}, $msg);
.Ve
.PP
Alternatively, you can check all regexp patterns in all modules in a distro:
.PP
.Vb 6
\& # save in release\-regexp\-pattern.t, put in distro\*(Aqs t/ subdirectory
\& use Test::More;
\& plan skip_all => "Not release testing" unless $ENV{RELEASE_TESTING};
\& eval "use Test::Regexp::Pattern";
\& plan skip_all => "Test::Regexp::Pattern required for testing Regexp::Pattern patterns" if $@;
\& regexp_patterns_in_all_modules_ok({opt => ...}, $msg);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module performs various checks on a module's Regexp::Pattern patterns.
It is recommended that you include something like the above
\&\f(CW\*(C`release\-regexp\-pattern.t\*(C'\fR in your distribution if you add regexp patterns to
your code. If you use Dist::Zilla to build your distribution, there is a
[Regexp::Pattern] plugin which
automatically adds this release test file during build.
.SH "ACKNOWLEDGEMENTS"
.IX Header "ACKNOWLEDGEMENTS"
Some code taken from Test::Pod::Coverage by Andy Lester.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
All these functions are exported by default.
.ie n .SS "regexp_patterns_in_module_ok($module [, \e%opts ] [, $msg])"
.el .SS "regexp_patterns_in_module_ok($module [, \e%opts ] [, \f(CW$msg\fP])"
.IX Subsection "regexp_patterns_in_module_ok($module [, %opts ] [, $msg])"
Load \f(CW$module\fR and perform test for regexp patterns (\f(CW%RE\fR) in the module.
.PP
Available options:
.IP "\(bu" 4
test_examples => bool (default: 1)
.ie n .SS "regexp_patterns_in_all_modules_ok([ \e%opts ] [, $msg])"
.el .SS "regexp_patterns_in_all_modules_ok([ \e%opts ] [, \f(CW$msg\fP])"
.IX Subsection "regexp_patterns_in_all_modules_ok([ %opts ] [, $msg])"
Look for modules in directory \f(CW\*(C`lib\*(C'\fR (or \f(CW\*(C`blib\*(C'\fR instead, if it exists), and run
\&\f(CW\*(C`regexp_patterns_in_module_ok()\*(C'\fR against each of them.
.PP
Options are the same as in \f(CW\*(C`regexp_patterns_in_module_ok()\*(C'\fR.
.SH "HOMEPAGE"
.IX Header "HOMEPAGE"
Please visit the project's homepage at <https://metacpan.org/release/Test\-Regexp\-Pattern>.
.SH "SOURCE"
.IX Header "SOURCE"
Source repository is at <https://github.com/perlancar/perl\-Test\-Regexp\-Pattern>.
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests on the bugtracker website <https://rt.cpan.org/Public/Dist/Display.html?Name=Test\-Regexp\-Pattern>
.PP
When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
test-regexp-pattern, a command-line interface for
\&\f(CW\*(C`regexp_patterns_in_all_modules_ok()\*(C'\fR.
.PP
Regexp::Pattern
.PP
Dist::Zilla::Plugin::Regexp::Pattern
.SH "AUTHOR"
.IX Header "AUTHOR"
perlancar <perlancar@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2021, 2020, 2018 by perlancar@cpan.org.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.