Perl::Critic::PolicyConfig - Configuration data for a Policy.
A container for the configuration of a Policy.
This is considered to be a non-public class. Its interface is subject to change without notice.
get_policy_short_name()
The name of the policy this configuration is for. Primarily here for the sake of debugging.
get_set_themes()
The value of set_themes in the user's .perlcriticrc.
set_themes
get_add_themes()
The value of add_themes in the user's .perlcriticrc.
add_themes
get_severity()
The value of severity in the user's .perlcriticrc.
severity
is_maximum_violations_per_document_unlimited()
Answer whether the value of maximum_violations_per_document should be considered to be unlimited.
maximum_violations_per_document
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()
Answer 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.
"MAKING YOUR POLICY CONFIGURABLE" in Perl::Critic::DEVELOPER
Elliot Shank <perl@galumph.com>
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.
To install Perl::Critic, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Perl::Critic
CPAN shell
perl -MCPAN -e shell install Perl::Critic
For more information on module installation, please visit the detailed CPAN module installation guide.