Perl-Critic

Documentation

TODO

Things for Perl::Critic developers to do

perlcritic

Command-line interface to critique Perl source

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

Find and load Perl::Critic user-preferences

Perl::Critic::Defaults

Manage default settings for Perl::Critic

Perl::Critic::Document

Caching wrapper around PPI::Document

Perl::Critic::Policy

Base class for all Policy modules

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::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::ProhibitPostfixControls

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

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

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

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::ProhibitInteractiveTest

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

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

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

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

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::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::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::ProhibitSubroutinePrototypes

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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::ProhibitPunctuationVars

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

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

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

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

Perl::Critic::PolicyFactory

Instantiate Policy objects

Perl::Critic::TestUtils

Utility functions for testing new Policies

Perl::Critic::Theme

Construct thematic sets of policies

Perl::Critic::UserProfile

Interface to the user's profile

Perl::Critic::Utils

Utility subs and vars for Perl::Critic

Perl::Critic::Violation

Represents policy violations

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

Other files

Module Install Instructions