Perl-Critic

Documentation

Perl::Critic::TODO

Things for Perl::Critic developers to do

perlcritic

Command-line interface to critique Perl source

KomodoIntegration

Integrating perlcritic and Komodo

Perl::Critic::DEVELOPER

How to make new Perl::Critic::Policy modules

Perl::Critic::PolicySummary

Description of the bundled Policy modules

Modules

Perl::Critic

Critique Perl source code for best-practices

Perl::Critic::Config

The Perl::Critic user-preferences, combined from any profile file and command-line parameters.

Perl::Critic::ConfigErrors

An exception object collecting a set of problems found by Perl::Critic::Config.

Perl::Critic::Defaults

The global configuration default values.

Perl::Critic::Document

Caching wrapper around PPI::Document

Perl::Critic::Exception

A problem identified by Perl::Critic

Perl::Critic::Exception::AggregateConfiguration

A collection of a set of problems found in the configuration and/or command-line options.

Perl::Critic::Exception::Configuration

A problem with Perl::Critic configuration

Perl::Critic::Exception::Configuration::Generic

A problem with Perl::Critic configuration that doesn't involve an option

Perl::Critic::Exception::Configuration::Option

A problem with an option in the Perl::Critic configuration

Perl::Critic::Exception::Configuration::Option::Global

A problem with Perl::Critic global configuration

Perl::Critic::Exception::Configuration::Option::Global::ExtraParameter

The configuration referred to a non-existent global option.

Perl::Critic::Exception::Configuration::Option::Global::ParameterValue

A problem with the value of a global parameter

Perl::Critic::Exception::Configuration::Option::Policy

A problem with configuration of a policy

Perl::Critic::Exception::Configuration::Option::Policy::ExtraParameter

The configuration referred to a non-existent parameter for a policy.

Perl::Critic::Exception::Configuration::Option::Policy::ParameterValue

A problem with the value of a parameter for a policy

Perl::Critic::Exception::Fatal

A problem that should cause Perl::Critic to stop running

Perl::Critic::Exception::Fatal::Generic

A problem for which there is no specialized information

Perl::Critic::Exception::Fatal::Internal

A problem with the Perl::Critic implementation, i.e. a bug

Perl::Critic::Exception::Fatal::PolicyDefinition

A bug in a policy

Perl::Critic::Policy

Base class for all Policy modules

Perl::Critic::Policy::BuiltinFunctions::ProhibitBooleanGrep

Perl::Critic::Policy::BuiltinFunctions::ProhibitComplexMappings

Perl::Critic::Policy::BuiltinFunctions::ProhibitLvalueSubstr

Perl::Critic::Policy::BuiltinFunctions::ProhibitReverseSortBlock

Perl::Critic::Policy::BuiltinFunctions::ProhibitSleepViaSelect

Perl::Critic::Policy::BuiltinFunctions::ProhibitStringyEval

Perl::Critic::Policy::BuiltinFunctions::ProhibitStringySplit

Perl::Critic::Policy::BuiltinFunctions::ProhibitUniversalCan

Perl::Critic::Policy::BuiltinFunctions::ProhibitUniversalIsa

Perl::Critic::Policy::BuiltinFunctions::ProhibitVoidGrep

Perl::Critic::Policy::BuiltinFunctions::ProhibitVoidMap

Perl::Critic::Policy::BuiltinFunctions::RequireBlockGrep

Perl::Critic::Policy::BuiltinFunctions::RequireBlockMap

Perl::Critic::Policy::BuiltinFunctions::RequireGlobFunction

Perl::Critic::Policy::BuiltinFunctions::RequireSimpleSortBlock

Perl::Critic::Policy::ClassHierarchies::ProhibitAutoloading

Perl::Critic::Policy::ClassHierarchies::ProhibitExplicitISA

Perl::Critic::Policy::ClassHierarchies::ProhibitOneArgBless

Perl::Critic::Policy::CodeLayout::ProhibitHardTabs

Perl::Critic::Policy::CodeLayout::ProhibitParensWithBuiltins

Perl::Critic::Policy::CodeLayout::ProhibitQuotedWordLists

Perl::Critic::Policy::CodeLayout::ProhibitTrailingWhitespace

Perl::Critic::Policy::CodeLayout::RequireConsistentNewlines

Perl::Critic::Policy::CodeLayout::RequireTidyCode

Perl::Critic::Policy::CodeLayout::RequireTrailingCommas

