Test::Spelling 0.15

Test::Spelling is a Perl module that can check for spelling errors in POD files.

SYNOPSIS

Test::Spelling lets you check the spelling of a POD file, and report its results in standard Test::Simple fashion. This module requires the spell program.

use Test::More;
use Test::Spelling;
plan tests => $num_tests;
pod_file_spelling_ok( $file, "POD file spelling OK" );

Module authors can include the following in a t/pod_spell.t file and have Test::Spelling automatically find and check all POD files in a module distribution:

use Test::More;
use Test::Spelling;
all_pod_files_spelling_ok();

Note, however that it is not really recommended to include this test with a CPAN distribution, or a package that will run in an uncontrolled environment, because there's no way of predicting if spell will be available or the word list used will give the same results (what if it's in a different language, for example?). You can have the test, but don't add it to MANIFEST (or add it to MANIFEST.SKIP to make sure you don't add it by accident). Anyway, your users don't really need to run this test, as it is unlikely that the documentation will acquire typos while in transit. :-)

You can add your own stopwords (words that should be ignored by the spell check):

add_stopwords(qw(asdf thiswordiscorrect));

These stopwords are global for the test. See Pod::Spell for a variety of ways to add per-file stopwords to each .pm file.

Product's homepage

Requirements:

· Perl