Module...Analyse(3pm)

💅 Module::CPANTS::Analyse

okay bestie so this is a page from the User Contributed Perl Documentation (yes, that's the manual name, we're keeping it, it's giving official ✨) and it's all about Module::CPANTS::Analyse — the module that generates Kwalitee ratings for a distribution. iconic behaviour honestly 🎀

---

✨ NAME ✨

Module::CPANTS::Analyse — Generate Kwalitee ratings for a distribution 🌸

---

✨ SYNOPSIS ✨

use Module::CPANTS::Analyse;

my $analyser = Module::CPANTS::Analyse->new({
    dist => 'path/to/Foo-Bar-1.42.tgz',
});
$analyser->run;
# results are in $analyser->d;

like, that's it. three lines and you're analysing. slay 💅

---

✨ DESCRIPTION ✨

🫶 Methods 🫶

new

my $analyser = Module::CPANTS::Analyse->new({dist => 'path/to/file'});

Plain old constructor. nothing fancy, no cap — just a constructor doing constructor things 💖

unpack

Unpack the distribution into a temporary directory.

Returns an error if something went wrong, undef if all went well. so like — no error = undef = good vibes 😭 yes that's the actual contract, don't come for me

analyse

Run all analysers (defined in "Module::CPANTS::Kwalitee::*") on the dist. all of them. every single one. periodt 🔥

calc_kwalitee

Check if the dist conforms to the Kwalitee indicators. this is the vibe check for your whole distribution ngl ✅

run

Unpacks, analyses, and calculates kwalitee, and returns a resulting stash. one method, three jobs, main character energy 👑

---

🦋 Helper Methods 🦋

testdir

Returns the path to the unique temp directory. it's unique, it's temp, it's yours 💜

testfile

Returns the location of the unextracted tarball. (unextracted! still a whole tarball! untouched!) 🙈

tarball

Returns the filename of the tarball. yes it's a different one from testfile, they are not the same, do not merge them, i will know 🍓

x_opts

Returns a hash reference that holds normalized information set in the "x_cpants" custom META field. hashref, normalized, "x_cpants" — write it down bestie ✨

---

🌈 WEBSITE 🌈

https://cpants.cpanauthors.org/

---

💀 BUGS 💀

Please report any bugs or feature requests, or send any patches, to "bug-module-cpants-analyse at rt.cpan.org", or through the web interface at https://rt.cpan.org/NoAuth/ReportBug.html?Queue=Module-CPANTS-Analyse.

I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. so like, the loop closes itself, very girlboss of it 💅

---

👑 AUTHOR 👑

Thomas Klausner https://metacpan.org/author/domm

Please use the "perl-qa" mailing list for discussing all things CPANTS: https://lists.perl.org/list/perl-qa.html

Based on work by Léon Brocard https://metacpan.org/author/lbrocard and the original idea proposed by Michael G. Schwern https://metacpan.org/author/schwern. legends, all of them 🫶

---

⭐ LICENSE ⭐

This code is Copyright © 2003–2006 Thomas Klausner https://metacpan.org/author/domm. All rights reserved.

You may use and distribute this module according to the same terms that Perl is distributed under.

💖 that's the whole legal bit, keep it exactly as-is, no edits, no vibes-based reinterpretation, fr fr

---

and that's the whole page bestie!! 🧚 this was generated from the perldoc for perl v5.40.1, dated 2026-07-05 — go forth and kwalitee-check your distributions, love u 💜