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
|
package Dist::Zilla::Plugin::PodVersion 6.032;
# ABSTRACT: add a VERSION head1 to each Perl document
use Moose;
with(
'Dist::Zilla::Role::FileMunger',
'Dist::Zilla::Role::FileFinderUser' => {
default_finders => [ ':InstallModules', ':ExecFiles' ],
},
);
use Dist::Zilla::Pragmas;
use namespace::autoclean;
#pod =head1 DESCRIPTION
#pod
#pod This plugin adds a C<=head1 VERSION> section to most perl files in the
#pod distribution, indicating the version of the dist being built. This section is
#pod added after C<=head1 NAME>. If there is no such section, the version section
#pod will not be added.
#pod
#pod Note that this plugin is not useful if you are using the
#pod L<[PodWeaver]|Dist::Zilla::Plugin::PodWeaver> plugin, as it also adds a
#pod C<=head1 VERSION> section (via the L<[Version]|Pod::Weaver::Section::Version>
#pod section).
#pod
#pod =cut
sub munge_files {
my ($self) = @_;
$self->munge_file($_) for @{ $self->found_files };
}
sub munge_file {
my ($self, $file) = @_;
return $self->munge_pod($file);
}
sub munge_pod {
my ($self, $file) = @_;
my @content = split /\n/, $file->content;
require List::Util;
List::Util->VERSION('1.33');
if (List::Util::any(sub { $_ =~ /^=head1 VERSION\b/ }, @content)) {
$self->log($file->name . ' already has a VERSION section in POD');
return;
}
for (0 .. $#content) {
next until $content[$_] =~ /^=head1 NAME/;
$_++; # move past the =head1 line itself
$_++ while $content[$_] =~ /^\s*$/;
$_++ while $content[$_] !~ /^\s*$/; # move past the abstract
$_++ while $content[$_] =~ /^\s*$/;
splice @content, $_ - 1, 0, (
q{},
"=head1 VERSION",
q{},
"version " . $self->zilla->version . q{},
);
$self->log_debug([ 'adding VERSION Pod section to %s', $file->name ]);
my $content = join "\n", @content;
$content .= "\n" if length $content;
$file->content($content);
return;
}
$self->log([
"couldn't find '=head1 NAME' in %s, not adding '=head1 VERSION'",
$file->name,
]);
}
__PACKAGE__->meta->make_immutable;
1;
#pod =head1 SEE ALSO
#pod
#pod Core Dist::Zilla plugins:
#pod L<PkgVersion|Dist::Zilla::Plugin::PkgVersion>,
#pod L<AutoVersion|Dist::Zilla::Plugin::AutoVersion>,
#pod L<NextRelease|Dist::Zilla::Plugin::NextRelease>.
#pod
#pod =cut
__END__
=pod
=encoding UTF-8
=head1 NAME
Dist::Zilla::Plugin::PodVersion - add a VERSION head1 to each Perl document
=head1 VERSION
version 6.032
=head1 DESCRIPTION
This plugin adds a C<=head1 VERSION> section to most perl files in the
distribution, indicating the version of the dist being built. This section is
added after C<=head1 NAME>. If there is no such section, the version section
will not be added.
Note that this plugin is not useful if you are using the
L<[PodWeaver]|Dist::Zilla::Plugin::PodWeaver> plugin, as it also adds a
C<=head1 VERSION> section (via the L<[Version]|Pod::Weaver::Section::Version>
section).
=head1 PERL VERSION
This module should work on any version of perl still receiving updates from
the Perl 5 Porters. This means it should work on any version of perl
released in the last two to three years. (That is, if the most recently
released version is v5.40, then this module should work on both v5.40 and
v5.38.)
Although it may work on older versions of perl, no guarantee is made that the
minimum required version will not be increased. The version may be increased
for any reason, and there is no promise that patches will be accepted to
lower the minimum required perl.
=head1 SEE ALSO
Core Dist::Zilla plugins:
L<PkgVersion|Dist::Zilla::Plugin::PkgVersion>,
L<AutoVersion|Dist::Zilla::Plugin::AutoVersion>,
L<NextRelease|Dist::Zilla::Plugin::NextRelease>.
=head1 AUTHOR
Ricardo SIGNES 😏 <cpan@semiotic.systems>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2024 by Ricardo SIGNES.
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
|
