Debian Codegraph @

upstream/debian-unstable/man3/CPAN::Meta::Validator.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (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 .\"
57 .IX Title "CPAN::Meta::Validator 3perl"
58 .TH CPAN::Meta::Validator 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 CPAN::Meta::Validator \- validate CPAN distribution metadata structures
65 .SH VERSION
66 .IX Header "VERSION"
67 version 2.150010
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 1
71 \& my $struct = decode_json_file(\*(AqMETA.json\*(Aq);
72 \&
73 \& my $cmv = CPAN::Meta::Validator\->new( $struct );
74 \&
75 \& unless ( $cmv\->is_valid ) {
76 \& my $msg = "Invalid META structure. Errors found:\en";
77 \& $msg .= join( "\en", $cmv\->errors );
78 \& die $msg;
79 \& }
80 .Ve
81 .SH DESCRIPTION
82 .IX Header "DESCRIPTION"
83 This module validates a CPAN Meta structure against the version of the
84 the specification claimed in the \f(CW\*(C`meta\-spec\*(C'\fR field of the structure.
85 .SH METHODS
86 .IX Header "METHODS"
87 .SS new
88 .IX Subsection "new"
89 .Vb 1
90 \& my $cmv = CPAN::Meta::Validator\->new( $struct )
91 .Ve
92 .PP
93 The constructor must be passed a metadata structure.
94 .SS is_valid
95 .IX Subsection "is_valid"
96 .Vb 3
97 \& if ( $cmv\->is_valid ) {
98 \& ...
99 \& }
100 .Ve
101 .PP
102 Returns a boolean value indicating whether the metadata provided
103 is valid.
104 .SS errors
105 .IX Subsection "errors"
106 .Vb 1
107 \& warn( join "\en", $cmv\->errors );
108 .Ve
109 .PP
110 Returns a list of errors seen during validation.
111 .SH BUGS
112 .IX Header "BUGS"
113 Please report any bugs or feature using the CPAN Request Tracker.
114 Bugs can be submitted through the web interface at
115 <http://rt.cpan.org/Dist/Display.html?Queue=CPAN\-Meta>
116 .PP
117 When submitting a bug or request, please include a test-file or a patch to an
118 existing test-file that illustrates the bug or desired feature.
119 .SH AUTHORS
120 .IX Header "AUTHORS"
121 .IP \(bu 4
122 David Golden <[email protected]>
123 .IP \(bu 4
124 Ricardo Signes <[email protected]>
125 .IP \(bu 4
126 Adam Kennedy <[email protected]>
127 .SH "COPYRIGHT AND LICENSE"
128 .IX Header "COPYRIGHT AND LICENSE"
129 This software is copyright (c) 2010 by David Golden, Ricardo Signes, Adam Kennedy and Contributors.
130 .PP
131 This is free software; you can redistribute it and/or modify it under
132 the same terms as the Perl 5 programming language system itself.