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

NAME

6         Test::Kwalitee - test the Kwalitee of a distribution before you release it
7

SYNOPSIS

9         # in a separate test file
10         use Test::More;
11
12         eval { require Test::Kwalitee; Test::Kwalitee->import() };
13
14         plan( skip_all => 'Test::Kwalitee not installed; skipping' ) if $@;
15

DESCRIPTION

17       Kwalitee is an automatically-measurable gauge of how good your software
18       is.  That's very different from quality, which a computer really can't
19       measure in a general sense.  (If you can, you've solved a hard problem
20       in computer science.)
21
22       In the world of the CPAN, the CPANTS project (CPAN Testing Service;
23       also a funny acronym on its own) measures Kwalitee with several
24       metrics.  If you plan to release a distribution to the CPAN -- or even
25       within your own organization -- testing its Kwalitee before creating a
26       release can help you improve your quality as well.
27
28       "Test::Kwalitee" and a short test file will do this for you
29       automatically.
30

USAGE

32       Create a test file as shown in the synopsis.  Run it.  It will run all
33       of the potential Kwalitee tests on the current distribution, if
34       possible.  If any fail, it will report those as regular diagnostics.
35
36       If you ship this test and a user does not have "Test::Kwalitee"
37       installed, nothing bad will happen.
38
39       To run only a handful of tests, pass their names to the module's
40       "import()" method:
41
42         eval
43         {
44             require Test::Kwalitee;
45             Test::Kwalitee->import( tests => [ qw( use_strict has_tests ) ] );
46         };
47
48       To disable a test, pass its name with a leading minus ("-") to
49       "import()":
50
51         eval
52         {
53             require Test::Kwalitee;
54             Test::Kwalitee->import( tests =>
55                 [ qw( -has_test_pod -has_test_pod_coverage ) ]
56             );
57         };
58
59       As of version 1.00, the tests include:
60
61       ·   extractable
62
63           Is the distribution extractable?
64
65       ·   has_readme
66
67           Does the distribution have a README file?
68
69       ·   have_manifest
70
71           Does the distribution have a MANIFEST?
72
73       ·   have_meta_yml
74
75           Does the distribution have a META.yml file?
76
77       ·   have_buildtool
78
79           Does the distribution have a build tool file?
80
81       ·   have_changelog
82
83           Does the distribution have a changelog?
84
85       ·   no_symlinks
86
87           Does the distribution have no symlinks?
88
89       ·   have_tests
90
91           Does the distribution have tests?
92
93       ·   proper_libs
94
95           Does the distribution have proper libs?
96
97       ·   no_pod_errors
98
99           Does the distribution have no POD errors?
100
101       ·   use_strict
102
103           Does the distribution files all use strict?
104
105       ·   have_test_pod
106
107           Does the distribution have a POD test file?
108
109       ·   have_test_pod_coverage
110
111           Does the distribution have a POD-coverage test file?
112

AUTHOR

114       chromatic, <chromatic at wgz dot org>
115
116       With thanks to CPANTS and Thomas Klausner, as well as test tester Chris
117       Dolan.
118

BUGS

120       No known bugs.
121

123       Copyright (c) 2005 - 2008, chromatic.  Some rights reserved.
124
125       This module is free software; you can use, redistribute, and modify it
126       under the same terms as Perl 5.8.x.
127
128
129
130perl v5.12.0                      2010-05-06                 Test::Kwalitee(3)
Impressum