NAME

Dist::Zilla::Plugin::Test::PodSpelling - Author tests for POD spelling

VERSION

version 2.002006

SYNOPSIS

In dist.ini:

        [Test::PodSpelling]

or:

        [Test::PodSpelling]
        wordlist = Pod::Wordlist
        spell_cmd = aspell list
        stopwords = CPAN
        stopwords = github
        stopwords = stopwords
        stopwords = wordlist

DESCRIPTION

This is an extension of Dist::Zilla::Plugin::InlineFiles, providing the following file:

  xt/author/pod-spell.t - a standard Test::Spelling test

METHODS

wordlist

The module name of a word list you wish to use that works with Test::Spelling.

Defaults to Pod::Wordlist::hanekomu.

spell_cmd

If spell_cmd is set then set_spell_cmd( your_spell_command ); is added to the test file to allow for custom spell check programs.

Defaults to nothing.

stopwords

If stopwords is set then add_stopwords( <DATA> ) is added to the test file and the words are added after the __DATA__ section.

stopwords can appear multiple times, one word per line.

Normally no stopwords are added by default, but author names appearing in dist.ini are automatically added as stopwords so you don't have to add them manually just because they might appear in the AUTHORS section of the generated POD document.

BUGS

Please report any bugs or feature requests on the bugtracker website https://github.com/xenoterracide/Dist-Zilla-Plugin-Test-PodSpelling/issues

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHORS

• Caleb Cushing <xenoterracide@gmail.com>

• Randy Stauner <randy@magnificent-tears.com>

• Marcel Gruenauer <marcel@cpan.org>

• Harley Pig <harleypig@gmail.com>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2012 by Caleb Cushing.

This is free software, licensed under:

  The Artistic License 2.0 (GPL Compatible)

cpanm Dist::Zilla::Plugin::Test::PodSpelling

perl -MCPAN -e shell
install Dist::Zilla::Plugin::Test::PodSpelling