-
-
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::UserProfile - The contents of the user's profile, often .perlcriticrc.
DESCRIPTION
This is a helper class that encapsulates the contents of the user's profile, which is usually stored in a .perlcriticrc file. There are no user-serviceable parts here.
INTERFACE SUPPORT
This is considered to be a non-public class. Its interface is subject to change without notice.
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.
This object does not take into account any command-line overrides; Perl::Critic::Config does that.
METHODS
options_processor()
-
Returns the Perl::Critic::OptionsProcessor object for this UserProfile.
policy_is_disabled( $policy )
-
Given a reference to a Perl::Critic::Policy object or the name of one, returns true if the user has disabled that policy in their profile.
policy_is_enabled( $policy )
-
Given a reference to a Perl::Critic::Policy object or the name of one, returns true if the user has explicitly enabled that policy in their user profile.
policy_params( $policy )
-
Given a reference to a Perl::Critic::Policy object or the name of one, returns a Perl::Critic::PolicyConfig for the user's configuration parameters for that policy.
raw_policy_params( $policy )
-
Given a reference to a Perl::Critic::Policy object or the name of one, returns a reference to a hash of the user's configuration parameters for that policy.
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).
source()
-
The place where the profile information came from, if available. Usually the path to a .perlcriticrc.
SEE ALSO
Perl::Critic::Config, Perl::Critic::OptionsProcessor
AUTHOR
Jeffrey Ryan Thalhammer <jeff@imaginative-software.com>
COPYRIGHT
Copyright (c) 2005-2011 Imaginative Software Systems. All rights reserved.
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.