Sah::Schema::perl::filename - Filename of Perl script/module/POD, e.g. /path/Foo/Bar.pm
This document describes version 0.042 of Sah::Schema::perl::filename (from Perl distribution Sah-Schemas-Perl), released on 2021-12-01.
To check data against this schema (requires Data::Sah):
use Data::Sah qw(gen_validator); my $validator = gen_validator("perl::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::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::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 ...
Use this schema if you want to accept a filesystem path containing Perl script, module, or POD. The value of this schema is in the convenience of CLI completion, as well as coercion from script or module name.
String containing filename of a Perl script or module or POD. For convenience, when value is in the form of:
Foo Foo.pm Foo.pod Foo::Bar Foo/Bar Foo/Bar.pm Foo/Bar.pod
and a matching .pod or .pm file is found in @INC, then it will be coerced (converted) into the path of that .pod/.pm file, e.g.:
@INC
/home/ujang/perl5/perlbrew/perls/perl-5.24.0/lib/site_perl/5.24.0/Foo/Bar.pm lib/Foo/Bar.pod
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.
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.
Sah::Schema::perl::pm_filename
Sah::Schema::perl::pod_or_pm_filename
Sah::Schema::perl::pod_filename
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, 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.
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.
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.