Perl::Critic::Policy::ControlStructures::ProhibitCStyleForLoops

Perl::Critic::Policy::ControlStructures::ProhibitCascadingIfElse

Perl::Critic::Policy::ControlStructures::ProhibitDeepNests

Perl::Critic::Policy::ControlStructures::ProhibitMutatingListFunctions

Perl::Critic::Policy::ControlStructures::ProhibitNegativeExpressionsInUnlessAndUntilConditions

Perl::Critic::Policy::ControlStructures::ProhibitPostfixControls

Perl::Critic::Policy::ControlStructures::ProhibitUnlessBlocks

Perl::Critic::Policy::ControlStructures::ProhibitUnreachableCode

Perl::Critic::Policy::ControlStructures::ProhibitUntilBlocks

Perl::Critic::Policy::Documentation::PodSpelling

Perl::Critic::Policy::Documentation::RequirePodAtEnd

Perl::Critic::Policy::Documentation::RequirePodSections

Perl::Critic::Policy::ErrorHandling::RequireCarping

Perl::Critic::Policy::InputOutput::ProhibitBacktickOperators

Perl::Critic::Policy::InputOutput::ProhibitBarewordFileHandles

Perl::Critic::Policy::InputOutput::ProhibitExplicitStdin

Perl::Critic::Policy::InputOutput::ProhibitInteractiveTest

Perl::Critic::Policy::InputOutput::ProhibitJoinedReadline

Perl::Critic::Policy::InputOutput::ProhibitOneArgSelect

Perl::Critic::Policy::InputOutput::ProhibitReadlineInForLoop

Perl::Critic::Policy::InputOutput::ProhibitTwoArgOpen

Perl::Critic::Policy::InputOutput::RequireBracedFileHandleWithPrint

Perl::Critic::Policy::InputOutput::RequireBriefOpen

Perl::Critic::Policy::InputOutput::RequireCheckedClose

Perl::Critic::Policy::InputOutput::RequireCheckedOpen

Perl::Critic::Policy::InputOutput::RequireCheckedSyscalls

Perl::Critic::Policy::Miscellanea::ProhibitFormats

Perl::Critic::Policy::Miscellanea::ProhibitTies

Perl::Critic::Policy::Miscellanea::RequireRcsKeywords

Perl::Critic::Policy::Modules::ProhibitAutomaticExportation

Perl::Critic::Policy::Modules::ProhibitEvilModules

Perl::Critic::Policy::Modules::ProhibitExcessMainComplexity

Perl::Critic::Policy::Modules::ProhibitMultiplePackages

Perl::Critic::Policy::Modules::RequireBarewordIncludes

Perl::Critic::Policy::Modules::RequireEndWithOne

Perl::Critic::Policy::Modules::RequireExplicitPackage

Perl::Critic::Policy::Modules::RequireFilenameMatchesPackage

Perl::Critic::Policy::Modules::RequireVersionVar

Perl::Critic::Policy::NamingConventions::ProhibitAmbiguousNames

Perl::Critic::Policy::NamingConventions::ProhibitMixedCaseSubs

Perl::Critic::Policy::NamingConventions::ProhibitMixedCaseVars

Perl::Critic::Policy::References::ProhibitDoubleSigils

Perl::Critic::Policy::RegularExpressions::ProhibitCaptureWithoutTest

Perl::Critic::Policy::RegularExpressions::ProhibitComplexRegexes

Perl::Critic::Policy::RegularExpressions::ProhibitEnumeratedClasses

Perl::Critic::Policy::RegularExpressions::ProhibitEscapedMetacharacters

Perl::Critic::Policy::RegularExpressions::ProhibitFixedStringMatches

Perl::Critic::Policy::RegularExpressions::ProhibitSingleCharAlternation

Perl::Critic::Policy::RegularExpressions::ProhibitUnusedCapture

Perl::Critic::Policy::RegularExpressions::ProhibitUnusualDelimiters

Perl::Critic::Policy::RegularExpressions::RequireBracesForMultiline

Perl::Critic::Policy::RegularExpressions::RequireExtendedFormatting

Perl::Critic::Policy::RegularExpressions::RequireLineBoundaryMatching

Perl::Critic::Policy::Subroutines::ProhibitAmpersandSigils

Perl::Critic::Policy::Subroutines::ProhibitBuiltinHomonyms

Perl::Critic::Policy::Subroutines::ProhibitExcessComplexity

Perl::Critic::Policy::Subroutines::ProhibitExplicitReturnUndef

