Test::Code::TidyAll - Check that all your files are tidy and valid according to tidyall
version 0.65
In a file like 't/tidyall.t': #!/usr/bin/perl use Test::Code::TidyAll; tidyall_ok();
Uses Code::TidyAll's check_only 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.
check_only
By default, we look for the config file tidyall.ini or .tidyallrc in the current directory and parent directories, which is generally the right place if you are running prove.
tidyall.ini
.tidyallrc
When invoking Code::TidyAll, we pass mode => 'test' by default; see modes.
mode => 'test'
This module exports one subroutine, which is exported by default:
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:
tidyall_ok( no_cache => 1 );
or if you need to specify the config file:
tidyall_ok( conf_file => '/path/to/conf/file' );
By default, this subroutine will test every file that matches the config you specify. However, you can pass a files 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 select and exclude rules defined in your config.
files
select
exclude
tidyall
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.
irc://irc.perl.org
The source code repository for Code-TidyAll can be found at https://github.com/houseabsolute/perl-code-tidyall.
Jonathan Swartz <swartz@pobox.com>
Dave Rolsky <autarch@urth.org>
This software is copyright (c) 2011 - 2017 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.
To install Code::TidyAll, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Code::TidyAll
CPAN shell
perl -MCPAN -e shell install Code::TidyAll
For more information on module installation, please visit the detailed CPAN module installation guide.