Debian Codegraph @

upstream/opensuse-tumbleweed/man3/CPAN::Meta::Validator.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\"
56 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "CPAN::Meta::Validator 3pm"
61 .TH CPAN::Meta::Validator 3pm 2026-03-09 "perl v5.42.1" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 CPAN::Meta::Validator \- validate CPAN distribution metadata structures
68 .SH VERSION
69 .IX Header "VERSION"
70 version 2.150010
71 .SH SYNOPSIS
72 .IX Header "SYNOPSIS"
73 .Vb 1
74 \& my $struct = decode_json_file(\*(AqMETA.json\*(Aq);
75 \&
76 \& my $cmv = CPAN::Meta::Validator\->new( $struct );
77 \&
78 \& unless ( $cmv\->is_valid ) {
79 \& my $msg = "Invalid META structure. Errors found:\en";
80 \& $msg .= join( "\en", $cmv\->errors );
81 \& die $msg;
82 \& }
83 .Ve
84 .SH DESCRIPTION
85 .IX Header "DESCRIPTION"
86 This module validates a CPAN Meta structure against the version of the
87 the specification claimed in the \f(CW\*(C`meta\-spec\*(C'\fR field of the structure.
88 .SH METHODS
89 .IX Header "METHODS"
90 .SS new
91 .IX Subsection "new"
92 .Vb 1
93 \& my $cmv = CPAN::Meta::Validator\->new( $struct )
94 .Ve
95 .PP
96 The constructor must be passed a metadata structure.
97 .SS is_valid
98 .IX Subsection "is_valid"
99 .Vb 3
100 \& if ( $cmv\->is_valid ) {
101 \& ...
102 \& }
103 .Ve
104 .PP
105 Returns a boolean value indicating whether the metadata provided
106 is valid.
107 .SS errors
108 .IX Subsection "errors"
109 .Vb 1
110 \& warn( join "\en", $cmv\->errors );
111 .Ve
112 .PP
113 Returns a list of errors seen during validation.
114 .SH BUGS
115 .IX Header "BUGS"
116 Please report any bugs or feature using the CPAN Request Tracker.
117 Bugs can be submitted through the web interface at
118 <http://rt.cpan.org/Dist/Display.html?Queue=CPAN\-Meta>
119 .PP
120 When submitting a bug or request, please include a test\-file or a patch to an
121 existing test\-file that illustrates the bug or desired feature.
122 .SH AUTHORS
123 .IX Header "AUTHORS"
124 .IP \(bu 4
125 David Golden <[email protected]>
126 .IP \(bu 4
127 Ricardo Signes <[email protected]>
128 .IP \(bu 4
129 Adam Kennedy <[email protected]>
130 .SH "COPYRIGHT AND LICENSE"
131 .IX Header "COPYRIGHT AND LICENSE"
132 This software is copyright (c) 2010 by David Golden, Ricardo Signes, Adam Kennedy and Contributors.
133 .PP
134 This is free software; you can redistribute it and/or modify it under
135 the same terms as the Perl 5 programming language system itself.