Perl::...totype(3pm)

πŸ’– NAME πŸ’–

okay so you're on the Perl::...totype(3pm) page β€” brought to you by User Contributed Perl Documentation β€” and the actual star of the show is Perl::Critic::ProfilePrototype: Generate an initial Perl::Critic profile. bestie, it's giving β€œstarter config energy” ✨


🌸 DESCRIPTION 🌸

This is a helper class that generates a prototype of a Perl::Critic profile (e.g. a .perlcriticrc file). There are no user-serviceable parts here. so don't go poking around expecting knobs to turn, okay? πŸ’…


πŸ›‘οΈ INTERFACE SUPPORT πŸ›‘οΈ

This is considered to be a non-public class. Its interface is subject to change without notice. so like… don't get too attached to it staying exactly the same, fr fr 😭


πŸ› οΈ CONSTRUCTOR πŸ› οΈ

πŸŽ€ new( -policies => \@POLICY_OBJECTS )

Returns a reference to a new Perl::Critic::ProfilePrototype object. that's the whole job β€” cute, simple, iconic πŸ‘‘


✨ METHODS ✨

to_string()

Returns a string representation of this ProfilePrototype. See OVERLOADS for more information. yes bestie, the method and the overload are lowkey besties 🫢


πŸ” OVERLOADS πŸ”

When a Perl::Critic::ProfilePrototype is evaluated in string context, it produces a multi-line summary of the policy name, default themes, and default severity for each Perl::Critic::Policy object that was given to the constructor of this ProfilePrototype. If the Policy supports an additional parameters, they will also be listed (but commented-out). The format is suitable for use as a .perlcriticrc file. so it's literally doing the config-drafting thing for you 🌈


πŸ‘‘ AUTHOR πŸ‘‘

Jeffrey Ryan Thalhammer <jeff@imaginative-software.com> πŸ’Œ


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. periodt πŸ’‹


mwah, that's the whole page bestie β€” Perl::...totype(3pm), source/version perl v5.42.0, dated 2024-10-23, from User Contributed Perl Documentation. slay and goodbye πŸ’–βœ¨

πŸ“¦ where this page comes from