Sah::Schema::perl::tabledata::modnames_with_optional_args - Array of Perl TableData::* module names without the prefix, with optional args, e.g. ["Locale::US::State", "WordList=wordlist,EN::Enable"]
This document describes version 0.002 of Sah::Schema::perl::tabledata::modnames_with_optional_args (from Perl distribution Sah-Schemas-TableData), released on 2021-09-29.
To check data against this schema (requires Data::Sah):
use Data::Sah qw(gen_validator); my $validator = gen_validator("perl::tabledata::modnames_with_optional_args*"); 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::tabledata::modnames_with_optional_args*"); $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::tabledata::modnames_with_optional_args*'], }, ... }, }; 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 ...
Array of Perl TableData::* module names without the prefix and optional args. Each element is of perl::tabledata::modname schema, e.g. Locale::US::State, WordList=wordlist,EN::Enable.
perl::tabledata::modname
Locale::US::State
WordList=wordlist,EN::Enable
Contains coercion rule that expands wildcard, so you can specify:
Locale::US::*
and it will be expanded to e.g.:
["Locale::US::State", "Locale::US::City"]
The wildcard syntax supports jokers (?, *, **), brackets ([abc]), and braces ({one,two}). See Module::List::Wildcard for more details.
?
*
**
[abc]
{one,two}
Please visit the project's homepage at https://metacpan.org/release/Sah-Schemas-TableData.
Source repository is at https://github.com/perlancar/perl-Sah-Schemas-TableData.
perlancar <perlancar@cpan.org>
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, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required beyond that are considered a bug and can be reported to me.
This software is copyright (c) 2021 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.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Sah-Schemas-TableData
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.
To install Sah::Schemas::TableData, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Sah::Schemas::TableData
CPAN shell
perl -MCPAN -e shell install Sah::Schemas::TableData
For more information on module installation, please visit the detailed CPAN module installation guide.