logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

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

Authors

       •   Jonathan Swartz <swartz@pobox.com>

       •   Dave Rolsky <autarch@urth.org>

Configuration

       This plugin accepts the following configuration options:

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

   ispell_cmd
       The  path for the "ispell" command. By default this is just "ispell", meaning that the user's "PATH" will
       be searched for the command.

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

Description

       Uses Pod::Spell in combination with ispell <http://fmg-www.cs.ucla.edu/geoff/ispell.html> 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.

Name

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

Source

       The      source      code      repository      for      Code-TidyAll      can      be      found       at
       <https://github.com/houseabsolute/perl-code-tidyall>.

Support

       Bugs may be submitted at <https://github.com/houseabsolute/perl-code-tidyall/issues>.

Synopsis

          In configuration:

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

Version

       version 0.84

See Also