Perl::Critic::Policy::Subroutines::ProhibitManyArgs

Perl::Critic::Policy::Subroutines::ProhibitNestedSubs

Perl::Critic::Policy::Subroutines::ProhibitSubroutinePrototypes

Perl::Critic::Policy::Subroutines::ProtectPrivateSubs

Perl::Critic::Policy::Subroutines::RequireArgUnpacking

Perl::Critic::Policy::Subroutines::RequireFinalReturn

Perl::Critic::Policy::TestingAndDebugging::ProhibitNoStrict

Perl::Critic::Policy::TestingAndDebugging::ProhibitNoWarnings

Perl::Critic::Policy::TestingAndDebugging::ProhibitProlongedStrictureOverride

Perl::Critic::Policy::TestingAndDebugging::RequireTestLabels

Perl::Critic::Policy::TestingAndDebugging::RequireUseStrict

Perl::Critic::Policy::TestingAndDebugging::RequireUseWarnings

Perl::Critic::Policy::ValuesAndExpressions::ProhibitCommaSeparatedStatements

Perl::Critic::Policy::ValuesAndExpressions::ProhibitConstantPragma

Perl::Critic::Policy::ValuesAndExpressions::ProhibitEmptyQuotes

Perl::Critic::Policy::ValuesAndExpressions::ProhibitEscapedCharacters

Perl::Critic::Policy::ValuesAndExpressions::ProhibitImplicitNewlines

Perl::Critic::Policy::ValuesAndExpressions::ProhibitInterpolationOfLiterals

Perl::Critic::Policy::ValuesAndExpressions::ProhibitLeadingZeros

Perl::Critic::Policy::ValuesAndExpressions::ProhibitLongChainsOfMethodCalls

Perl::Critic::Policy::ValuesAndExpressions::ProhibitMismatchedOperators

Perl::Critic::Policy::ValuesAndExpressions::ProhibitMixedBooleanOperators

Perl::Critic::Policy::ValuesAndExpressions::ProhibitNoisyQuotes

Perl::Critic::Policy::ValuesAndExpressions::ProhibitQuotesAsQuotelikeOperatorDelimiters

Perl::Critic::Policy::ValuesAndExpressions::ProhibitVersionStrings

Perl::Critic::Policy::ValuesAndExpressions::RequireInterpolationOfMetachars

Perl::Critic::Policy::ValuesAndExpressions::RequireNumberSeparators

Perl::Critic::Policy::ValuesAndExpressions::RequireQuotedHeredocTerminator

Perl::Critic::Policy::ValuesAndExpressions::RequireUpperCaseHeredocTerminator

Perl::Critic::Policy::Variables::ProhibitConditionalDeclarations

Perl::Critic::Policy::Variables::ProhibitLocalVars

Perl::Critic::Policy::Variables::ProhibitMatchVars

Perl::Critic::Policy::Variables::ProhibitPackageVars

Perl::Critic::Policy::Variables::ProhibitPerl4PackageNames

Perl::Critic::Policy::Variables::ProhibitPunctuationVars

Perl::Critic::Policy::Variables::ProtectPrivateVars

Perl::Critic::Policy::Variables::RequireInitializationForLocalVars

Perl::Critic::Policy::Variables::RequireLexicalLoopIterators

Perl::Critic::Policy::Variables::RequireLocalizedPunctuationVars

Perl::Critic::Policy::Variables::RequireNegativeIndices

Perl::Critic::PolicyFactory

Instantiate Policy objects

Perl::Critic::PolicyListing

Display information about Policies

Perl::Critic::ProfilePrototype

Generate a Perl::Critic profile

Perl::Critic::Statistics

Compile stats on Perl::Critic violations

Perl::Critic::TestUtils

Utility functions for testing new Policies

Perl::Critic::Theme

Construct thematic sets of policies

Perl::Critic::UserProfile

The contents of the user's profile, often .perlcriticrc.

Perl::Critic::Utils

Utility subs and vars for Perl::Critic

Perl::Critic::Utils::Constants

Global constants

Perl::Critic::Utils::McCabe

Functions that calculate the McCabe score of source code.

Perl::Critic::Utils::PPI

Utility functions for dealing with PPI objects.

Perl::Critic::Utils::PPIRegexp

Utility functions for dealing with PPI regexp tokens.

Perl::Critic::Violation

Represents policy violations

Examples

Other files

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.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

Documentation

Modules

Examples

Other files

Module Install Instructions