NAME

Sah::Schema::perl::pm_filename - Filename of perl module, e.g. /path/Foo.pm

VERSION

This document describes version 0.029 of Sah::Schema::perl::pm_filename (from Perl distribution Sah-Schemas-Perl), released on 2020-05-08.

SYNOPSIS

Using with Data::Sah:

 use Data::Sah qw(gen_validator);
 my $vdr = gen_validator("perl::pm_filename*");
 say $vdr->($data) ? "valid" : "INVALID!";

 # Data::Sah can also create a validator to return error message, coerced value,
 # even validators in other languages like JavaScript, from the same schema.
 # See its documentation for more details.

Using in Rinci function metadata (to be used in Perinci::CmdLine, etc):

 package MyApp;
 our %SPEC;
 $SPEC{myfunc} = {
     v => 1.1,
     summary => 'Routine to do blah ...',
     args => {
         arg1 => {
             summary => 'The blah blah argument',
             schema => ['perl::pm_filename*'],
         },
         ...
     },
 };
 sub myfunc {
     my %args = @_;
     ...
 }

DESCRIPTION

Use this schema if you want to accept a filesystem path containing Perl module. The value of this schema is in the convenience of CLI completion, as well as coercion from module name.

String containing filename of a Perl module. For convenience, when value is in the form of:

 Foo
 Foo.pm
 Foo::Bar
 Foo/Bar
 Foo/Bar.pm

and a matching .pm file is found in @INC, then it will be coerced (converted) into the path of that .pm file, e.g.:

 /home/ujang/perl5/perlbrew/perls/perl-5.24.0/lib/site_perl/5.24.0/Foo/Bar.pm

To prevent such coercion, you can use prefixing path, e.g.:

 ./Foo::Bar
 ../Foo/Bar
 /path/to/Foo/Bar

This schema comes with convenience completion too.

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.

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.

SEE ALSO

Sah::Schema::perl::filename

Sah::Schema::perl::pod_or_pm_filename

Sah::Schema::perl::pod_filename

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

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.

cpanm Sah::Schemas::Perl

perl -MCPAN -e shell
install Sah::Schemas::Perl