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
|
package Code::TidyAll::Plugin::PodChecker;
use strict;
use warnings;
use Pod::Checker;
use Moo;
extends 'Code::TidyAll::Plugin';
our $VERSION = '0.55';
has 'warnings' => ( is => 'ro' );
sub validate_file {
my ( $self, $file ) = @_;
my $result;
my %options = ( defined( $self->warnings ) ? ( '-warnings' => $self->warnings ) : () );
my $checker = Pod::Checker->new(%options);
my $output;
open my $fh, '>', \$output;
$checker->parse_from_file( $file->stringify, $fh );
die $output
if $checker->num_errors > 0
|| ( $self->warnings && $checker->num_warnings > 0 );
}
1;
# ABSTRACT: Use podchecker with tidyall
__END__
=pod
=encoding UTF-8
=head1 NAME
Code::TidyAll::Plugin::PodChecker - Use podchecker with tidyall
=head1 VERSION
version 0.55
=head1 SYNOPSIS
In configuration:
; Check for errors, but ignore warnings
;
[PodChecker]
select = lib/**/*.{pm,pod}
; Die on level 1 warnings (can also be set to 2)
;
[PodChecker]
select = lib/**/*.{pm,pod}
warnings = 1
=head1 DESCRIPTION
Runs L<podchecker>, a POD validator, and dies if any problems were found.
=head1 INSTALLATION
Install podchecker from CPAN.
cpanm podchecker
=head1 CONFIGURATION
=over
=item warnings
Level of warnings to consider as errors - 1 or 2. By default, warnings will be
ignored.
=back
=head1 SUPPORT
Bugs may be submitted through
L<https://github.com/houseabsolute/perl-code-tidyall/issues>.
I am also usually active on IRC as 'drolsky' on C<irc://irc.perl.org>.
=head1 AUTHORS
=over 4
=item *
Jonathan Swartz <swartz@pobox.com>
=item *
Dave Rolsky <autarch@urth.org>
=back
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2011 - 2016 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.
=cut
|
