1Module::CPANTS::AnalyseU(s3e)r Contributed Perl DocumentaMtoidounle::CPANTS::Analyse(3)
2
3
4

NAME

6       Module::CPANTS::Analyse - Generate Kwalitee ratings for a distribution
7

SYNOPSIS

9           use Module::CPANTS::Analyse;
10
11           my $analyser=Module::CPANTS::Analyse->new({
12               dist=>'path/to/Foo-Bar-1.42.tgz',
13           });
14           $analyser->run;
15           # results are in $analyser->d;
16

DESCRIPTION

18   Methods
19       new
20
21         my $analyser=Module::CPANTS::Analyse->new({dist=>'path/to/file'});
22
23       Plain old constructor.
24
25       unpack
26
27       Unpack the distribution into a temporary directory.
28
29       Returns an error if something went wrong, "undef" if all went well.
30
31       analyse
32
33       Run all analysers (defined in "Module::CPANTS::Kwalitee::*" on the
34       dist.
35
36       calc_kwalitee
37
38       Check if the dist conforms to the Kwalitee indicators.
39
40       run
41
42       Unpacks, analyses, and calculates kwalitee, and returns a resulting
43       stash.
44
45   Helper Methods
46       testdir
47
48       Returns the path to the unique temp directory.
49
50       testfile
51
52       Returns the location of the unextracted tarball.
53
54       tarball
55
56       Returns the filename of the tarball.
57
58       x_opts
59
60       Returns a hash reference that holds normalized information set in the
61       "x_cpants" custom META field.
62

WEBSITE

64       <http://cpants.cpanauthors.org/>
65

BUGS

67       Please report any bugs or feature requests, or send any patches, to
68       bug-module-cpants-analyse at rt.cpan.org, or through the web interface
69       at
70       <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Module-CPANTS-Analyse>.
71       I will be notified, and then you'll automatically be notified of
72       progress on your bug as I make changes.
73

AUTHOR

75       Thomas Klausner <https://metacpan.org/author/domm>
76
77       Please use the "perl-qa" mailing list for discussing all things CPANTS:
78       <http://lists.perl.org/list/perl-qa.html>
79
80       Based on work by Léon Brocard <https://metacpan.org/author/lbrocard>
81       and the original idea proposed by Michael G. Schwern
82       <https://metacpan.org/author/schwern>.
83

LICENSE

85       This code is Copyright © 2003–2006 Thomas Klausner
86       <https://metacpan.org/author/domm>.  All rights reserved.
87
88       You may use and distribute this module according to the same terms that
89       Perl is distributed under.
90
91
92
93perl v5.28.0                      2014-11-24        Module::CPANTS::Analyse(3)
Impressum