Skip to content

Commit c4b482e

Browse files
committed
Add POD
1 parent cfd49a0 commit c4b482e

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

lib/Test/META.pm

+52
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,57 @@
11
use v6;
22

3+
=begin pod
4+
5+
=head1 NAME
6+
7+
Test::META - Test that a Perl 6 project has a good and proper META file
8+
9+
=head1 SYNOPSIS
10+
11+
This is the actual *t/030-my-meta.t* from this distribution
12+
13+
=begin code
14+
#!perl6
15+
16+
use v6;
17+
use lib 'lib';
18+
19+
use Test;
20+
use Test::META;
21+
22+
plan 1;
23+
24+
# That's it
25+
meta-ok();
26+
27+
28+
done-testing;
29+
=end code
30+
31+
=head1 DESCRIPTION
32+
33+
This provides a simple mechanims for module authors to have some
34+
confidence that they have a working distribution META description
35+
file (as described in L<http://design.perl6.org/S22.html#META6.json>.)
36+
37+
It exports one subroutine *meta-ok* that runs a single sub-test that
38+
checks that:
39+
40+
=item The META file (either META6.json or META.info) exists
41+
42+
=item That the META file can be parsed as valid JSON
43+
44+
=item That the attributes marked as "mandatory" are present
45+
46+
=item That the files mention in the "provides" section are present.
47+
48+
There are mechanisms (used internally for testing,) to over-ride the
49+
location or name of the META file and these can be seen in the test-suite,
50+
though they won't typically be needed.
51+
52+
=end pod
53+
54+
355
module Test::META:ver<v0.0.1>:auth<github:jonathanstowe> {
456

557
use Test;

0 commit comments

Comments
 (0)