Sah::Schema::git::refname - git reference name
This document describes version 0.002 of Sah::Schema::git::refname (from Perl distribution Sah-Schemas-Git), released on 2020-03-27.
Using with Data::Sah:
use Data::Sah qw(gen_validator); my $vdr = gen_validator("git::refname*"); 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 with 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 => ['git::refname*'], }, ... }, }; sub myfunc { my %args = @_; ... }
Sample data:
"foo/bar" # valid ".foo/bar" # INVALID (A slash-separated component begins with dot (rule 1))
Please visit the project's homepage at https://metacpan.org/release/Sah-Schemas-Git.
Source repository is at https://github.com/perlancar/perl-Sah-Schemas-Git.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Sah-Schemas-Git
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.
The rules for a reference name is documented in the manual page of git-check-ref-format command, https://git-scm.com/docs/git-check-ref-format.
TODO: reorganize so we can display better error message
TODO: if --refsec-pattern is used, refname is allowed to have a single *, e.g. foo/bar*/baz or foo/bar*baz but not foo/bar*/baz*
TODO: add normalize coercion rule to remove leading / and duplicate adjacent /.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2020 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.
To install Sah::Schemas::Git, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Sah::Schemas::Git
CPAN shell
perl -MCPAN -e shell install Sah::Schemas::Git
For more information on module installation, please visit the detailed CPAN module installation guide.