The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Module::Starter::TOSHIOITO - create a module like TOSHIOITO does

SYNOPSIS

In your ~/.module-starter/config

    author: YOUR NAME
    email: YOUR@EMAIL.ADDR
    plugins: Module::Starter::TOSHIOITO
    github_user_name: YOUR_GITHUB_USER_NAME

Then

    $ module-starter --mb --module Foo::Bar

DESCRIPTION

This is a simple Module::Starter plugin that makes it create module templates that I like.

This is based on Module::Starter::Simple, the default plugin for Module::Starter. The difference from the base is:

  • It assumes the module is hosted on Github. Users are advised to report issues to Github's issue tracker.

  • github_user_name config parameter is mandatory. It is your Github user name.

  • If the builder is Module::Build, it uses Module::Build::Pluggable::CPANfile and generates a template cpanfile.

  • ignores_type config parameter is "git manifest" by default.

  • verbose config parameter is true by default.

  • license is perl by default.

  • Module documentation is put at the end of module files.

  • It creates t and xt test directories.

Caution

As the name suggests, this module is rather for myself than for other CPAN authors. I will change behavior of this module drastically when I think I need it.

Config parameters

This module takes some config parameters from your ~/.module-starter/config

github_user_name (mandatory)

Username of your Github account. In my case, it's debug-ito.

github_repo_prefix, github_repo_postfix (optional)

Prefix and postfix for your module's Github repository based on the distribution name, so the repository name is constructed as

    "${github_repo_prefix}${distribution_name}${github_repo_postfix}"

By default, both of these params are empty strings.

SEE ALSO

Module::Starter

REPOSITORY

https://github.com/debug-ito/Module-Starter-TOSHIOITO

BUGS AND FEATURE REQUESTS

Please report bugs and feature requests to my Github issues https://github.com/debug-ito/Module-Starter-TOSHIOITO/issues.

Although I prefer Github, non-Github users can use CPAN RT https://rt.cpan.org/Public/Dist/Display.html?Name=Module-Starter-TOSHIOITO. Please send email to bug-Module-Starter-TOSHIOITO at rt.cpan.org to report bugs if you do not have CPAN RT account.

AUTHOR

Toshio Ito, <toshioito at cpan.org>

LICENSE AND COPYRIGHT

Copyright 2013 Toshio Ito.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.