.\" -*- 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::Modules::ProhibitEvilModules 3pm"
.TH Perl::Critic::Policy::Modules::ProhibitEvilModules 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::Modules::ProhibitEvilModules \- Ban modules that aren't blessed by your shop.
.SH AFFILIATION
.IX Header "AFFILIATION"
This Policy is part of the core Perl::Critic
distribution.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Use this policy if you wish to prohibit the use of specific modules.
These may be modules that you feel are deprecated, buggy, unsupported,
insecure, or just don't like.
.SH CONFIGURATION
.IX Header "CONFIGURATION"
The set of prohibited modules is configurable via the \f(CW\*(C`modules\*(C'\fR and
\&\f(CW\*(C`modules_file\*(C'\fR options.
.PP
The value of \f(CW\*(C`modules\*(C'\fR should be a string of space-delimited, fully
qualified module names and/or regular expressions.  An example of
prohibiting two specific modules in a \fI.perlcriticrc\fR file:
.PP
.Vb 2
\&    [Modules::ProhibitEvilModules]
\&    modules = Getopt::Std Autoload
.Ve
.PP
Regular expressions are identified by values beginning and ending with
slashes.  Any module with a name that matches \f(CW\*(C`m/pattern/\*(C'\fR will be
forbidden.  For example:
.PP
.Vb 2
\&    [Modules::ProhibitEvilModules]
\&    modules = /Acme::/
.Ve
.PP
would cause all modules that match \f(CW\*(C`m/Acme::/\*(C'\fR to be forbidden.
.PP
In addition, you can override the default message ("Prohibited module
"\fImodule\fR" used") with your own, in order to give suggestions for
alternative action.  To do so, put your message in curly braces after
the module name or regular expression.  Like this:
.PP
.Vb 2
\&    [Modules::ProhibitEvilModules]
\&    modules = Fatal {Found use of Fatal. Use autodie instead} /Acme::/ {We don\*(Aqt use joke modules}
.Ve
.PP
Similarly, the \f(CW\*(C`modules_file\*(C'\fR option gives the name of a file
containing specifications for prohibited modules.  Only one module
specification is allowed per line and comments start with an octothorp
and run to end of line; no curly braces are necessary for delimiting
messages:
.PP
.Vb 1
\&    Evil     # Prohibit the "Evil" module and use the default message.
\&
\&    # Prohibit the "Fatal" module and give a replacement message.
\&    Fatal Found use of Fatal. Use autodie instead.
\&
\&    # Use a regular expression.
\&    /Acme::/     We don\*(Aqt use joke modules.
.Ve
.PP
By default, the modules that have been deprecated by the Perl 5 Porters are
reported; at the time of writing these are Class::ISA,
Pod::Plainer, Shell, and Switch.
Specifying a value for the \f(CW\*(C`modules\*(C'\fR option will override this.
.SH NOTES
.IX Header "NOTES"
Note that this policy doesn't apply to pragmas.
.SH AUTHOR
.IX Header "AUTHOR"
Jeffrey Ryan Thalhammer <jeff@imaginative\-software.com>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (c) 2005\-2011 Imaginative Software Systems.  All 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.