Ricardo SIGNES > Dist-Zilla > Dist::Zilla::Plugin::TemplateModule

Download:
Dist-Zilla-4.300016.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

New  25
Open  20
View/Report Bugs
Module Version: 4.300016   Source  

NAME ^

Dist::Zilla::Plugin::TemplateModule - a simple module-from-template plugin

VERSION ^

version 4.300016

DESCRIPTION ^

This is a ModuleMaker used for creating new Perl modules files when minting a new dist with dzil new. It uses Text::Template (via Dist::Zilla::Role::TextTemplate) to render a template into a Perl module. The template is given two variables for use in rendering: $name, the module name; and $dist, the Dist::Zilla object. The module is always created as a file under ./lib.

By default, the template looks something like this:

  use strict;
  use warnings;
  package {{ $name }};

  1;

ATTRIBUTES ^

template

The template parameter may be given to the plugin to provide a different filename, absolute or relative to the build/profile directory.

If this parameter is not specified, this module will use the boilerplate module template included in this module.

MINTING CONFIGURATION ^

This module is part of the standard configuration of the default Dist::Zilla Minting Profile, and all profiles that don't set a custom ':DefaultModuleMaker' so you don't need to normally do anything to configure it.

  dzil new Some::Module
  # creates ./Some-Module/*
  # creates ./Some-Module/lib/Some/Module.pm

However, for those who wish to configure this ( or any subclasses ) this is presently required:

  [TemplateModule / :DefaultModuleMaker]
  ; template  = SomeFile.pm

AUTHOR ^

Ricardo SIGNES <rjbs@cpan.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2012 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.

syntax highlighting: