1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
# NAME
Code::TidyAll - Engine for tidyall, your all-in-one code tidier and validator
# VERSION
version 0.84
# 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\_from\_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%3A%3ACode%3A%3ATidyAll) 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%3A%3ATidyAll%3A%3AResult) 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%3A%3ATidyAll%3A%3AResult) 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%3A%3ATidyAll%3A%3AResult) 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%3A%3ATidyAll%3A%3APlugin) 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).
# 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 <swartz@pobox.com>
- Dave Rolsky <autarch@urth.org>
# CONTRIBUTORS
- Adam Herzog <adam@adamherzog.com>
- Andreas Vögele <andreas@andreasvoegele.com>
- Andy Jack <andyjack@cpan.org>
- Bernhard Schmalhofer <Bernhard.Schmalhofer@gmx.de>
- Finn Smith <finn@timeghost.net>
- George Hartzell <georgewh@gene.com>
- Graham Knop <haarg@haarg.org>
- Gregory Oschwald <goschwald@maxmind.com>
- Joe Crotty <joe.crotty@returnpath.net>
- Kenneth Ölwing <kenneth.olwing@skatteverket.se>
- Mark Fowler <mark@twoshortplanks.com>
- Mark Grimes <mgrimes@cpan.org>
- Martin Gruner <martin.gruner@otrs.com>
- mauke <lukasmai.403@gmail.com>
- Mohammad S Anwar <mohammad.anwar@yahoo.com>
- Nick Tonkin <ntonkin@bur-ntonkin-m1.corp.endurance.com>
- Olaf Alders <olaf@wundersolutions.com>
- Paulo Custodio <pauloscustodio@gmail.com>
- Pavel Dostál <pdostal@suse.cz>
- Pedro Melo <melo@simplicidade.org>
- Ricardo Signes <rjbs@cpan.org>
- Sergey Romanov <sromanov-dev@yandex.ru>
- Shlomi Fish <shlomif@shlomifish.org>
- timgimyee <tim.gim.yee@gmail.com>
# COPYRIGHT AND LICENSE
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.
|
