NAME

Dist::Zilla::PluginBundle::Author::VDB - VDB's plugin bundle

VERSION

Version v0.8.6, released on 2015-10-03 10:53 UTC.

WHAT?

Dist-Zilla-PluginBundle-Author-VDB (or just @Author::VDB) is a Dist-Zilla plugin bundle used by VDB.

DESCRIPTION

It is unlikely that someone else will want to use it, so I will not bother with documenting it, at least for now.

OBJECT METHODS

mvp_multivalue_args

_quote

Convert an attribute to a form suitable for using in source. Str attribute is converted into a string literal, ArrayRef attribute is converted to a list of string literals.

OPTIONS

minimum_perl

Optional, default value 5.006.

copying

Name of POD file to generate distribution COPYING text file. Empty value disables generation COPYING file.

Str, optional, default value doc/copying.pod.

readme

Names of POD files to generate distribution README text file. This is a multi-value option. Empty values are ignored. Empty list disables generating READMEfile.

ArrayRef[Str], optional, default value [ 'doc/what.pod', 'doc/why.pod', 'doc/naming.pod', 'doc/forms.pod', 'doc/source.pod', 'doc/distribution.pod', 'doc/installing.pod', 'doc/hacking.pod', 'doc/documentation.pod', 'doc/feedback.pod', 'doc/glossary.pod' ].

local_release

If true, release will be a local one, i. e. no external operations will be done: UploadToCPAN and hg push will be skipped, <hg tag> will create a local tag.

Option can be set trough dist.ini file or with DZIL_LOCAL_RELEASE environment variable.

Optional, default value is 0.

templates

This option will be passed to Templates plugin. If you no not want Templates to process files, specify :NoFiles. This is multi-value option (i. e. may be specified several times).

Optional, default value [ ':InstallModules' ].

unwanted_module

unwanted_modules

TODO [ qw{ DPP Data::Printer } ].

spellchecker

Command to run spellchecker. Spellchecker command is expected to read text from stdin, and print to stdout misspelled words. If empty, spellchecking will be skipped. This involve Test::PodSpelling plugin and internally implemented checking the Changes file.

Optional, default value aspell list -l en -p ./xt/aspell.en.pws.

WHY?

I have published few distributions on CPAN. Every distribution have dist.ini file. All the dist.ini files are very similar. Maintaining multiple very similar dist.ini files is boring. Plugin bundle solves the problem.

AUTHOR

Van de Bugger <van.de.bugger@gmail.com>

COPYRIGHT AND LICENSE

This file is part of perl-Dist-Zilla-PluginBundle-Author-VDB.

perl-Dist-Zilla-PluginBundle-Author-VDB is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

perl-Dist-Zilla-PluginBundle-Author-VDB is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with perl-Dist-Zilla-PluginBundle-Author-VDB. If not, see <http://www.gnu.org/licenses/>.

COPYRIGHT AND LICENSE

perl-{{$MY::name}} is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

perl-{{$MY::name}} is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with perl-{{$MY::name}}. If not, see http://www.gnu.org/licenses/.

perl-{{$MY::name}} distribution may contain files generated by Dist-Zilla and/or its plugins from third-party templates; copyright and license specified above are not applicable to that files.

DISTRIBUTION

{{$MY::name}} distributions are published on CPAN.

Generated Files

Distribution may contain files preprocessed or generated by Dist-Zilla and its plugins. Some generated files are made from {{$MY::name}} source, but some are generated from third-party templates. Files generated from third-party templates usually include a comment near the top of the file:

This file was generated with NAME

(where NAME is a name of the plugin generated the file). Such files are not part of {{$MY::name}} source, and {{$MY::name}} copyright and license are not applicable to such files.

DOCUMENTATION

Online

The easiest way is browsing the documentation online at meta::cpan.

Locally Installed

If you have the distribution installed, use perldoc tool to browse locally installed documentation:

$ perldoc {{$MY::package}}::Manual
$ perldoc {{$MY::package}}

Built from Source

Build {{$MY::name}} first (see "HACKING"), then:

$ cd {{$MY::name}}-VERSION
$ perldoc {{$MY::package}}::Manual
$ perldoc {{$MY::package}}

where VERSION is a version of built distribution.

FEEDBACK

CPAN Request Tracker

The quickest way to report a bug in {{$MY::name}} is by sending email to bug-{{$MY::name}} [at] rt.cpan.org.

CPAN request tracker can be used via web interface also:

Browse bugs

Browsing bugs does not require authentication.

Report bugs

You need to be a CPAN author, have a BitCard account, or OpenID in order to report bugs via the web interface.

(On 2015-04-27 I have logged in successfully with my LiveJournal OpenID, but my Google OpenID did not work for CPAN. I did not check other OpenID providers.)

Send Email to Author

As a last resort, send email to author: {{$MY::author}}. Please start message subject with "perl-{{$MY::name}}:".

FORMS

You may face {{$MY::name}} in source or distribution forms.

If you are going to {{$MY::abstract}}, you will likely be interested in using {{$MY::name}} distribution. If you are going to develop (or hack) the {{$MY::name}} itself, you will likely need the source, not distribution.

Since Perl is an interpreting language, modules in the distribution look like sources. Actually, they are Perl source files. But they are not actual sources, because they are built (preprocessed or generated) by Dist-Zilla.

