Perl::...idyCode(3pm)

Okay bestie, welcome to the Perl::...idyCode(3pm) page from the User Contributed Perl Documentation ✨ β€” it’s giving β€œPerl::Critic policy with a serious tidy-code agenda,” and honestly, it ate.

πŸŽ€ NAME πŸŽ€

Perl::Critic::Policy::CodeLayout::RequireTidyCode β€” Must run code through perltidy.

That’s the whole vibe check: the policy is Perl::Critic::Policy::CodeLayout::RequireTidyCode, and its one-liner is literally β€œMust run code through perltidy.” 🫢

πŸ¦‹ AFFILIATION πŸ¦‹

This Policy is part of the core Perl::Critic distribution. So it’s not some random side-quest add-on; it’s built into the main fam πŸ’….

🌸 DESCRIPTION 🌸

Okay so Conway does make specific recommendations for whitespace and curly-braces in your code, but the most important thing is to adopt a consistent layout, regardless of the specifics. And the easiest way to do that is to use Perl::Tidy. This policy will complain if your code hasn’t been run through Perl::Tidy. Periodt πŸ’–

✨ CONFIGURATION ✨

This policy can be configured to tell Perl::Tidy to use a particular perltidyrc file or no configuration at all. By default, Perl::Tidy is told to look in its default location for configuration. Perl::Critic can be told to tell Perl::Tidy to use a specific configuration file by putting an entry in a .perlcriticrc file like this:

[CodeLayout::RequireTidyCode]
perltidyrc = /usr/share/perltidy.conf

As a special case, setting "perltidyrc" to the empty string tells Perl::Tidy not to load any configuration file at all and just use Perl::Tidy’s own default style.

[CodeLayout::RequireTidyCode]
perltidyrc =

πŸ”₯ SEE ALSO πŸ”₯

  • Perl::Tidy β€” the one and only SEE ALSO bestie here.

πŸ‘‘ AUTHOR πŸ‘‘

Written by Jeffrey Ryan Thalhammer <jeff@imaginative-software.com> πŸ’œ

Copyright (c) 2005-2011 Imaginative Software Systems. All rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of this license can be found in the LICENSE file included with this module.


This was Perl::...idyCode(3pm) from the User Contributed Perl Documentation, brought to you by perl v5.42.0 and dated 2024-10-23. Bye bestie, stay tidy πŸ’…βœ¨

πŸ“¦ where this page comes from