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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
#
# This file is part of Dist-Zilla-Plugin-Prepender
#
# This software is copyright (c) 2009 by Jerome Quelin.
#
# This is free software; you can redistribute it and/or modify it under
# the same terms as the Perl 5 programming language system itself.
#
use 5.008;
use strict;
use warnings;
package Dist::Zilla::Plugin::Prepender;
BEGIN {
$Dist::Zilla::Plugin::Prepender::VERSION = '1.112280';
}
# ABSTRACT: prepend lines at the top of your perl files
use Moose;
use MooseX::Has::Sugar;
with 'Dist::Zilla::Role::FileMunger';
# -- attributes
# accept some arguments multiple times.
sub mvp_multivalue_args { qw{ line skip } }
has copyright => ( ro, default => 1 );
has _lines => (
ro, lazy, auto_deref,
isa => 'ArrayRef[Str]',
init_arg => 'line',
default => sub { [] },
);
has _skips => (
ro, lazy, auto_deref,
isa => 'ArrayRef[Str]',
init_arg => 'skip',
default => sub { [] },
);
# -- public methods
sub munge_file {
my ($self, $file) = @_;
foreach my $skip ( $self->_skips ){
return if $file->name =~ $skip;
}
return $self->_munge_perl($file) if $file->name =~ /\.(?:pm|pl)$/i;
return $self->_munge_perl($file) if $file->content =~ /^#!(?:.*)perl(?:$|\s)/;
return;
}
# -- private methods
#
# $self->_munge_perl($file);
#
# munge content of perl $file: add stuff at the top of the file
#
my %re = (
shebang => qr/^#!(?:.*)perl(?:$|\s.*$)/m,
vimmode => qr/^#\s*(?:vim?|ex):.*$/m,
emacsmode => qr/^#\s*-\*-[^\n]+?-\*-.*$/m,
);
sub _munge_perl {
my ($self, $file) = @_;
my @prepend;
# add copyright information if requested
if ( $self->copyright ) {
my @copyright = (
'',
"This file is part of " . $self->zilla->name,
'',
split(/\n/, $self->zilla->license->notice),
'',
);
push @prepend, map { length($_) ? "# $_" : '#' } @copyright;
}
# add hand-written lines to prepend
push @prepend, $self->_lines;
my $prepend = join "\n", @prepend;
# insertion point depends if there's a shebang line
my $content = $file->content;
if ( $content =~ /\A$re{shebang}\n(?:$re{vimmode}|$re{emacsmode})/ ) {
# skip two lines
$content =~ s/\A([^\n]+\n[^\n]+\n)/$1$prepend\n/;
} elsif ( $content =~ /\A(?:$re{shebang}|$re{vimmode}|$re{emacsmode})/ ) {
# skip one line
$content =~ s/\n/\n$prepend\n/;
} else {
$content =~ s/\A/$prepend\n/;
}
$file->content($content);
}
__PACKAGE__->meta->make_immutable;
no Moose;
1;
=pod
=head1 NAME
Dist::Zilla::Plugin::Prepender - prepend lines at the top of your perl files
=head1 VERSION
version 1.112280
=head1 SYNOPSIS
In your F<dist.ini>:
[Prepender]
copyright = 0
line = use strict;
line = use warnings;
skip = t/data/.+\.pl
skip = something-else-unnecessary
=head1 DESCRIPTION
This plugin will prepend the specified lines in each Perl module or
program within the distribution. For scripts having a shebang line,
lines will be inserted just after it.
This is useful to enforce a set of pragmas to your files (since pragmas
are lexical, they will be active for the whole file), or to add some
copyright comments, as the fsf recommends.
The module accepts the following options in its F<dist.ini> section:
=over 4
=item * copyright - whether to insert a boilerplate copyright comment.
defaults to true.
=item * line - anything you want to add. may be specified multiple
times. no default.
=item * skip - regexp of file names to not prepend to.
may be specified multiple times. no default.
=back
=for Pod::Coverage mvp_multivalue_args munge_file
=head1 SEE ALSO
You can look for information on this module at:
=over 4
=item * Search CPAN
L<http://search.cpan.org/dist/Dist-Zilla-Plugin-Prepender>
=item * See open / report bugs
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Dist-Zilla-Plugin-Prepender>
=item * Mailing-list (same as L<Dist::Zilla>)
L<http://www.listbox.com/subscribe/?list_id=139292>
=item * Git repository
L<http://github.com/jquelin/dist-zilla-plugin-prepender>
=item * AnnoCPAN: Annotated CPAN documentation
L<http://annocpan.org/dist/Dist-Zilla-Plugin-Prepender>
=item * CPAN Ratings
L<http://cpanratings.perl.org/d/Dist-Zilla-Plugin-Prepender>
=back
=head1 AUTHOR
Jerome Quelin
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2009 by Jerome Quelin.
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
__END__
|
