| Disable Functions: Path : /usr/local/share/man/man3/ |
| Current File : //usr/local/share/man/man3/CPAN::Meta::Validator.3pm |
.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
. if \nF \{
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "inc::CPAN::Meta::Validator 3"
.TH inc::CPAN::Meta::Validator 3 "2020-06-10" "perl v5.16.3" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
CPAN::Meta::Validator \- validate CPAN distribution metadata structures
.SH "VERSION"
.IX Header "VERSION"
version 2.143240
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& my $struct = decode_json_file(\*(AqMETA.json\*(Aq);
\&
\& my $cmv = CPAN::Meta::Validator\->new( $struct );
\&
\& unless ( $cmv\->is_valid ) {
\& my $msg = "Invalid META structure. Errors found:\en";
\& $msg .= join( "\en", $cmv\->errors );
\& die $msg;
\& }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module validates a \s-1CPAN\s0 Meta structure against the version of the
the specification claimed in the \f(CW\*(C`meta\-spec\*(C'\fR field of the structure.
.SH "METHODS"
.IX Header "METHODS"
.SS "new"
.IX Subsection "new"
.Vb 1
\& my $cmv = CPAN::Meta::Validator\->new( $struct )
.Ve
.PP
The constructor must be passed a metadata structure.
.SS "is_valid"
.IX Subsection "is_valid"
.Vb 3
\& if ( $cmv\->is_valid ) {
\& ...
\& }
.Ve
.PP
Returns a boolean value indicating whether the metadata provided
is valid.
.SS "errors"
.IX Subsection "errors"
.Vb 1
\& warn( join "\en", $cmv\->errors );
.Ve
.PP
Returns a list of errors seen during validation.
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature using the \s-1CPAN\s0 Request Tracker.
Bugs can be submitted through the web interface at
<http://rt.cpan.org/Dist/Display.html?Queue=CPAN\-Meta>
.PP
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.
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "\(bu" 4
David Golden <dagolden@cpan.org>
.IP "\(bu" 4
Ricardo Signes <rjbs@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2010 by David Golden and Ricardo Signes.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.