Perl::...Option(3pm)

📦
version 1.156.0 · 12 versions
, in opensuse-leap 16.0

💅 NAME 💅

okay so welcome to the Perl::...Option(3pm) page, bestie — it's part of the User Contributed Perl Documentation, and it's all about Perl::Critic::Exception::Configuration::Option — A problem with an option in the Perl::Critic configuration. Yes the name is long, she ate, no notes 💅.

🦋 DESCRIPTION 🦋

This class is a whole representation of a problem found with an option in the configuration of Perl::Critic — whether it came from a .perlcriticrc, another profile file, or the command line. It's giving config drama, but organized ✨.

This is an abstract class. It should never be instantiated — like, do not try to make one, bestie, that's not the vibe, periodt 🚫.

👑 INTERFACE SUPPORT 👑

This is considered to be a public class. Any changes to its interface will go through a deprecation cycle. So yes, the API has main character energy and gets a proper heads-up before anything shifts 👑.

✨ METHODS ✨

  • option_name() — the name of the option that was found to be in error. It's literally telling you which option is acting up 🫶.
  • option_value() — the value of the option that was found to be in error. So you get the messy value too.
  • message_suffix() — any text that should be applied to end of the standard message for this kind of exception. Little ending garnish, basically 🎀.
  • message() and error() — both overridden to call full_message(). I.e. any message string in the superclass is ignored. Superclass message? Never heard of her 💀.
  • full_message() — overridden to turn it into an abstract method to force subclasses to implement it. Yep, the subclasses have to do the work, no cap.

🌈 SEE ALSO 🌈

  • Perl::Critic::Exception::Configuration::Option::Global
  • Perl::Critic::Exception::Configuration::Option::Policy

🎀 AUTHOR 🎀

Elliot Shank <perl@galumph.com> — icon, legend, the moment 💖.

Copyright (c) 2007-2011 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 the whole page, bestie — from perl v5.42.0, dated 2024-10-23, and the manual name is Perl::...Option(3pm) 🫶💖

📦 where this page comes from