| 1 | package Dist::Zilla::Plugin::PodCoverageTests 6.040; | ||
| 2 | # ABSTRACT: a author test for Pod coverage | ||
| 3 | |||
| 4 | 9 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 5 | 9 | extends 'Dist::Zilla::Plugin::InlineFiles'; | |
| 6 | 9 | with 'Dist::Zilla::Role::PrereqSource'; | |
| 7 | |||
| 8 | 9 | ▶ | use Dist::Zilla::Pragmas; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 9 | |||
| 10 | 9 | ▶ | use namespace::autoclean; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 11 | |||
| 12 | #pod =head1 SYNOPSIS | ||
| 13 | #pod | ||
| 14 | #pod # Add this line to dist.ini | ||
| 15 | #pod [PodCoverageTests] | ||
| 16 | #pod | ||
| 17 | #pod # Run this in the command line to test for POD coverage: | ||
| 18 | #pod $ dzil test --release | ||
| 19 | #pod | ||
| 20 | #pod =head1 DESCRIPTION | ||
| 21 | #pod | ||
| 22 | #pod This is an extension of L<Dist::Zilla::Plugin::InlineFiles>, providing the | ||
| 23 | #pod following files: | ||
| 24 | #pod | ||
| 25 | #pod xt/author/pod-coverage.t - a standard Test::Pod::Coverage test | ||
| 26 | #pod | ||
| 27 | #pod This test uses L<Pod::Coverage::TrustPod> to check your Pod coverage. This | ||
| 28 | #pod means that to indicate that some subs should be treated as covered, even if no | ||
| 29 | #pod documentation can be found, you can add: | ||
| 30 | #pod | ||
| 31 | #pod =for Pod::Coverage sub_name other_sub this_one_too | ||
| 32 | #pod | ||
| 33 | #pod L<Test::Pod::Coverage> C<1.08> and L<Pod::Coverage::TrustPod> will be added as | ||
| 34 | #pod C<develop requires> dependencies. | ||
| 35 | #pod | ||
| 36 | #pod One can run the release tests by invoking C<dzil test --release>. | ||
| 37 | #pod | ||
| 38 | #pod =cut | ||
| 39 | |||
| 40 | # Register the author test prereq as a "develop requires" | ||
| 41 | # so it will be listed in "dzil listdeps --author" | ||
| 42 | 9 | ▶ | sub register_prereqs { |
|
Subroutine
register_prereqs: called CC=1 SCAR=0.0
Pod
undocumented
| |||
| 43 | 9 | my ($self) = @_; | |
| 44 | |||
| 45 | 9 | $self->zilla->register_prereqs( | |
| 46 | { | ||
| 47 | type => 'requires', | ||
| 48 | phase => 'develop', | ||
| 49 | }, | ||
| 50 | 'Test::Pod::Coverage' => '1.08', | ||
| 51 | 'Pod::Coverage::TrustPod' => 0, | ||
| 52 | ); | ||
| 53 | } | ||
| 54 | |||
| 55 | 9 | __PACKAGE__->meta->make_immutable; | |
| 56 | 9 | 1; | |
| 57 | |||
| 58 | =pod | ||
| 59 | |||
| 60 | =encoding UTF-8 | ||
| 61 | |||
| 62 | =head1 NAME | ||
| 63 | |||
| 64 | Dist::Zilla::Plugin::PodCoverageTests - a author test for Pod coverage | ||
| 65 | |||
| 66 | =head1 VERSION | ||
| 67 | |||
| 68 | version 6.040 | ||
| 69 | |||
| 70 | =head1 SYNOPSIS | ||
| 71 | |||
| 72 | # Add this line to dist.ini | ||
| 73 | [PodCoverageTests] | ||
| 74 | |||
| 75 | # Run this in the command line to test for POD coverage: | ||
| 76 | $ dzil test --release | ||
| 77 | |||
| 78 | =head1 DESCRIPTION | ||
| 79 | |||
| 80 | This is an extension of L<Dist::Zilla::Plugin::InlineFiles>, providing the | ||
| 81 | following files: | ||
| 82 | |||
| 83 | xt/author/pod-coverage.t - a standard Test::Pod::Coverage test | ||
| 84 | |||
| 85 | This test uses L<Pod::Coverage::TrustPod> to check your Pod coverage. This | ||
| 86 | means that to indicate that some subs should be treated as covered, even if no | ||
| 87 | documentation can be found, you can add: | ||
| 88 | |||
| 89 | =for Pod::Coverage sub_name other_sub this_one_too | ||
| 90 | |||
| 91 | L<Test::Pod::Coverage> C<1.08> and L<Pod::Coverage::TrustPod> will be added as | ||
| 92 | C<develop requires> dependencies. | ||
| 93 | |||
| 94 | One can run the release tests by invoking C<dzil test --release>. | ||
| 95 | |||
| 96 | =head1 PERL VERSION | ||
| 97 | |||
| 98 | This module should work on any version of perl still receiving updates from | ||
| 99 | the Perl 5 Porters. This means it should work on any version of perl | ||
| 100 | released in the last two to three years. (That is, if the most recently | ||
| 101 | released version is v5.40, then this module should work on both v5.40 and | ||
| 102 | v5.38.) | ||
| 103 | |||
| 104 | Although it may work on older versions of perl, no guarantee is made that the | ||
| 105 | minimum required version will not be increased. The version may be increased | ||
| 106 | for any reason, and there is no promise that patches will be accepted to | ||
| 107 | lower the minimum required perl. | ||
| 108 | |||
| 109 | =head1 AUTHOR | ||
| 110 | |||
| 111 | Ricardo SIGNES 😏 <cpan@semiotic.systems> | ||
| 112 | |||
| 113 | =head1 COPYRIGHT AND LICENSE | ||
| 114 | |||
| 115 | This software is copyright (c) 2026 by Ricardo SIGNES. | ||
| 116 | |||
| 117 | This is free software; you can redistribute it and/or modify it under | ||
| 118 | the same terms as the Perl 5 programming language system itself. | ||
| 119 | |||
| 120 | =cut | ||
| 121 | |||
| 122 | __DATA__ | ||