NAME

Code::TidyAll::Plugin - Create plugins for tidying or validating code

VERSION

version 0.13

SYNOPSIS

package Code::TidyAll::Plugin::SomeTidier;
use Moo;
extends 'Code::TidyAll::Plugin';

sub transform_source {
    my ( $self, source ) = @_;
    ...
    return $source;
}


package Code::TidyAll::Plugin::SomeValidator;
use Moo;
extends 'Code::TidyAll::Plugin';

sub validate_file {
    my ( $self, $file ) = @_;
    die "not valid" if ...;
}

DESCRIPTION

To use a tidier or validator with tidyall it must have a corresponding plugin class that inherits from this class. This document describes how to implement a new plugin.

The easiest way to start is to look at existing plugins, such as Code::TidyAll::Plugin::PerlTidy and Code::TidyAll::Plugin::PerlCritic.

NAMING

If you are going to publicly release your plugin, call it 'Code::TidyAll::Plugin::something' so that users can find it easily and refer to it by its short name in configuration.

If it's an internal plugin, you can call it whatever you like and refer to it with a plus sign prefix in the config file, e.g.

[+My::Tidier::Class]
select = **/*.{pl,pm,t}

CONSTRUCTOR AND ATTRIBUTES

Your plugin constructor will be called with the configuration key/value pairs as parameters. e.g. given

[PerlCritic]
select = lib/**/*.pm
ignore = lib/UtterHack.pm
argv = -severity 3

then Code::TidyAll::Plugin::PerlCritic would be constructed with parameters

select => 'lib/**/*.pm', 
ignore = 'lib/UtterHack.pm',
argv = '-severity 3'

The following attributes are part of this base class. Your subclass can declare others, of course.

argv

A standard attribute for passing command line arguments.

cmd

A standard attribute for specifying the name of the command to run, e.g. "/usr/local/bin/perlcritic".

name

Name of the plugin to be used in error messages etc.

tidyall

A weak reference back to the Code::TidyAll object.

select, ignore

Select and ignore patterns - you can ignore these.

METHODS

Your plugin may define one or more of these methods. They are all no-ops by default.

preprocess_source ($source)

Receives source code as a string; returns the processed string, or dies with error. This runs on all plugins before any of the other methods.

transform_source ($source)

Receives source code as a string; returns the transformed string, or dies with error. This is repeated multiple times if --iterations was passed or specified in the configuration file.

transform_file ($file)

Receives filename; transforms the file in place, or dies with error. Note that the file will be a temporary copy of the user's file with the same basename; your changes will only propagate back if there was no error reported from any plugin. This is repeated multiple times if --iterations was passed or specified in the configuration file.

validate_source ($source)

Receives source code as a string; dies with error if invalid. Return value will be ignored.

validate_file ($file)

Receives filename; validates file and dies with error if invalid. Should not modify file! Return value will be ignored.

postprocess_source ($source)

Receives source code as a string; returns the processed string, or dies with error. This runs on all plugins after any of the other methods.

SEE ALSO

Code::TidyAll

AUTHOR

Jonathan Swartz <swartz@pobox.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2011 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.