Scroll to navigation

Dist::Zilla::Plugin::MakeMaker::Custom(3pm) User Contributed Perl Documentation Dist::Zilla::Plugin::MakeMaker::Custom(3pm)

NAME

Dist::Zilla::Plugin::MakeMaker::Custom - Allow a dist to have a custom Makefile.PL

VERSION

This document describes version 4.08 of Dist::Zilla::Plugin::MakeMaker::Custom, released June 4, 2012 as part of Dist-Zilla-Plugins-CJM version 4.09.

SYNOPSIS

In dist.ini: 
  [MakeMaker::Custom]
  eumm_version = 0.34  ; the default comes from the MakeMaker plugin
In your Makefile.PL: 
  use ExtUtils::MakeMaker;
  ##{ $share_dir_code{preamble} || '' ##}
  WriteMakefile(
    NAME => "My::Module",
  ##{ $plugin->get_prereqs ##}
  );
  ##{ $share_dir_code{postamble} || '' ##}
Of course, your Makefile.PL should be more complex than that, or you don't need this plugin.

DESCRIPTION

This plugin is for people who need something more complex than the auto-generated Makefile.PL or Build.PL generated by the MakeMaker or ModuleBuild plugins.
It is a subclass of the MakeMaker plugin, but it does not write a Makefile.PL for you. Instead, you write your own Makefile.PL, which may do anything ExtUtils::MakeMaker is capable of.
This plugin will process Makefile.PL as a template (using Text::Template), which allows you to add data from Dist::Zilla to the version you distribute (if you want). The template delimiters are "##{" and "##}", because that makes them look like comments. That makes it easier to have a Makefile.PL that works both before and after it is processed as a template.
This is particularly useful for XS-based modules, because it can allow you to build and test the module without the overhead of "dzil build" after every small change.
The template may use the following variables:
%default_args
The hash of arguments for WriteMakefile generated by the normal MakeMaker plugin.
$dist
The name of the distribution.
$eumm_version
The minimum version of ExtUtils::MakeMaker required (from the "eumm_version" attribute of this plugin).
%meta
The hash of metadata (in META 2 format) that will be stored in META.json.
$perl_prereq
The minimum version of Perl required (from the prerequisites in the metadata). May be "undef". Equivalent to $default_args{MIN_PERL_VERSION}.
$plugin
The MakeMaker::Custom object that is processing the template.
%share_dir_code
A hash of strings containing the code for loading "File::ShareDir::Install" (if it's used by this dist). Put "##{ $share_dir_code{preamble} || '' ##}" after the "use ExtUtils::MakeMaker" line, and put "##{ $share_dir_code{postamble} || '' ##}" after the "WriteMakefile" call. (You can omit the "|| ''" if you're sure the dist is using File::ShareDir.
 
For backwards compatibility, this code is also available in the array @share_dir_block, but you should update your templates to use %share_dir_code instead.
$version
The distribution's version number.
$zilla
The Dist::Zilla object that is creating the distribution.

METHODS

get_default

  $plugin->get_default(qw(key1 key2 ...))
A template can call this method to extract the specified key(s) from the default WriteMakefile arguments created by the normal MakeMaker plugin and have them formatted into a comma-separated list suitable for a hash constructor or a function's parameter list.
If any key has no value (or its value is an empty hash or array ref) it will be omitted from the list. If all keys are omitted, the empty string is returned. Otherwise, the result always ends with a comma.

get_prereqs

  $plugin->get_prereqs
This is equivalent to 
  $plugin->get_default(qw(BUILD_REQUIRES CONFIGURE_REQUIRES PREREQ_PM))
In other words, it returns all the keys that describe the distribution's prerequisites.

SEE ALSO

The ModuleBuild::Custom plugin does basically the same thing as this plugin, but for Build.PL (if you prefer Module::Build).
The MakeMaker::Awesome plugin allows you to do similar things to your Makefile.PL, but it works in a very different way. With MakeMaker::Awesome, you subclass the plugin and override the methods that generate Makefile.PL. In my opinion, MakeMaker::Awesome has two disadvantages: it's unnecessarily complex, and it doesn't allow you to build your module without doing "dzil build". The only advantage of MakeMaker::Awesome that I can see is that if you had several dists with very similar Makefile.PLs, you could write one subclass of MakeMaker::Awesome and use it in each dist.

DEPENDENCIES

MakeMaker::Custom requires Dist::Zilla (4.300009 or later) and Text::Template. I also recommend applying Template_strict.patch to Text::Template. This will add support for the STRICT option, which will help catch errors in your templates.

INCOMPATIBILITIES

You must not use this in conjunction with the MakeMaker or MakeMaker::Awesome plugins.

BUGS AND LIMITATIONS

No bugs have been reported.

AUTHOR

Christopher J. Madsen "<perl AT cjmweb.net>"
Please report any bugs or feature requests to "<bug-Dist-Zilla-Plugins-CJM AT rt.cpan.org>" or through the web interface at http://rt.cpan.org/Public/Bug/Report.html?Queue=Dist-Zilla-Plugins-CJM <http://rt.cpan.org/Public/Bug/Report.html?Queue=Dist-Zilla-Plugins-CJM>.
You can follow or contribute to Dist-Zilla-Plugins-CJM's development at http://github.com/madsen/dist-zilla-plugins-cjm <http://github.com/madsen/dist-zilla-plugins-cjm>.

COPYRIGHT AND LICENSE

This software is copyright (c) 2012 by Christopher J. Madsen.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENSE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
2012-06-04 perl v5.14.2