Sah::Schema::perl::distname_with_optional_ver - Perl distribution name (e.g. Foo-Bar) with optional version number suffix (e.g. Foo-Bar@0.001)
This document describes version 0.034 of Sah::Schema::perl::distname_with_optional_ver (from Perl distribution Sah-Schemas-Perl), released on 2020-06-19.
To check data against this schema (requires Data::Sah):
use Data::Sah qw(gen_validator); my $validator = gen_validator("perl::distname_with_optional_ver*"); say $validator->($data) ? "valid" : "INVALID!"; # Data::Sah can also create validator that returns nice error message string # and/or coerced value. Data::Sah can even create validator that targets other # language, like JavaScript. All from the same schema. See its documentation # for more details.
To validate function parameters against this schema (requires Params::Sah):
use Params::Sah qw(gen_validator); sub myfunc { my @args = @_; state $validator = gen_validator("perl::distname_with_optional_ver*"); $validator->(\@args); ... }
To specify schema in Rinci function metadata and use the metadata with Perinci::CmdLine to create a CLI:
# in lib/MyApp.pm package MyApp; our %SPEC; $SPEC{myfunc} = { v => 1.1, summary => 'Routine to do blah ...', args => { arg1 => { summary => 'The blah blah argument', schema => ['perl::distname_with_optional_ver*'], }, ... }, }; sub myfunc { my %args = @_; ... } 1; # in myapp.pl package main; use Perinci::CmdLine::Any; Perinci::CmdLine::Any->new(url=>'MyApp::myfunc')->run; # in command-line % ./myapp.pl --help myapp - Routine to do blah ... ... % ./myapp.pl --version % ./myapp.pl --arg1 ...
Sample data:
"" # INVALID "Foo-Bar" # valid "Foo-Bar\@1" # valid "Foo-Bar\@1.0" # valid "Foo::Bar\@1.0.0" # valid, becomes "Foo-Bar\@1.0.0" "Foo-Bar\@0.5_001" # valid "Foo::Bar\@0.5_001" # valid, becomes "Foo-Bar\@0.5_001" "Foo-Bar\@a" # INVALID
For convenience (particularly in CLI with tab completion), you can input one of:
Foo::Bar Foo/Bar Foo/Bar.pm Foo.Bar
and it will be coerced into Foo-Bar form.
Please visit the project's homepage at https://metacpan.org/release/Sah-Schemas-Perl.
Source repository is at https://github.com/perlancar/perl-Sah-Schemas-Perl.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Sah-Schemas-Perl
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.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2020, 2019, 2018, 2017, 2016 by 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.
To install Sah::Schemas::Perl, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Sah::Schemas::Perl
CPAN shell
perl -MCPAN -e shell install Sah::Schemas::Perl
For more information on module installation, please visit the detailed CPAN module installation guide.