—package
Code::TidyAll::Plugin::PodChecker;
use
Pod::Checker;
use
Moo;
our
$VERSION
=
'0.29'
;
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
,
$fh
);
die
$output
if
$checker
->num_errors > 0
|| (
$self
->warnings &&
$checker
->num_warnings > 0 );
}
1;
# ABSTRACT: Use podchecker with tidyall
__END__
=pod
=head1 NAME
Code::TidyAll::Plugin::PodChecker - Use podchecker with tidyall
=head1 VERSION
version 0.29
=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 SEE ALSO
L<Code::TidyAll>
=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 - 2015 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