The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Sah::SchemaBundle::Sorter - Sah schemas related to Sorter

VERSION

This document describes version 0.002 of Sah::SchemaBundle::Sorter (from Perl distribution Sah-SchemaBundle-Sorter), released on 2024-03-07.

SAH SCHEMAS

The following schemas are included in this distribution:

  • perl::sorter::modname

    Perl Sorter::* module name without the prefix, e.g. foo.

    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::sorter::modname_with_optional_args

    Perl Sorter::* module name without the prefix (e.g. Foo::bar) with optional arguments (e.g. Foo::baz,qux,quux).

    Perl Sorter::* 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:

     Foo::bar
     Foo::baz=qux,quux
     Foo::baz,qux,quux

    See also: perl::sorter::modname.

  • perl::sorter::modnames

    Array of Perl Sorter::* module names without the prefix, e.g. ["Foo::bar", "Foo::baz"].

    Array of Perl Sorter::* module names, where each element is of perl::sorter::modname schema, e.g. Foo::bar, Foo::baz.

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

     Foo::*

    and it will be expanded to e.g.:

     ["Foo::bar", "Foo::baz"]

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

  • perl::sorter::modnames_with_optional_args

    Array of Perl Sorter::* module names without the prefix, with optional args, e.g. ["Foo::bar", "Foo::baz=qux,quux"].

    Array of Perl Sorter::* module names without the prefix and with optional args. Each element is of perl::sorter::modname_with_optional_args schema, e.g. Foo::bar, Foo::baz=qux,quux.

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

     Foo::*

    and it will be expanded to e.g.:

     ["Foo::bar", "Foo::baz"]

    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-Sorter.

SOURCE

Source repository is at https://github.com/perlancar/perl-Sah-SchemaBundle-Sorter.

SEE ALSO

Sorter

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-Sorter

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.