The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Dist-Zilla-Plugin-Test-PodSpelling-2.006008
River stage two • 17 direct dependents • 24 total dependents
6 ++
/ Dist::Zilla::Plugin::Test::PodSpelling

NAME

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

VERSION

version 2.006008

SYNOPSIS

In dist.ini:

        [Test::PodSpelling]

or:

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

If you're using [ExtraTests] it must come after [Test::PodSpelling], it's worth noting that this ships in the [@Basic] bundle so you may have to remove it from that first.

DESCRIPTION

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

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

Test::Spelling will be added as a develop prerequisite.

ATTRIBUTES

directories

Additional directories you wish to search for POD spell checking purposes. bin and lib are set by default.

wordlist

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

Defaults to Pod::Wordlist.

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. The same goes for contributors listed under the 'x_contributors' field on your distributions META file.

METHODS

add_stopword

Called to add stopwords to the stopwords array. It is used to determine if automagically detected words are valid and print out debug logging for the process.

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.

CONTRIBUTORS

  • Alexandr Ciornii <alexchorny@gmail.com>

  • Breno G. de Oliveira <garu@cpan.org>

  • David Golden <dagolden@cpan.org>

  • Graham Knop <haarg@haarg.org>

  • Harley Pig <harleypig@gmail.com>

  • Karen Etheridge <ether@cpan.org>

  • Randy Stauner <rwstauner@cpan.org>

AUTHORS

  • Caleb Cushing <xenoterracide@gmail.com>

  • Marcel Gruenauer <hanekomu@gmail.com>

COPYRIGHT AND LICENSE

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

This is free software, licensed under:

  The Artistic License 2.0 (GPL Compatible)