NAME

Test::SpellCheck::Plugin::StopWords - Test::SpellCheck plugin that adds arbitrary jargon words

VERSION

version 0.02

SYNOPSIS

            

              
              
spell_check ['StopWords', word => ['foo','bar','baz']];
spell_check ['StopWords', file => 'mywords.txt']];
            
          

Or from spellcheck.ini:

            

              
              
[StopWords]
word = foo
word = bar
word = baz
[StopWords]
file = mywords.txt
            
          

DESCRIPTION

This plugin adds global stopwords that will not be considered as misspelling. You can use a dictionary for a similar purpose, but unlike using a dictionary, stopwords will never be offered up as suggestions for misspelled words.

You can specify words in-line as a string or array reference, or you can specify a filename. The file should contain stopwords in UTF-8 format, one per line. You can specify both in-line words and a file.

OPTIONS

word

List of stopwords.

file

File path containing the stopwords.

CONSTRUCTOR

new

            

              
              
my $plugin = Test::SpellCheck::Plugin::StopWords->new(%options);
            
          

This creates a new instance of the plugin. Any of the options documented above can be passed into the constructor.

SEE ALSO

Test::SpellCheck

Test::SpellCheck::Plugin

AUTHOR

Graham Ollis <plicease@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2021-2024 by Graham Ollis.

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