NAME
Sah::SchemaBundle::SortKey - Sah schemas related to SortKey
VERSION
This document describes version 0.002 of Sah::SchemaBundle::SortKey
(from Perl distribution Sah-SchemaBundle-SortKey), released on
2024-03-07.
SAH SCHEMAS
The following schemas are included in this distribution:
* perl::sortkey::modname
Perl SortKey::* module name without the prefix, e.g.
Num/pattern_count.
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::sortkey::modname_with_optional_args
Perl SortKey::* module name without the prefix (e.g.
Num::pattern_count) with optional arguments (e.g.
Num::pattern_count,pattern,foo).
Perl SortKey::* 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:
Num::pattern_count
Num::pattern_count=pattern,foo
Num::pattern_count,pattern,foo
See also: "perl::sortkey::modname".
* perl::sortkey::modnames
Array of Perl SortKey::* module names without the prefix, e.g.
["Num::length", "Num::pattern_count"].
Array of Perl SortKey::* module names, where each element is of
"perl::sortkey::modname" schema, e.g. "Num::length",
"Num::pattern_count".
Contains coercion rule that expands wildcard, so you can specify:
Num::*
and it will be expanded to e.g.:
["Num::length", "Num::pattern_count"]
The wildcard syntax supports jokers ("?", "*", "**"), brackets
("[abc]"), and braces ("{one,two}"). See Module::List::Wildcard for
more details.
* perl::sortkey::modnames_with_optional_args
Array of Perl SortKey::* module names without the prefix, with
optional args, e.g. ["Num::length",
"Num::pattern_count=pattern,foo"].
Array of Perl SortKey::* module names without the prefix and with
optional args. Each element is of "perl::sortkey::modname" schema,
e.g. "Num::length", "Num::pattern_count".
Contains coercion rule that expands wildcard, so you can specify:
Num::*
and it will be expanded to e.g.:
["Num::length", "Num::pattern_count"]
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-SchemaBundle-SortKey>.
SOURCE
Source repository is at
<https://github.com/perlancar/perl-Sah-Schemas-SortKey>.
SEE ALSO
SortKey
Sah - schema specification
Data::Sah - Perl implementation of Sah
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) 2024 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-SchemaBundle-Sort
Key>
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.