Release tests for pod spelling
version 1.111520
In \*(C`dist.ini\*(C':
[PodSpellingTests]
or:
[PodSpellingTests] wordlist = Pod::Wordlist spell_cmd = aspell list stopwords = CPAN stopwords = github stopwords = stopwords stopwords = wordlist
or, if you wanted to use my plugin bundle but just override this plugin's configuration:
[@Filter] -bundle = @MARCEL -remove = PodSpellingTests
[PodSpellingTests] wordlist = Pod::Wordlist spell_cmd = aspell list stopwords = CPAN stopwords = github stopwords = stopwords stopwords = wordlist
This is an extension of Dist::Zilla::Plugin::InlineFiles, providing the following file:
xt/release/pod-spell.t - a standard Test::Spelling test
The module name of a word list you wish to use that works with Test::Spelling.
Defaults to Pod::Wordlist::hanekomu.
If \*(C`spell_cmd\*(C' is set then \*(C`set_spell_cmd( your_spell_command );\*(C' is added to the test file to allow for custom spell check programs.
Defaults to nothing.
If stopwords is set then \*(C`add_stopwords( <DATA> )\*(C' is added to the test file and the words are added after the \*(C`_\|_DATA_\|_\*(C' section.
\*(C`stopwords\*(C' can appear multiple times, one word per line.
Normally no stopwords are added by default, but author names appearing in \*(C`dist.ini\*(C' are automatically added as stopwords so you don't have to add them manually just because they might appear in the \*(C`AUTHORS\*(C' section of the generated \s-1POD\s0 document.
See perlmodinstall for information and options on installing Perl modules.
No bugs have been reported.
Please report any bugs or feature requests through the web interface at http://rt.cpan.org/Public/Dist/Display.html?Name=Dist-Zilla-Plugin-PodSpellingTests <http://rt.cpan.org/Public/Dist/Display.html?Name=Dist-Zilla-Plugin-PodSpellingTests>.
The latest version of this module is available from the Comprehensive Perl Archive Network (\s-1CPAN\s0). Visit <http://www.perl.com/CPAN/> to find a \s-1CPAN\s0 site near you, or see http://search.cpan.org/dist/Dist-Zilla-Plugin-PodSpellingTests/ <http://search.cpan.org/dist/Dist-Zilla-Plugin-PodSpellingTests/>.
The development version lives at http://github.com/hanekomu/Dist-Zilla-Plugin-PodSpellingTests <http://github.com/hanekomu/Dist-Zilla-Plugin-PodSpellingTests> and may be cloned from git://github.com/hanekomu/Dist-Zilla-Plugin-PodSpellingTests.git <git://github.com/hanekomu/Dist-Zilla-Plugin-PodSpellingTests.git>. Instead of sending patches, please fork this project using the standard git and github infrastructure.
Marcel Gruenauer <[email protected]>
Harley Pig <[email protected]>
This software is copyright (c) 2010 by Marcel Gruenauer.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.