.\" Automatically generated by Pod::Man 4.14 (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
..
.\" 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::Code::TidyAll 3pm"
.TH Test::Code::TidyAll 3pm "2022-12-31" "perl v5.36.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"
Test::Code::TidyAll \- Check that all your files are tidy and valid according to tidyall
.SH "VERSION"
.IX Header "VERSION"
version 0.83
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  In a file like \*(Aqt/tidyall.t\*(Aq:
\&
\&    #!/usr/bin/perl
\&    use Test::Code::TidyAll;
\&    tidyall_ok();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Uses Code::TidyAll's \f(CW\*(C`check_only\*(C'\fR mode to check that all the files in your
project are in a tidied and valid state, i.e. that no plugins throw errors or
would change the contents of the file. Does not actually modify any files.
.PP
By default, we look for the config file \f(CW\*(C`tidyall.ini\*(C'\fR or \f(CW\*(C`.tidyallrc\*(C'\fR in the
current directory and parent directories, which is generally the right place if
you are running prove.
.PP
When invoking Code::TidyAll, we pass \f(CW\*(C`mode => \*(Aqtest\*(Aq\*(C'\fR by default; see
modes.
.SH "EXPORTS"
.IX Header "EXPORTS"
This module exports one subroutine, which is exported by default:
.SS "tidyall_ok(...)"
.IX Subsection "tidyall_ok(...)"
Most options given to this subroutine will be passed along to the
Code::TidyAll constructor. For example, if you don't want to use the tidyall
cache and instead check all files every time:
.PP
.Vb 1
\&    tidyall_ok( no_cache => 1 );
.Ve
.PP
or if you need to specify the config file:
.PP
.Vb 1
\&    tidyall_ok( conf_file => \*(Aq/path/to/conf/file\*(Aq );
.Ve
.PP
By default, this subroutine will test every file that matches the config you
specify. However, you can pass a \f(CW\*(C`files\*(C'\fR parameter as an array reference to
override this, in which case only the files you specify will be tested. These
files are still filtered based on the \f(CW\*(C`select\*(C'\fR and \f(CW\*(C`exclude\*(C'\fR rules defined in
your config.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
tidyall
.SH "SUPPORT"
.IX Header "SUPPORT"
Bugs may be submitted at <https://github.com/houseabsolute/perl\-code\-tidyall/issues>.
.SH "SOURCE"
.IX Header "SOURCE"
The source code repository for Code-TidyAll can be found at <https://github.com/houseabsolute/perl\-code\-tidyall>.
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "\(bu" 4
Jonathan Swartz <swartz@pobox.com>
.IP "\(bu" 4
Dave Rolsky <autarch@urth.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2011 \- 2022 by Jonathan Swartz.
.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.
.PP
The full text of the license can be found in the
\&\fI\s-1LICENSE\s0\fR file included with this distribution.