Perl::...Config(3pm)

💖 Perl::...Config(3pm) 💖

okay so bestie, this page comes from User Contributed Perl Documentation and it's all about Perl::Critic::PolicyConfig — the tiny config container for a Policy. 🫶 No cap, every detail is below.

🌸 NAME 🌸

Perl::Critic::PolicyConfig — Configuration data for a Policy. periodt. 💅

🦋 DESCRIPTION 🦋

It's literally a container for the configuration of a Policy. That's the whole vibe. ✨

🧚 INTERFACE SUPPORT 🧚

Real talk: this is considered to be a non-public class. Its interface is subject to change without notice. 👀 So like, peek if you must, but don't act surprised when it shifts.

🔥 METHODS 🔥

🎀 get_policy_short_name()

The name of the policy this configuration is for. It's primarily here for the sake of debugging. 💅

🎀 get_set_themes()

The value of "set_themes" in the user's .perlcriticrc. 🫶

🎀 get_add_themes()

The value of "add_themes" in the user's .perlcriticrc. 🫶

🎀 get_severity()

The value of "severity" in the user's .perlcriticrc. 🫶

🎀 is_maximum_violations_per_document_unlimited()

Answers whether the value of "maximum_violations_per_document" should be considered to be unlimited. 😌

🎀 get_maximum_violations_per_document()

The value of "maximum_violations_per_document" in the user's .perlcriticrc. 🔢

🎀 get($parameter)

Retrieve the value of the specified $parameter in the user's .perlcriticrc. 🫶

🎀 remove($parameter)

Delete the value of the specified $parameter. 🧹

🎀 is_empty()

Answers whether there is any non-standard configuration information left. 👀

🎀 get_parameter_names()

Retrieve the names of the parameters in this object. 🏷️

🎀 set_profile_strictness($profile_strictness)

Sets the profile strictness associated with the configuration. 🎚️

🎀 handle_extra_parameters($policy,$errors)

Deals with any extra parameters according to the profile_strictness setting. To be called by Perl::Critic::Policy->new() once all valid policies have been processed and removed from the configuration. 🧼

• If profile_strictness is $PROFILE_STRICTNESS_QUIET, extra policy parameters are ignored. 🤫
• If profile_strictness is $PROFILE_STRICTNESS_WARN, extra policy parameters generate a warning. ⚠️
• If profile_strictness is $PROFILE_STRICTNESS_FATAL, extra policy parameters generate a fatal error. 💀
• If no profile_strictness was set, the behavior is that specified by $PROFILE_STRICTNESS_DEFAULT. 🧬

🌈 SEE ALSO 🌈

• "MAKING YOUR POLICY CONFIGURABLE" in Perl::Critic::DEVELOPER

👑 AUTHOR 👑

Elliot Shank <perl@galumph.com> — iconic. 💜

🎀 COPYRIGHT 🎀

Copyright (c) 2008-2023 Elliot Shank. 🫶

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. 📜

---

💌 That's a wrap, bestie! This page lives under User Contributed Perl Documentation for perl v5.42.0, dated 2024-10-23, and the title is Perl::...Config(3pm). Slay. 🎀