NAME

Test::SpellCheck::Plugin::Combo - Test::SpellCheck plugin for combining other plugins.

VERSION

version 0.02

SYNOPSIS

From your test file:

 use Test2::V0;
 use Test::SpellCheck;
 
 spell_check
   ['Combo',
     ['Lang::EN::US'],
     ['PerlPOD', skip_sections => 'author'],
     ['PerlComment'],
   ],
 ;

From your spellcheck.ini file:

 [Lang::EN::US]
 [PerlPOD]
 skip_sections = author
 [PerlComment]

DESCRIPTION

This plugin combines one or more other plugins. This can be useful if you want more fine grain control over how Test::SpellCheck works. If you specify two or more plugins in your spellcheck.ini then the combo plugin will automatically be used to combine those plugins.

CONSTRUCTOR

new

 my $plugin = Test::SpellCheck::Plugin::Combo->new(@spec);

When creating a combo plugin from Perl, you pass in a list of plugin instances or plugin specs. Plugin specs are just an array reference where the first element is the short name of the plugin, and the rest of the elements are passed to the constructor. Thus these are all equivalent:

 my $plugin = Test::SpellCheck::Plugin::Combo->new(
   Test::SpellCheck::Plugin::PerlPOD->new(skip_sections => ['foo','bar']),
   Test::SpellCheck::Plugin::PerlComment->new,
 );
 
 my $plugin = Test::SpellCheck::Plugin::Combo->new(
   ['PerlPOD', skip_sections => ['foo','bar']],
   ['PerlComment'],
 );
 
 ; spellcheck.ini
 [PerlPOD]
 skip_section = foo
 skip_section = bar
 [PerlComment]

AUTHOR

Graham Ollis <plicease@cpan.org>

COPYRIGHT AND LICENSE

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