1Test::Code::TidyAll(3)User Contributed Perl DocumentationTest::Code::TidyAll(3)
2
3
4

NAME

6       Test::Code::TidyAll - Check that all your files are tidy and valid
7       according to tidyall
8

VERSION

10       version 0.83
11

SYNOPSIS

13         In a file like 't/tidyall.t':
14
15           #!/usr/bin/perl
16           use Test::Code::TidyAll;
17           tidyall_ok();
18

DESCRIPTION

20       Uses Code::TidyAll's "check_only" mode to check that all the files in
21       your project are in a tidied and valid state, i.e. that no plugins
22       throw errors or would change the contents of the file. Does not
23       actually modify any files.
24
25       By default, we look for the config file "tidyall.ini" or ".tidyallrc"
26       in the current directory and parent directories, which is generally the
27       right place if you are running prove.
28
29       When invoking Code::TidyAll, we pass "mode => 'test'" by default; see
30       modes.
31

EXPORTS

33       This module exports one subroutine, which is exported by default:
34
35   tidyall_ok(...)
36       Most options given to this subroutine will be passed along to the
37       Code::TidyAll constructor. For example, if you don't want to use the
38       tidyall cache and instead check all files every time:
39
40           tidyall_ok( no_cache => 1 );
41
42       or if you need to specify the config file:
43
44           tidyall_ok( conf_file => '/path/to/conf/file' );
45
46       By default, this subroutine will test every file that matches the
47       config you specify. However, you can pass a "files" parameter as an
48       array reference to override this, in which case only the files you
49       specify will be tested. These files are still filtered based on the
50       "select" and "exclude" rules defined in your config.
51

SEE ALSO

53       tidyall
54

SUPPORT

56       Bugs may be submitted at
57       <https://github.com/houseabsolute/perl-code-tidyall/issues>.
58

SOURCE

60       The source code repository for Code-TidyAll can be found at
61       <https://github.com/houseabsolute/perl-code-tidyall>.
62

AUTHORS

64       •   Jonathan Swartz <swartz@pobox.com>
65
66       •   Dave Rolsky <autarch@urth.org>
67

69       This software is copyright (c) 2011 - 2022 by Jonathan Swartz.
70
71       This is free software; you can redistribute it and/or modify it under
72       the same terms as the Perl 5 programming language system itself.
73
74       The full text of the license can be found in the LICENSE file included
75       with this distribution.
76
77
78
79perl v5.36.0                      2023-01-20            Test::Code::TidyAll(3)
Impressum