-
-
24 Mar 2021 03:09:35 UTC
- Distribution: Perl-Critic
- Module version: 1.140
- Source (raw)
- Browse (raw)
- Changes
- Homepage
- How to Contribute
- Repository
- Issues
- Testers (2874 / 5 / 1)
- Kwalitee
Bus factor: 2- 90.11% Coverage
- License: perl_5
- Perl: v5.6.1
- Activity
24 month- Tools
- Download (635.2KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
and 1 contributors-
Jeffrey Thalhammer
- Dependencies
- B::Keywords
- Carp
- Config::Tiny
- English
- Exception::Class
- Exporter
- Fatal
- File::Basename
- File::Find
- File::Path
- File::Spec
- File::Spec::Unix
- File::Temp
- File::Which
- Getopt::Long
- IO::String
- IPC::Open2
- List::MoreUtils
- List::Util
- Module::Build
- Module::Pluggable
- PPI
- PPI::Document
- PPI::Document::File
- PPI::Node
- PPI::Token::Quote::Single
- PPI::Token::Whitespace
- PPIx::QuoteLike
- PPIx::Regexp
- PPIx::Regexp::Util
- PPIx::Utilities::Node
- PPIx::Utilities::Statement
- Perl::Tidy
- Pod::Parser
- Pod::PlainText
- Pod::Select
- Pod::Spell
- Pod::Usage
- Readonly
- Scalar::Util
- String::Format
- Task::Weaken
- Term::ANSIColor
- Test::Builder
- Text::ParseWords
- base
- charnames
- overload
- strict
- version
- warnings
- and possibly others
- Reverse dependencies
- CPAN Testers List
- Dependency graph
NAME
Perl::Critic::PolicyParameter - Metadata about a parameter for a Policy.
DESCRIPTION
A provider of validation and parsing of parameter values and metadata about the parameter.
INTERFACE SUPPORT
This is considered to be a public class. Any changes to its interface will go through a deprecation cycle.
METHODS
get_name()
-
Return the name of the parameter. This is the key that will be looked for in the .perlcriticrc.
get_description()
-
Return an explanation of the significance of the parameter, as provided by the developer of the policy.
get_default_string()
-
Return a representation of the default value of this parameter as it would appear if it was specified in a .perlcriticrc file.
parse_and_validate_config_value( $parser, $config )
-
Extract the configuration value for this parameter from the overall configuration and initialize the policy based upon it.
generate_full_description()
-
Produce a more complete explanation of the significance of this parameter than the value returned by
get_description()
.If no description can be derived, returns the empty string.
Note that the result may contain multiple lines.
to_formatted_string( $format )
-
Generate a string representation of this parameter, based upon the format.
The format is a combination of literal and escape characters similar to the way
sprintf
works. If you want to know the specific formatting capabilities, look at String::Format. Valid escape characters are:
SEE ALSO
"MAKING YOUR POLICY CONFIGURABLE" in Perl::Critic::DEVELOPER
AUTHOR
Elliot Shank <perl@galumph.com>
COPYRIGHT
Copyright (c) 2006-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.
Module Install Instructions
To install Perl::Critic, copy and paste the appropriate command in to your terminal.
cpanm Perl::Critic
perl -MCPAN -e shell install Perl::Critic
For more information on module installation, please visit the detailed CPAN module installation guide.