Create a module as recommended in "perl best practices"
This document describes Module::Starter::PBP version 0.0.3
# In your ~/.module-starter/config file...
author: <Your Name>
email: <[email protected]>
plugins: Module::Starter::PBP
template_dir: </some/absolute/path/name>
# Then on the command-line...
> module-starter --module=Your::New::Module
# Or, if you're lazy and happy to go with
# the recommendations in "Perl Best Practices"...
> perl -MModule::Starter::PBP=setup
This module implements a simple approach to creating modules and their support files, based on the Module::Starter approach. Module::Starter needs to be installed before this module can be used.
When used as a Module::Starter plugin, this module allows you to specify a simple directory of templates which are filled in with module-specific information, and thereafter form the basis of your new module.
The default templates that this module initially provides are based on the recommendations in the book \*(L"Perl Best Practices\*(R".
Thsi module simply acts as a plugin for Module::Starter. So it uses the same command-line interface as that module.
The template files it is to use are specified in your Module::Starter \*(C`config\*(C' file, by adding a \*(C`template_dir\*(C' configuration variable that gives the full path name of the directory in which you want to put the templates.
The easiest way to set up this \*(C`config\*(C' file, the associated directory, and the necessary template files is to type:
> perl -MModule::Starter::PBP=setup
on the command line. You will then be asked for your name, email address, and the full path name of the directory where you want to keep the templates, after which they will be created and installed.
Then you can create a new module by typing:
> module-starter --module=Your::New::Module
The templates are plain files named:
Build.PL Makefile.PL README Changes Module.pm t/whatever_you_like.t
The \*(C`Module.pm\*(C' file is the template for the \*(C`.pm\*(C' file for your module. Any files in the \*(C`t/\*(C' subdirectory become the templates for the testing files of your module. All the remaining files are templates for the ditribution files of the same names.
In those files, the following placeholders are replaced by the appropriate information specific to the file:
The nominated author. Taken from the \*(C`author\*(C' setting in your Module::Starter \*(C`config\*(C' file.
Makefile or Module::Build instructions. Computed automatically according to the \*(C`builder\*(C' setting in your Module::Starter \*(C`config\*(C' file.
The current date (as returned by \*(C`localtime\*(C'). Computed automagically
The name of the complete module distribution. Computed automatically from the name of the module.
Where to send feedback. Taken from the \*(C`email\*(C' setting in your Module::Starter \*(C`config\*(C' file.
The licence under which the module is released. Taken from the \*(C`license\*(C' setting in your Module::Starter \*(C`config\*(C' file.
The name of the main module of the distribution.
The name of the \*(C`.pm\*(C' file for the main module.
The name of the current module being created within the distribution.
The name to use for bug reports to the \s-1RT\s0 system. That is: Please report any bugs or feature requests to bug-<RT NAME>@rt.cpan.org>
The current year. Computed automatically
You did not tell Module::Starter::PBP where your templates are stored. You need a 'template_dir' specification. Typically this would go in your ~/.module-starter/config file. Something like: template_dir: /users/you/.module-starter/Templates You specified a 'template_dir', but the path didn't lead to a readable directory. One of the required templates: was missing from the template directory you specified. One of the templates in the template directory you specified was not readable. One of the templates in the template directory contained a replacement item that wasn't a known piece of information.
See the documentation for \*(C`Module::Starter\*(C' and \*(C`module-starter\*(C'.
Requires the \*(C`Module::Starter\*(C' module.
None reported.
No bugs have been reported.
Please report any bugs or feature requests to \*(C`[email protected]\*(C', or through the web interface at <http://rt.cpan.org>.
Damian Conway \*(C`<[email protected]>\*(C'
Copyright (c) 2005, Damian Conway \*(C`<[email protected]>\*(C'. All rights reserved.
This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
\s-1BECAUSE\s0 \s-1THIS\s0 \s-1SOFTWARE\s0 \s-1IS\s0 \s-1LICENSED\s0 \s-1FREE\s0 \s-1OF\s0 \s-1CHARGE\s0, \s-1THERE\s0 \s-1IS\s0 \s-1NO\s0 \s-1WARRANTY\s0 \s-1FOR\s0 \s-1THE\s0 \s-1SOFTWARE\s0, \s-1TO\s0 \s-1THE\s0 \s-1EXTENT\s0 \s-1PERMITTED\s0 \s-1BY\s0 \s-1APPLICABLE\s0 \s-1LAW\s0. \s-1EXCEPT\s0 \s-1WHEN\s0 \s-1OTHERWISE\s0 \s-1STATED\s0 \s-1IN\s0 \s-1WRITING\s0 \s-1THE\s0 \s-1COPYRIGHT\s0 \s-1HOLDERS\s0 \s-1AND/OR\s0 \s-1OTHER\s0 \s-1PARTIES\s0 \s-1PROVIDE\s0 \s-1THE\s0 \s-1SOFTWARE\s0 \*(L"\s-1AS\s0 \s-1IS\s0\*(R" \s-1WITHOUT\s0 \s-1WARRANTY\s0 \s-1OF\s0 \s-1ANY\s0 \s-1KIND\s0, \s-1EITHER\s0 \s-1EXPRESSED\s0 \s-1OR\s0 \s-1IMPLIED\s0, \s-1INCLUDING\s0, \s-1BUT\s0 \s-1NOT\s0 \s-1LIMITED\s0 \s-1TO\s0, \s-1THE\s0 \s-1IMPLIED\s0 \s-1WARRANTIES\s0 \s-1OF\s0 \s-1MERCHANTABILITY\s0 \s-1AND\s0 \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0. \s-1THE\s0 \s-1ENTIRE\s0 \s-1RISK\s0 \s-1AS\s0 \s-1TO\s0 \s-1THE\s0 \s-1QUALITY\s0 \s-1AND\s0 \s-1PERFORMANCE\s0 \s-1OF\s0 \s-1THE\s0 \s-1SOFTWARE\s0 \s-1IS\s0 \s-1WITH\s0 \s-1YOU\s0. \s-1SHOULD\s0 \s-1THE\s0 \s-1SOFTWARE\s0 \s-1PROVE\s0 \s-1DEFECTIVE\s0, \s-1YOU\s0 \s-1ASSUME\s0 \s-1THE\s0 \s-1COST\s0 \s-1OF\s0 \s-1ALL\s0 \s-1NECESSARY\s0 \s-1SERVICING\s0, \s-1REPAIR\s0, \s-1OR\s0 \s-1CORRECTION\s0.
\s-1IN\s0 \s-1NO\s0 \s-1EVENT\s0 \s-1UNLESS\s0 \s-1REQUIRED\s0 \s-1BY\s0 \s-1APPLICABLE\s0 \s-1LAW\s0 \s-1OR\s0 \s-1AGREED\s0 \s-1TO\s0 \s-1IN\s0 \s-1WRITING\s0 \s-1WILL\s0 \s-1ANY\s0 \s-1COPYRIGHT\s0 \s-1HOLDER\s0, \s-1OR\s0 \s-1ANY\s0 \s-1OTHER\s0 \s-1PARTY\s0 \s-1WHO\s0 \s-1MAY\s0 \s-1MODIFY\s0 \s-1AND/OR\s0 \s-1REDISTRIBUTE\s0 \s-1THE\s0 \s-1SOFTWARE\s0 \s-1AS\s0 \s-1PERMITTED\s0 \s-1BY\s0 \s-1THE\s0 \s-1ABOVE\s0 \s-1LICENCE\s0, \s-1BE\s0 \s-1LIABLE\s0 \s-1TO\s0 \s-1YOU\s0 \s-1FOR\s0 \s-1DAMAGES\s0, \s-1INCLUDING\s0 \s-1ANY\s0 \s-1GENERAL\s0, \s-1SPECIAL\s0, \s-1INCIDENTAL\s0, \s-1OR\s0 \s-1CONSEQUENTIAL\s0 \s-1DAMAGES\s0 \s-1ARISING\s0 \s-1OUT\s0 \s-1OF\s0 \s-1THE\s0 \s-1USE\s0 \s-1OR\s0 \s-1INABILITY\s0 \s-1TO\s0 \s-1USE\s0 \s-1THE\s0 \s-1SOFTWARE\s0 (\s-1INCLUDING\s0 \s-1BUT\s0 \s-1NOT\s0 \s-1LIMITED\s0 \s-1TO\s0 \s-1LOSS\s0 \s-1OF\s0 \s-1DATA\s0 \s-1OR\s0 \s-1DATA\s0 \s-1BEING\s0 \s-1RENDERED\s0 \s-1INACCURATE\s0 \s-1OR\s0 \s-1LOSSES\s0 \s-1SUSTAINED\s0 \s-1BY\s0 \s-1YOU\s0 \s-1OR\s0 \s-1THIRD\s0 \s-1PARTIES\s0 \s-1OR\s0 A \s-1FAILURE\s0 \s-1OF\s0 \s-1THE\s0 \s-1SOFTWARE\s0 \s-1TO\s0 \s-1OPERATE\s0 \s-1WITH\s0 \s-1ANY\s0 \s-1OTHER\s0 \s-1SOFTWARE\s0), \s-1EVEN\s0 \s-1IF\s0 \s-1SUCH\s0 \s-1HOLDER\s0 \s-1OR\s0 \s-1OTHER\s0 \s-1PARTY\s0 \s-1HAS\s0 \s-1BEEN\s0 \s-1ADVISED\s0 \s-1OF\s0 \s-1THE\s0 \s-1POSSIBILITY\s0 \s-1OF\s0 \s-1SUCH\s0 \s-1DAMAGES\s0.