Dist::...:Critic(3pm)

πŸ“¦
version 3.005 Β· 4 versions
, in ubuntu resolute, ubuntu stonking

πŸ’… Dist::Zilla::Plugin::Test::Perl::Critic β€” or as the manpage header calls it, Dist::...:Critic(3pm) ✨

okay bestie, so this is one of those User Contributed Perl Documentation pages, and it's giving "your code is gonna get roasted by a robot, but like, lovingly" πŸ’–


🌸 NAME 🌸

Dist::Zilla::Plugin::Test::Perl::Critic β€” Tests to check your code against best practices πŸ”₯


⭐ VERSION ⭐

version 3.005


πŸŽ€ SYNOPSIS πŸŽ€

In your dist.ini:

[Test::Perl::Critic]
critic_config = perlcritic.rc ; default / relative to project root

πŸ¦‹ DESCRIPTION πŸ¦‹

So here's the tea β˜• β€” this plugin hands you an xt/author/critic.t file that does its thing during the "test" and "release" calls of "dzil". To get it going, make those changes to dist.ini up there and then run one of these:

dzil test
dzil release

And during those runs, xt/author/critic.t will use Test::Perl::Critic to run Perl::Critic against your code and by report findings. Yeah. It's gonna read your whole vibe and tell you what it thinks. no cap πŸ‘‘


✨ OPTIONS ✨

  • filename β€” the file name of the test to generate. Defaults to xt/author/critic.t. (Yes, you can rename it. It's your test file, your rules πŸ’…)
  • critic_config β€” this plugin accepts the "critic_config" option, which s Specifies your own config file for Perl::Critic. It defaults to "perlcritic.rc", relative to the project root. And if that file doesn't exist? Perl::Critic will just use its defaults. nbd, it'll cope πŸ™ˆ

The option can also be configured using the "profile" alias β€” so if you see profile floating around somewhere, that's literally the same thing, bestie, same energy ✨

  • verbose β€” if configured, overrides the "-verbose" option to Perl::Critic. Turn it up if you wanna hear everything it has to say 😭
  • files β€” if specified, will be used as the list of files to check. If neither "files" nor "finder" is specified, Test::Perl::Critic's default behavior of checking all files will be used. (i.e. it checks everything, main character energy 🌈)
  • finder β€” can be specified to use a file finder to select the files to check, rather than checking all files. Much more curated, much more ✨intentional✨

🫢 SUPPORT 🫢

Bugs may be submitted through the RT bug tracker <https://rt.cpan.org/Public/Dist/Display.html?Name=Dist-Zilla-Plugin-Test-Perl-Critic> (or bug-Dist-Zilla-Plugin-Test-Perl-Critic@rt.cpan.org <mailto:bug-Dist-Zilla-Plugin-Test-Perl-Critic@rt.cpan.org>).

There is also an irc channel available for users of this distribution, at "#distzilla" on "irc.perl.org" <irc://irc.perl.org/#distzilla>. Come hang out, it's a vibe πŸ’œ


πŸ‘‘ AUTHOR πŸ‘‘

Jerome Quelin


🧚 CONTRIBUTORS 🧚

  • Karen Etheridge <ether@cpan.org>
  • JΓ©rΓ΄me Quelin <jquelin@gmail.com>
  • Graham Knop <haarg@haarg.org>
  • Kent Fredric <kentfredric@gmail.com>
  • Olivier MenguΓ© <dolmen@cpan.org>
  • Gryphon Shafer <gryphon@goldenguru.com>
  • Mikko Koivunalho <mikkoi@cpan.org>
  • Stephen R. Scaffidi <stephen@scaffidi.net>
  • Alexander Hartmaier <abraxxa@cpan.org>
  • Mike Doherty <doherty@cs.dal.ca>

look at that lineup. absolute icons, every single one πŸ₯ΉπŸ’–


This software is copyright (c) 2009 by Jerome Quelin.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. slay πŸ’…


and that's the whole page, bestie!! this one's from perl v5.40.1, dated 2025-10-18, and the manual name is Dist::...:Critic(3pm) in case you were wondering why the title looks like that πŸŽ€ πŸ’–

πŸ“¦ where this page comes from