How to distinguish source and distribution:

Source may contain Mercurial files and directories .hgignore, .hgtags, .hg/, while distribution should not.
Source should contain files dist.ini, weaver.ini, while distribution may not.
Source should not contain xt/ directory, while distribution should.
Name of source directory does not include version (e. g. {{$MY::name}}), while name of distribution does (e. g. {{$MY::name}}-0.007).

GLOSSARY

CPAN: Comprehensive Perl Archive Network, a large collection of Perl software and documentation. See cpan.org, What is CPAN?.
Distribution: Tarball, containing Perl modules and accompanying files (documentation, metainfo, tests). Usually distributions are uploaded to CPAN, and can be installed with dedicated tools (cpan, cpanm, and others).
Module: Perl library file, usually with .pm suffix. Usually contains one package. See perlmod.
Package: Perl language construct. See package and perlmod.

HACKING

For hacking, you will need Mercurial, Perl interpreter and Dist-Zilla (with some plugins), and likely cpanm to install missed parts.

Clone the repository first:

$ {{$MY::repo_clone}}
$ cd perl-{{$MY::name}}

To build a distribution from the source, run:

$ dzil build

If required Dist-Zilla plugins are missed, dzil tool will warn you and show the command to install all the required plugins, e. g.:

Required plugin Dist::Zilla::Plugin::Test::EOL isn't installed.

Run 'dzil authordeps' to see a list of all required plugins.
You can pipe the list to your CPAN client to install or update them:

    dzil authordeps --missing | cpanm

To run the tests:

$ dzil test

To run all the tests, including release tests:

$ dzil test --release

To install the distribution:

$ dzil install

$ cpanm ./{{$MY::name}}-VERSION.tar.gz

where VERSION is a version of built distribution.

To clean the directory:

$ dzil clean

INSTALLING

With `cpanm`

cpanm tool is (probably) the easiest way to install distribution. It automates downloading, building, testing, installing, and uninstalling.

To install the latest version from CPAN:

$ cpanm {{$MY::package}}

To install a specific version (e. g. 0.007) from CPAN:

$ cpanm {{$MY::package}}@0.007

To install locally available distribution (e. g. previously downloaded from CPAN or built from sources):

$ cpanm ./{{$MY::name}}-0.007.tar.gz

To uninstall the distribution:

$ cpanm -U {{$MY::package}}

Manually

To install distribution tarball manually (let us assume you have version 0.007 of the distribution):

$ tar xaf {{$MY::name}}-0.007.tar.gz
$ cd {{$MY::name}}-0.007
$ perl Build.PL
$ ./Build build
$ ./Build test
$ ./Build install

NAMING

perl-{{$MY::name}} is official software name.

However, in Perl world prefix "perl-" is redundant and not used. For example, on meta::cpan this software is named as {{$MY::name}}. In the rest of the documentation shortened name {{$MY::name}} is used as synonym for full name perl-{{$MY::name}}. We are in the Perl world, aren't we?

You may notice that name may be spelled with dashes ({{$MY::name}}) or with double colons ({{$MY::package}}). Strictly speaking, there is difference: the first one is software name, while the second is name of Perl package, but often these names are interchangeable especially if software consists of single package.

SOURCE

{{$MY::name}} source is in Mercurial repository hosted on {{$MY::repo_host}}. {{$MY::repo_web ? "You can either browse the source online or " : "To "}} clone the entire repository:

$ {{$MY::repo_clone}}

Source Files

{{$MY::name}} source files usually include a comment near the top of the file:

This file is part of perl-{{$MY::name}}.

Not all source files are included into distribution. Some source files are used at distribution build time only, and not required for installation.

To install Dist::Zilla::PluginBundle::Author::VDB, copy and paste the appropriate command in to your terminal.

cpanm

cpanm Dist::Zilla::PluginBundle::Author::VDB

CPAN shell

perl -MCPAN -e shell
install Dist::Zilla::PluginBundle::Author::VDB

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

VERSION

WHAT?

DESCRIPTION

OBJECT METHODS

mvp_multivalue_args

_quote

OPTIONS

minimum_perl

copying

readme

local_release

archive

templates

unwanted_module

unwanted_modules

spellchecker

WHY?

AUTHOR

COPYRIGHT AND LICENSE

COPYRIGHT AND LICENSE

DISTRIBUTION

Generated Files

DOCUMENTATION

Online

Locally Installed

Built from Source

FEEDBACK

CPAN Request Tracker

Send Email to Author

FORMS

GLOSSARY

HACKING

INSTALLING

With `cpanm`

Manually

See Also

NAMING

SOURCE

Source Files

NAME

VERSION

WHAT?

DESCRIPTION

OBJECT METHODS

mvp_multivalue_args

_quote

OPTIONS

minimum_perl

copying

readme

local_release

archive

templates

unwanted_module

unwanted_modules

spellchecker

WHY?

AUTHOR

COPYRIGHT AND LICENSE

COPYRIGHT AND LICENSE

DISTRIBUTION

Generated Files

DOCUMENTATION

Online

Locally Installed

Built from Source

FEEDBACK

CPAN Request Tracker

Send Email to Author

FORMS

GLOSSARY

HACKING

INSTALLING

With cpanm

Manually

See Also

NAMING

SOURCE

Source Files

Module Install Instructions

With `cpanm`