NAME

Sah::Schemas::WordList - Sah schemas related to WordList

VERSION

This document describes version 0.004 of Sah::Schemas::WordList (from Perl distribution Sah-Schemas-WordList), released on 2023-01-19.

SAH SCHEMAS

The following schemas are included in this distribution:

• perl::wordlist::modname

  Perl WordList::* module name without the prefix, e.g. EN::Enable.

  Contains coercion rule so you can also input Foo-Bar, Foo/Bar, Foo/Bar.pm or even 'Foo.Bar' and it will be normalized into Foo::Bar.

• perl::wordlist::modname_with_optional_args

  Perl WordList::* module name without the prefix (e.g. EN::Enable) with optional arguments (e.g. MetaSyntactic::Any=theme,dangdut).

  Perl WordList::* module name without the prefix, with optional arguments which will be used as import arguments, just like the -MMODULE=ARGS shortcut that perl provides. Examples:

   EN::Enable
   MetaSyntactic::Any=theme,dangdut

  See also: perl::wordlist::modname.

• perl::wordlist::modnames

  Array of Perl WordList::* module names without the prefix, e.g. ["EN::Enable", "EN::BIP39"].

  Array of Perl WordList::* module names, where each element is of perl::wordlist::modname schema, e.g. EN::Enable, EN::BIP39.

  Contains coercion rule that expands wildcard, so you can specify:

   EN::*

  and it will be expanded to e.g.:

   ["EN::Enable", "EN::BIP39"]

  The wildcard syntax supports jokers (?, *, **), brackets ([abc]), and braces ({one,two}). See Module::List::Wildcard for more details.

• perl::wordlist::modnames_with_optional_args

  Array of Perl WordList::* module names without the prefix, with optional args, e.g. ["EN::Enable", "MetaSyntactic::Any=theme,dangdut"].

  Array of Perl WordList::* module names without the prefix and with optional args. Each element is of perl::modname schema, e.g. EN::Enable, MetaSyntactic::Any=theme,dangdut.

  Contains coercion rule that expands wildcard, so you can specify:

   ID::*

  and it will be expanded to e.g.:

   ["ID::KBBI", "ID::PERLANCAR"]

  The wildcard syntax supports jokers (?, *, **), brackets ([abc]), and braces ({one,two}). See Module::List::Wildcard for more details.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Sah-Schemas-WordList.

SOURCE

Source repository is at https://github.com/perlancar/perl-Sah-Schemas-WordList.

SEE ALSO

Sah - schema specification

Data::Sah - Perl implementation of Sah

WordList

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

 % prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2023, 2021, 2020 by perlancar <perlancar@cpan.org>.

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

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Sah-Schemas-WordList

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.