-
-
01 Dec 2021 23:48:08 UTC
- Distribution: Sah-Schemas-Perl
- Module version: 0.042
- Source (raw)
- Browse (raw)
- Changes
- Homepage
- How to Contribute
- Repository
- Issues (2)
- Testers (1215 / 12 / 1)
- Kwalitee
Bus factor: 1- % Coverage
- License: perl_5
- Perl: v5.10.1
- Activity
24 month- Tools
- Download (45.24KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
- Dependencies
- Complete::File
- Complete::Module
- Complete::Util
- Data::Dmp
- Module::CoreList
- Perinci::Sub::XCompletion::perl_distname
- Perinci::Sub::XCompletion::perl_modname
- Perinci::Sub::XCompletion::perl_modname_or_prefix
- Perinci::Sub::XCompletion::perl_modprefix
- Regexp::Pattern::Perl::Module
- strict
- warnings
- Reverse dependencies
- CPAN Testers List
- Dependency graph
NAME
Sah::Schema::perl::modname - Perl module name, e.g. Foo::Bar
VERSION
This document describes version 0.042 of Sah::Schema::perl::modname (from Perl distribution Sah-Schemas-Perl), released on 2021-12-01.
SYNOPSIS
To check data against this schema (requires Data::Sah):
use Data::Sah qw(gen_validator); my $validator = gen_validator("perl::modname*"); 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::modname*"); $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::modname*'], }, ... }, }; 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" # valid, becomes "Foo::Bar" "Foo/Bar" # valid, becomes "Foo::Bar" "Foo/Bar.pm" # valid, becomes "Foo::Bar" "Foo.Bar" # valid, becomes "Foo::Bar" "Foo|Bar" # INVALID
DESCRIPTION
This is a schema you can use when you want to accept a Perl module name. It offers basic checking of syntax as well as a couple of conveniences. First, it offers completion from list of locally installed Perl modules. Second, it contains coercion rule so you can also input
Foo-Bar
,Foo/Bar
,Foo/Bar.pm
or even 'Foo.Bar' and it will be normalized intoFoo::Bar
.To see this schema in action on the CLI, you can try e.g. the
pmless
script from App::PMUtils and activate its tab completion (see its manpage for more details). Then on the CLI try typing:% pmless M/<tab> % pmless dzp/<tab> % pmless Module/List/Wildcard % pmless Module::List::Wildcard
Note that this schema does not check that the Perl module exists or is installed locally. To check that, use the
perl::modname::installed
schema. And there's also aperl::modname::not_installed
schema.HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/Sah-Schemas-Perl.
SOURCE
Source repository is at https://github.com/perlancar/perl-Sah-Schemas-Perl.
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, 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.
COPYRIGHT AND LICENSE
This software is copyright (c) 2021, 2020, 2019, 2018, 2017, 2016 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-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.
Module Install Instructions
To install Sah::Schemas::Perl, copy and paste the appropriate command in to your terminal.
cpanm Sah::Schemas::Perl
perl -MCPAN -e shell install Sah::Schemas::Perl
For more information on module installation, please visit the detailed CPAN module installation guide.