CPANTS_LINT(1p)

💖 CPANTS_LINT 💖

okay bestie, so this is cpants_lint(1p) — a lil commandline frontend, and it's literally the most useful thing for checking your CPAN dist's Kwalitee before you yeet it into the wild. no cap.

---

✨ NAME ✨

cpants_lint — commandline frontend to Module::CPANTS::Analyse. yes that's the whole name section, she's short and she's iconic 🎀

---

🌸 SYNOPSIS 🌸

cpants_lint path/to/Foo-Dist-1.42.tgz

Options:
    --help              brief help message
    --man               full documentation
    --verbose           print more info during run
    --colour, --color   pretty output

    --dump              dump result using Data::Dumper
    --yaml              dump result as YAML
    --json              dump result as JSON

    --save              write report (or dump) to a file
    --dir               directory to save a report to
    --metrics_path      search path for extra metrics modules

like. that's it. hand her a tarball and she'll spill the tea 💅

---

🦋 DESCRIPTION 🦋

so cpants_lint checks the Kwalitee of a CPAN distribution. more exact (her words, not mine 😭), it checks how a given tarball will be rated on http://cpants.perl.org, without needing to upload it first. no posting, no waiting, no vibes ruined by a surprise score. obsessed.

want more info on Kwalitee, and the whole of CPANTS? go peek at http://cpants.perl.org and / or Module::CPANTS::Analyse. periodt.

---

💅 OPTIONS 💅

--help

print a brief help message. the "hey bestie what is this" option 🫶

--man

print manpage. the "no fr, read the whole thing" option.

--verbose

print some informative messages while analysing a distribution. she'll narrate the journey for you ✨

--colour, --color

like --verbose, but prettier. 🌈

real talk though: you need to install Term::ANSIColor (and Win32::Console::ANSI for Win32) to enable this option. no modules, no rainbow, sorry babe 😭

--dump

dump the result using Data::Dumper (instead of displaying a report text). for when you want the raw, unfiltered data 💀

--yaml

dump the result as YAML. very structured. very main character. 🎀

--json

dump the result as JSON. she said modern data interchange, slay.

--save

output the result into a file instead of STDOUT.

the name of the file will be Foo-Dist.txt (well, the extension depends on the dump format and can be .dmp, .yml or .json) 🍓

--dir

directory to dump a file to. defaults to the current working directory. ngl this one just vibes wherever you point it.

--metrics_path

search path for extra metrics modules 👑

---

👑 AUTHOR 👑

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

Kenichi Ishigaki <https://metacpan.org/author/ishigaki>

the legends themselves 💜

---

📜 COPYRIGHT AND LICENSE 📜

Copyright © 2003–2006, 2009 Thomas Klausner <https://metacpan.org/author/domm>

Copyright © 2014 Kenichi Ishigaki <https://metacpan.org/author/ishigaki>

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

---

okay that's the whole page, bestie, you're officially certified 🧚

🌟 sign-off: this was perl v5.34.0, dated 2022-06-08 — CPANTS_LINT(1p), out. mwah 💖