|Dist::Zilla::Plugin::Test::PodSpelling(3pm)||User Contributed Perl Documentation||Dist::Zilla::Plugin::Test::PodSpelling(3pm)|
Dist::Zilla::Plugin::Test::PodSpelling - Author tests for POD spelling
[Test::PodSpelling] directory = docs wordlist = Pod::Wordlist spell_cmd = aspell list stopword = CPAN stopword = github stopword = stopwords stopword = 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.
This is a plugin that runs at the gather files stage, providing the file:
xt/author/pod-spell.t - a standard Test::Spelling test
Test::Spelling will be added as a develop prerequisite.
directories (or directory)¶
Additional directories you wish to search for POD spell checking purposes. "bin" and "lib" are set by default.
The module name of a word list you wish to use that works with Test::Spelling.
Defaults to Pod::Wordlist.
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.
If stopwords is set then "add_stopwords( <DATA> )" is added to the test file and the words are added after the "__DATA__" section.
"stopword" or "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.
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 may be submitted through the RT bug tracker <https://rt.cpan.org/Public/Dist/Display.html?Name=Dist-Zilla-Plugin-Test-PodSpelling> (or bug-Dist-Zilla-Plugin-Test-PodSpelling@rt.cpan.org <mailto:bug-Dist-Zilla-Plugin-Test-PodSpelling@rt.cpan.org>).
There is also a mailing list available for users of this distribution, at <http://dzil.org/#mailing-list>.
There is also an irc channel available for users of this distribution, at "#distzilla" on "irc.perl.org" <irc://irc.perl.org/#distzilla>.
I am also usually active on irc, as 'ether' at "irc.perl.org".
- Caleb Cushing <email@example.com>
- Marcel Gruenauer <firstname.lastname@example.org>
- Karen Etheridge <email@example.com>
- Randy Stauner <firstname.lastname@example.org>
- Graham Knop <email@example.com>
- David Golden <firstname.lastname@example.org>
- Harley Pig <email@example.com>
- Alexandr Ciornii <firstname.lastname@example.org>
- Breno G. de Oliveira <email@example.com>
COPYRIGHT AND LICENCE¶
This software is Copyright (c) 2010 by Karen Etheridge.
This is free software, licensed under:
The Artistic License 2.0 (GPL Compatible)