.\" 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 "Code::TidyAll::Plugin::GenericTransformer 3pm"
.TH Code::TidyAll::Plugin::GenericTransformer 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"
Code::TidyAll::Plugin::GenericTransformer \- A plugin to run any executable as a transformer
.SH "VERSION"
.IX Header "VERSION"
version 0.83
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 5
\&    # In your tidyall config
\&    [GenericTransformer / JSONOrderedTidy]
\&    cmd = json\-ordered\-tidy
\&    argv = \-stdout
\&    ok_exit_codes = 0 1
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This plugin allows you to define any executable as a transformer.
.SH "CONFIGURATION"
.IX Header "CONFIGURATION"
This plugin accepts the following configuration options:
.SS "cmd"
.IX Subsection "cmd"
This is the command to be run. This is required.
.SS "argv"
.IX Subsection "argv"
This is a string containing additional arguments to be passed to the command.
These arguments will always be passed.
.SS "file_flag"
.IX Subsection "file_flag"
This is the flag used to tell the command what file to operate on, if it has
one.
.PP
By default, the file is simply passed as the last argument. However, many
commands will want this passed with a flag like \f(CW\*(C`\-f\*(C'\fR, \f(CW\*(C`\-\-file\*(C'\fR, or
\&\f(CW\*(C`\-\-input\*(C'\fR.
.SS "ok_exit_codes"
.IX Subsection "ok_exit_codes"
By default, any exit code other than \f(CW0\fR is considered an exception. However,
many commands use their exit code to indicate that there was a validation issue
as opposed to an exception.
.PP
You can specify multiple exit codes either by listing \f(CW\*(C`ok_exit_codes\*(C'\fR multiple
times or as a space-separate list.
.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.