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
|
package ExtUtils::MakeMaker::Dist::Zilla::Develop;
use strict;
use warnings;
# ABSTRACT: create bare-bones Makefile.PL files for use with dzil
use ExtUtils::MakeMaker ();
=head1 SYNOPSIS
# Makefile.PL
use ExtUtils::MakeMaker::Dist::Zilla::Develop;
WriteMakefile(NAME => 'Foo::Bar');
=head1 DESCRIPTION
L<Dist::Zilla> makes developing modules much easier by generating all kinds of
boilerplate files, saving authors from having to write them by hand, but in
some cases this can make developing more inconvenient. The most prominent
example of this is with C<Makefile.PL> files - although the majority of
distributions can be hacked on just by editing the files in a source control
checkout and using C<prove> for testing, for some this isn't sufficient. In
particular, distributions which use an auto-generated test suite and
distributions which use XS both need special handling at build time before they
will function, and with Dist::Zilla, this means running C<dzil build> and
rebuilding after every change. This is tedious!
This module provides an alternative. Create a minimal C<Makefile.PL> in source
control which handles just enough functionality for basic development (it can
be as minimal as just what is in the L</SYNOPSIS>, but can also contain
commands to generate your test suite, for example), and tell Dist::Zilla to
replace it with a real C<Makefile.PL> when you're actually ready to build a
real distribution. To do this, make sure you're still using the
L<MakeMaker|Dist::Zilla::Plugin::MakeMaker> plugin, either directly or through
a pluginbundle like L<@Basic|Dist::Zilla::PluginBundle::Basic>, and add this to
your C<dist.ini>:
[PruneFiles]
filenames = Makefile.PL
In addition, this module also intercepts the C<install> and C<dist> rules in
the generated Makefile to run the appropriate Dist::Zilla commands
(C<dzil install> and C<dzil build>). This allows users to continue to use the
C<perl Makefile.PL && make && make install> set of commands, and have the
correct thing continue to happen.
Note that if you're using this module to ease testing of an XS distribution,
you'll need to account for your module not containing a C<$VERSION> statement
(assuming you're using the L<PkgVersion|Dist::Zilla::Plugin::PkgVersion>
plugin). To do this, you should use an XSLoader invocation similar to this:
BEGIN {
XSLoader::load(
'Foo::Bar',
$Foo::Bar::{VERSION} ? ${ $Foo::Bar::{VERSION} } : ()
);
}
This ensures that the C<$Foo::Bar::VERSION> glob isn't created if it didn't
exist initially, since this can confuse XSLoader.
=cut
sub import {
warn <<'EOF';
********************************* WARNING **********************************
This module uses Dist::Zilla for development. This Makefile.PL will let you
run the tests, but you are encouraged to install Dist::Zilla and the needed
plugins if you intend on doing any serious hacking.
****************************************************************************
EOF
ExtUtils::MakeMaker->export_to_level(1, @_);
}
{
package MY;
use Config;
my $message;
BEGIN {
$message = <<'MESSAGE';
********************************* ERROR ************************************
This module uses Dist::Zilla for development. This Makefile.PL will let you
run the tests, but should not be used for installation or building dists.
Building a dist should be done with 'dzil build', installation should be
done with 'dzil install', and releasing should be done with 'dzil release'.
****************************************************************************
MESSAGE
$message =~ s/^(.*)$/\t\$(NOECHO) echo "$1";/mg;
}
sub install {
return <<EOF;
install:
$message
\$(NOECHO) echo "Running dzil install for you...";
\$(NOECHO) dzil install
EOF
}
sub dist_core {
return <<EOF;
dist:
$message
\$(NOECHO) echo "Running dzil build for you...";
\$(NOECHO) dzil build
EOF
}
}
=head1 BUGS
No known bugs.
Please report any bugs through RT: email
C<bug-extutils-makemaker-dist-zilla-develop at rt.cpan.org>, or browse to
L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=ExtUtils-MakeMaker-Dist-Zilla-Develop>.
=head1 SEE ALSO
L<ExtUtils::MakeMaker>
L<Dist::Zilla>
=head1 SUPPORT
You can find this documentation for this module with the perldoc command.
perldoc ExtUtils::MakeMaker::Dist::Zilla::Develop
You can also look for information at:
=over 4
=item * AnnoCPAN: Annotated CPAN documentation
L<http://annocpan.org/dist/ExtUtils-MakeMaker-Dist-Zilla-Develop>
=item * CPAN Ratings
L<http://cpanratings.perl.org/d/ExtUtils-MakeMaker-Dist-Zilla-Develop>
=item * RT: CPAN's request tracker
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=ExtUtils-MakeMaker-Dist-Zilla-Develop>
=item * Search CPAN
L<http://search.cpan.org/dist/ExtUtils-MakeMaker-Dist-Zilla-Develop>
=back
=cut
1;
|
