NAME

Code::TidyAll::Plugin::PodSpell - use Pod::Spell + ispell with tidyall

VERSION

version 0.14

SYNOPSIS

In configuration:

[PodSpell]
select = lib/**/*.{pm,pod}
ispell_argv = -p $ROOT/.ispell_english
suggest = 1

DESCRIPTION

Uses Pod::Spell in combination with ispell to spell-check POD. Any seemingly misspelled words will be output one per line.

You can specify additional valid words by:

• Adding them to your personal ispell dictionary, e.g. ~/.ispell_english

• Adding them to an ispell dictionary in the project root, then including this in the configuration:

  ispell_argv = -p $ROOT/.ispell_english

The dictionary file should contain one word per line.

INSTALLATION

Install ispell from your package manager or from the link above.

CONFIGURATION

ispell_argv

Arguments to pass to ispell. "-a" will always be passed, in order to parse the results.

ispell_cmd

Full path to ispell

suggest

If true, show suggestions next to misspelled words. Default is false.

SEE ALSO

Code::TidyAll

AUTHOR

Jonathan Swartz <swartz@pobox.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2011 by Jonathan Swartz.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.