NAME

Sah::Schema::perl::pm_filename - A .pm filename, e.g. /path/Foo.pm

VERSION

This document describes version 0.042 of Sah::Schema::perl::pm_filename (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::pm_filename*");
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::pm_filename*");
    $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::pm_filename*'],
        },
        ...
    },
};
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 ...

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.

SEE ALSO

Sah::Schema::perl::filename

Sah::Schema::perl::pod_or_pm_filename

Sah::Schema::perl::pod_filename

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.

cpanm Sah::Schemas::Perl

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