Code::TidyAll::Result - Result returned from processing a file/source
version 0.84
my $ct = Code::TidyAll->new(...); my $result = $ct->process_file($file); if ($result->error) { ... }
Represents the result of Code::TidyAll->process_file and Code::TidyAll->process_file. A list of these is returned from Code::TidyAll-process_paths >>.
Code::TidyAll->process_file
Code::TidyAll-
This class provides the following methods:
The path that was processed, relative to the root (e.g. "lib/Foo.pm")
A string, one of
no_match - No plugins matched this file
no_match
cached - Cache hit (file had not changed since last processed)
cached
error - An error occurred while applying one of the plugins
error
checked - File was successfully checked and did not change
checked
tidied - File was successfully checked and changed
tidied
Contains the original contents if state is 'tidied' and with some errors (like when a file needs tidying in check-only mode)
Contains the new contents if state is 'tidied'
Contains the error message if state is 'error'
Returns true iff state is not 'error'
Bugs may be submitted at https://github.com/houseabsolute/perl-code-tidyall/issues.
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 - 2023 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.