# NAME

Code::TidyAll - Engine for tidyall, your all-in-one code tidier and validator

# VERSION

version 0.73

# SYNOPSIS

   use Code::TidyAll;

   my $ct = Code::TidyAll->new_from_conf_file(
       '/path/to/conf/file',
       ...
   );

   # or

   my $ct = Code::TidyAll->new(
       root_dir => '/path/to/root',
       plugins  => {
           perltidy => {
               select => 'lib/**/*.(pl|pm)',
               argv => '-noll -it=2',
           },
           ...
       }
   );

   # then...

   $ct->process_paths($file1, $file2);

# DESCRIPTION

This is the engine used by [tidyall](https://metacpan.org/pod/tidyall) - read that first to get an overview.

You can call this API from your own program instead of executing `tidyall`.

# METHODS

This class offers the following methods:

## Code::TidyAll->new(%params)

The regular constructor. Must pass at least _plugins_ and _root\_dir_.

## $tidyall->new\_with\_conf\_file( $conf\_file, %params )

Takes a conf file path, followed optionally by a set of key/value parameters.
Reads parameters out of the conf file and combines them with the passed
parameters (the latter take precedence), and calls the regular constructor.

If the conf file or params defines _tidyall\_class_, then that class is
constructed instead of `Code::TidyAll`.

### Constructor parameters

- plugins

   Specify a hash of plugins, each of which is itself a hash of options. This is
   equivalent to what would be parsed out of the sections in the configuration
   file.

- selected\_plugins

   An arrayref of plugins to be used. This overrides the `mode` parameter.

   This is really only useful if you're getting configuration from a config file
   and want to narrow the set of plugins to be run.

   Note that plugins will still only run on files which match their `select` and
   `ignore` configuration.

- cache\_model\_class

   The cache model class. Defaults to `Code::TidyAll::CacheModel`

- cache

   The cache instance (e.g. an instance of `Code::TidyAll::Cache` or a `CHI`
   instance.) An instance of `Code::TidyAll::Cache` is automatically instantiated
   by default.

- backup\_ttl
- check\_only

   If this is true, then we simply check that files pass validation steps and that
   tidying them does not change the file. Any changes from tidying are not
   actually written back to the file.

- no\_cleanup

   A boolean indicating if we should skip cleaning temporary files or not.
   Defaults to false.

- inc

   An arrayref of directories to prepend to `@INC`. This can be set via the
   command-line as `-I`, but you can also set it in a config file.

   This affects both loading and running plugins.

- data\_dir
- iterations
- mode
- no\_backups
- no\_cache
- output\_suffix
- quiet
- root\_dir
- ignore
- verbose

   These options are the same as the equivalent `tidyall` command-line options,
   replacing dashes with underscore (e.g. the `backup-ttl` option becomes
   `backup_ttl` here).

- msg\_outputter

   This is a subroutine reference that is called whenever a message needs to be
   printed in some way. The sub receives a `sprintf()` format string followed by
   one or more parameters. The default sub used simply calls `printf "$format\n",
   @_` but [Test::Code::TidyAll](https://metacpan.org/pod/Test::Code::TidyAll) overrides this to use the `Test::Builder->diag` method.

## $tidyall->process\_paths( $path, ... )

This method iterates through a list of paths, processing all the files it
finds. It will descend into subdirectories if `recursive` flag is true.
Returns a list of [Code::TidyAll::Result](https://metacpan.org/pod/Code::TidyAll::Result) objects, one for each file.

## $tidyall->process\_file( $file )

Process the one _file_, meaning:

- Check the cache and return immediately if file has not changed.
- Apply appropriate matching plugins.
- Print success or failure result to STDOUT, depending on quiet/verbose settings.
- Write to the cache if caching is enabled.
- Return a [Code::TidyAll::Result](https://metacpan.org/pod/Code::TidyAll::Result) object.

## $tidyall->process\_source( $source, $path )

Like `process_file`, but process the _source_ string instead of a file, and
does not read from or write to the cache. You must still pass the relative
_path_ from the root as the second argument, so that we know which plugins to
apply. Returns a [Code::TidyAll::Result](https://metacpan.org/pod/Code::TidyAll::Result) object.

## $tidyall->plugins\_for\_path($path)

Given a relative _path_ from the root, returns a list of
[Code::TidyAll::Plugin](https://metacpan.org/pod/Code::TidyAll::Plugin) objects that apply to it, or an empty list if no
plugins apply.

## $tidyall->find\_matched\_files

Returns a list of sorted files that match at least one plugin in configuration.

## Code::TidyAll->find\_conf\_file( $conf\_names, $start\_dir )

Start in the _start\_dir_ and work upwards, looking for a file matching one of
the _conf\_names_. Returns the pathname if found or throw an error if not
found.

# SUPPORT

Bugs may be submitted at
[https://github.com/houseabsolute/perl-code-tidyall/issues](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](https://github.com/houseabsolute/perl-code-tidyall).

# AUTHORS

- Jonathan Swartz <[email protected]>
- Dave Rolsky <[email protected]>

# CONTRIBUTORS

- Adam Herzog <[email protected]>
- Andy Jack <[email protected]>
- Finn Smith <[email protected]>
- George Hartzell <[email protected]>
- Graham Knop <[email protected]>
- Gregory Oschwald <[email protected]>
- Joe Crotty <[email protected]>
- Mark Fowler <[email protected]>
- Mark Grimes <[email protected]>
- Martin Gruner <[email protected]>
- Mohammad S Anwar <[email protected]>
- Nick Tonkin <[email protected]>
- Nick Tonkin <[email protected]>
- Olaf Alders <[email protected]>
- Pedro Melo <[email protected]>
- Ricardo Signes <[email protected]>
- Sergey Romanov <[email protected]>
- Shlomi Fish <[email protected]>
- timgimyee <[email protected]>

# 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.

You are viewing proxied material from ftp.icm.edu.pl. The copyright of proxied material belongs to its original authors. Any comments or complaints in relation to proxied material should be directed to the original authors of the content concerned. Please see the disclaimer for more details.