Perl::...Profile(3pm)

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

💅 Perl::Critic::UserProfile

okay bestie, so this page is from the Perl::Critic docs (the "User Contributed Perl Documentation" crew, iykyk), and it's all about Perl::Critic::UserProfile — literally the contents of your user's profile ✨

✨ NAME ✨

Perl::Critic::UserProfile — the contents of the user's profile, which is often .perlcriticrc 🎀

🌸 DESCRIPTION 🌸

Bestie, this is a helper class. That's it. That's the whole vibe. It encapsulates the contents of the user's profile, which is usually stored in a .perlcriticrc file. 🦋

No user-serviceable parts here. Like, none. Don't go poking around in there, gorgeous, there's nothing for you 💀

🚧 INTERFACE SUPPORT 🚧

Okay so listen — this one is considered to be a non-public class. Its interface is subject to change without notice. So if you build your whole personality on it, that's on you, not me 🙈 The main character energy here is "I might change my mind," and honestly? Respect.

🛠️ CONSTRUCTOR 🛠️

new( -profile => $p )

-profile is the path to the user's profile. 💖

If -profile is not defined, then it looks for the profile at ./.perlcriticrc and then $HOME/.perlcriticrc. If neither of those files exists, then the UserProfile is created with default values. slay, defaults are valid ✨

Heads up bestie: this object does not take into account any command-line overrides. Perl::Critic::Config does that. Different class, different job, don't @ me 👑

🌈 METHODS 🌈

  • options_processor() — Returns the Perl::Critic::OptionsProcessor object for this UserProfile. It's giving "here's your processor, you're welcome" 🫶
  • policy_is_disabled( $policy ) — You give it a reference to a Perl::Critic::Policy object or the name of one, and it returns true if the user has disabled that policy in their profile. no cap, that simple 💅
  • policy_is_enabled( $policy ) — Same deal: give it a reference to a Perl::Critic::Policy object or the name of one, and it returns true if the user has explicitly enabled that policy in their user profile. Explicitly, bestie. Like, they said it out loud 🔥
  • policy_params( $policy ) — Give it a reference to a Perl::Critic::Policy object or the name of one, and it returns a Perl::Critic::PolicyConfig for the user's configuration parameters for that policy. Fancy little config object, iconic 💜
  • raw_policy_params( $policy ) — Same input situation (a reference to a Perl::Critic::Policy object or the name of one), but this one returns a reference to a hash of the user's configuration parameters for that policy. Raw. Unfiltered. Just how I like it 🍓
  • listed_policies() — Returns a list of the names of all the Policies that are mentioned in the profile. The Policy names will be fully qualified (e.g. Perl::Critic::Foo). Full names only, no nicknames, periodt 👑
  • source() — The place where the profile information came from, if available. Usually the path to a .perlcriticrc. Detective work, but make it cute 🧚

👀 SEE ALSO 👀

  • Perl::Critic::Config
  • Perl::Critic::OptionsProcessor

Go read those too, bestie, they're literally right there 🌸

✍️ AUTHOR ✍️

Jeffrey Ryan Thalhammer <jeff@imaginative-software.com> — legend behavior, honestly 👑

Copyright (c) 2005-2023 Imaginative Software Systems. 💖

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

okay that's the whole page, mwah 💋 — this was Perl::Critic::UserProfile, from the perl v5.42.0 docs, dated 2024-10-23. Go forth and configure your policies, you gorgeous thing 🦋✨

📦 where this page comes from