NAME

Code::TidyAll::Plugin::GenericValidator - A plugin to run any executable as a validator

VERSION

version 0.74

SYNOPSIS

    # In your tidyall config
    [GenericValidator / JSONOrderedTidy]
    cmd = json-ordered-tidy
    argv = -check
    ok_exit_codes = 0 1

DESCRIPTION

This plugin allows you to define any executable as a validator.

CONFIGURATION

This plugin accepts the following configuration options:

cmd

This is the command to be run. This is required.

argv

This is a string containing additional arguments to be passed to the command. These arguments will always be passed.

file_flag

This is the flag used to tell the command what file to operate on, if it has one.

By default, the file is simply passed as the last argument. However, many commands will want this passed with a flag like -f, --file, or --input.

ok_exit_codes

By default, any exit code other than 0 is considered an exception. However, many commands use their exit code to indicate that there was a validation issue as opposed to an exception.

You can specify multiple exit codes either by listing ok_exit_codes multiple times or as a space-separate list.

SUPPORT

Bugs may be submitted at https://github.com/houseabsolute/perl-code-tidyall/issues.

I am also usually active on IRC as 'autarch' on irc://irc.perl.org.

SOURCE

The source code repository for Code-TidyAll can be found at https://github.com/houseabsolute/perl-code-tidyall.

AUTHORS

  • Jonathan Swartz <swartz@pobox.com>

  • Dave Rolsky <autarch@urth.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2011 - 2019 by Jonathan Swartz.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

The full text of the license can be found in the LICENSE file included with this distribution.