all_pod_files_spelling_ok( [@files/@directories] )¶

Checks all the files for POD spelling. It gathers all_pod_files() on each file/directory, and declares a "plan" in Test::More for you (one test for each file), so you must not call "plan" yourself.

If @files is empty, the function finds all POD files in the blib directory if it exists, or the lib directory if it does not. A POD file is one that ends with .pod, .pl, .plx, or .pm; or any file where the first line looks like a perl shebang line.

If there is no working spellchecker (determined by "has_working_spellchecker"), this test will issue a "skip all" directive.

If you're testing a distribution, just create a t/pod-spell.t with the code in the "SYNOPSIS".

Returns true if every POD file has correct spelling, or false if any of them fail. This function will show any spelling errors as diagnostics.

pod_file_spelling_ok( $filename[, $testname ] )¶

"pod_file_spelling_ok" will test that the given POD file has no spelling errors.

When it fails, "pod_file_spelling_ok" will show any spelling errors as diagnostics.

The optional second argument is the name of the test. If it is omitted, "pod_file_spelling_ok" chooses a default test name "POD spelling for $filename".

all_pod_files( [@dirs] )¶

Returns a list of all the Perl files in each directory and its subdirectories, recursively. If no directories are passed, it defaults to blib if blib exists, or else lib if not. Skips any files in CVS or .svn directories.

A Perl file is:

• Any file that ends in .PL, .pl, .plx, .pm, .pod or .t.
• Any file that has a first line with a shebang and "perl" on it.

Furthermore, files for which the filter set by "set_pod_file_filter" return false are skipped. By default, this filter passes everything through.

The order of the files returned is machine-dependent. If you want them sorted, you'll have to sort them yourself.

add_stopwords(@words)¶

Add words that should be skipped by the spellcheck. Note that Pod::Spell already skips words believed to be code, such as everything in verbatim (indented) blocks and code marked up with ""..."", as well as some common Perl jargon.

has_working_spellchecker¶

"has_working_spellchecker" will return "undef" if there is no working spellchecker, or a true value (the spellchecker command itself) if there is. The module performs a dry-run to determine whether any of the spellcheckers it can will use work on the current system. You can use this to skip tests if there is no spellchecker. Note that "all_pod_files_spelling_ok" will do this for you.

set_spell_cmd($command)¶

If you want to force this module to use a particular spellchecker, then you can specify which one with "set_spell_cmd". This is useful to ensure a more consistent lexicon between developers, or if you have an unusual environment. Any command that takes text from standard input and prints a list of misspelled words, one per line, to standard output will do.

set_pod_file_filter($code)¶

If your project has POD documents written in languages other than English, then obviously you don't want to be running a spellchecker on every Perl file. "set_pod_file_filter" lets you filter out files returned from "all_pod_files" (and hence, the documents tested by "all_pod_files_spelling_ok").

    set_pod_file_filter(sub {
        my $filename = shift;
        return 0 if $filename =~ /_ja.pod$/; # skip Japanese translations
        return 1;
    });

set_pod_parser($object)¶

By default Pod::Spell is used to generate text suitable for spellchecking from the input POD. If you want to use a different parser, perhaps a customized subclass of Pod::Spell, call "set_pod_parser" with an object that is-a Pod::Parser. Be sure to create a fresh parser object for each file (don't use this with "all_pod_files_spelling_ok").