1Test::CPAN::Meta(3)   User Contributed Perl Documentation  Test::CPAN::Meta(3)
2
3
4

NAME

6       Test::CPAN::Meta - Validation of the META.yml file in a CPAN
7       distribution.
8

SYNOPSIS

10       There are two forms this module can be used.
11
12       The first is a standalone test of your distribution's META.yml file:
13
14         use Test::More;
15         eval "use Test::CPAN::Meta";
16         plan skip_all => "Test::CPAN::Meta required for testing META.yml" if $@;
17         meta_yaml_ok();
18
19       Note that you may provide an optional label/comment/message/etc to the
20       function, or one will be created automatically.
21
22       The second form allows you to test other META.yml files, or specify a
23       specific version you wish to test against:
24
25         use Test::More test => 6;
26         use Test::CPAN::Meta;
27
28         # specify a file and specification version
29         meta_spec_ok('META.yml','1.3',$msg);
30
31         # specify the specification version to validate the local META.yml
32         meta_spec_ok(undef,'1.3',$msg);
33
34         # specify a file, where the specification version is deduced
35         # from the file itself
36         meta_spec_ok('META.yml',undef,$msg);
37
38       Note that this form requires you to specify the number of tests you
39       will be running in your test script. Also note that each 'meta_spec_ok'
40       is actually 2 tests under the hood.
41

DESCRIPTION

43       This module was written to ensure that a META.yml file, provided with a
44       standard distribution uploaded to CPAN, meets the specifications that
45       are slowly being introduced to module uploads, via the use of package
46       makers and installers such as ExtUtils::MakeMaker, Module::Build and
47       Module::Install.
48

ABSTRACT

50       A test module to validate a CPAN META.yml file.
51

FUNCTIONS

53       ·   meta_yaml_ok([$msg])
54
55           Basic META.yml wrapper around meta_spec_ok.
56
57           Returns a hash reference to the contents of the parsed META.yml
58
59       ·   meta_spec_ok($file, $version [,$msg])
60
61           Validates the named file against the given specification version.
62           Both $file and $version can be undefined.
63
64           Returns a hash reference to the contents of the given file, after
65           it has been parsed.
66

BUGS, PATCHES & FIXES

68       There are no known bugs at the time of this release. However, if you
69       spot a bug or are experiencing difficulties that are not explained
70       within the POD documentation, please send an email to barbie@cpan.org
71       or submit a bug to the RT system
72       (http://rt.cpan.org/Public/Dist/Display.html?Name=Test-YAML-Meta).
73       However, it would help greatly if you are able to pinpoint problems or
74       even supply a patch.
75
76       Fixes are dependant upon their severity and my availablity. Should a
77       fix not be forthcoming, please feel free to (politely) remind me.
78

SEE ALSO

80         Test::YAML::Valid
81

DSLIP

83         b - Beta testing
84         d - Developer
85         p - Perl-only
86         O - Object oriented
87         p - Standard-Perl: user may choose between GPL and Artistic
88

AUTHOR

90       Barbie, <barbie@cpan.org> for Miss Barbell Productions,
91       <http://www.missbarbell.co.uk>
92

94         Copyright (C) 2007,2008 Barbie for Miss Barbell Productions
95
96         This module is free software; you can redistribute it and/or
97         modify it under the same terms as Perl itself.
98
99
100
101perl v5.10.1                      2009-05-24               Test::CPAN::Meta(3)
Impressum