Dist::Zilla::Plugin::ModuleBuild::Custom - Allow a dist to have a custom Build.PL
This document describes version 0.08 of Dist::Zilla::Plugin::ModuleBuild::Custom, released May 22, 2010 as part of Dist-Zilla-Plugins-CJM version 3.00.
In dist.ini:
[ModuleBuild::Custom] mb_version = 0.34 ; the default comes from the ModuleBuild plugin
In your Build.PL:
use Module::Build; my $builder = Module::Build->new( module_name => 'Foo::Bar', ##{ $plugin->get_prereqs ##} ); $builder->create_build_script;
Of course, your Build.PL should be more complex than that, or you don't need this plugin.
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 ModuleBuild plugin, but it does not write a Build.PL for you. Instead, you write your own Build.PL, which may do anything Module::Build is capable of (except generate a compatibility Makefile.PL).
This plugin will process Build.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 Build.PL that works both before and after it is processed as a template.
##{
##}
The template may use the following variables:
$dist
The name of the distribution.
$meta
The hash of metadata that will be stored in META.yml.
$plugin
The ModuleBuild::Custom object that is processing the template.
$version
The distribution's version number.
$zilla
The Dist::Zilla object that is creating the distribution.
$plugin->get_meta(qw(key1 key2 ...))
A template can call this method to extract the specified key(s) from distmeta and have them formatted into a comma-separated list suitable for a hash constructor or a method's parameter list.
distmeta
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.
$plugin->get_prereqs
This is equivalent to
$plugin->get_meta(qw(build_requires configure_requires requires recommends conflicts))
In other words, it returns all the keys that describe the distribution's prerequisites.
ModuleBuild::Custom requires Dist::Zilla (3 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.
You must not use this in conjunction with the ModuleBuild plugin.
No bugs have been reported.
Christopher J. Madsen <perl AT cjmweb.net>
<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
<bug-Dist-Zilla-Plugins-CJM AT rt.cpan.org>
You can follow or contribute to Dist-Zilla-Plugins-CJM's development at http://github.com/madsen/dist-zilla-plugins-cjm.
This software is copyright (c) 2010 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.
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.
To install Dist::Zilla::Role::ModuleInfo, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Dist::Zilla::Role::ModuleInfo
CPAN shell
perl -MCPAN -e shell install Dist::Zilla::Role::ModuleInfo
For more information on module installation, please visit the detailed CPAN module installation guide.