Perl-Critic documentation

• Perl-Critic - README
• Perl-Critic - Changes
• Perl-Critic - INSTALL
• Perl-Critic - META.yml
• Perl-Critic Build.PL
• Perl-Critic Makefile.PL
• Perl::Critic - Critique Perl source code for best-practices.  [view source]
• Perl::Critic::Annotation - A "## no critic" annotation in a document.  [view source]
• Perl::Critic::Command - Guts of L.  [view source]
• Perl::Critic::Config - The final derived Perl::Critic configuration, combined from any profile file and command-line parameters.  [view source]
• Perl::Critic::CORE_DEVELOPER - Hints for working on the Perl::Critic core.  [view source]
• Perl::Critic::DEVELOPER - How to make new Perl::Critic::Policy modules.  [view source]
• Perl::Critic::Document - Caching wrapper around a PPI::Document.  [view source]
• Perl::Critic::Exception - A problem identified by L.  [view source]
• Perl::Critic::Exception::AggregateConfiguration - A collection of a set of problems found in the configuration and/or command-line options.  [view source]
• Perl::Critic::Exception::Configuration - A problem with L configuration.  [view source]
• Perl::Critic::Exception::Configuration::Generic - A problem with L configuration that doesn't involve an option.  [view source]
• Perl::Critic::Exception::Configuration::NonExistentPolicy - The configuration referred to a non-existent policy.  [view source]
• Perl::Critic::Exception::Configuration::Option - A problem with an option in the L configuration.  [view source]
• Perl::Critic::Exception::Configuration::Option::Global - A problem with L global configuration.  [view source]
• Perl::Critic::Exception::Configuration::Option::Global::ExtraParameter - The configuration referred to a non-existent global option.  [view source]
• Perl::Critic::Exception::Configuration::Option::Global::ParameterValue - A problem with the value of a global parameter.  [view source]
• Perl::Critic::Exception::Configuration::Option::Policy - A problem with configuration of a policy.  [view source]
• Perl::Critic::Exception::Configuration::Option::Policy::ExtraParameter - The configuration referred to a non-existent parameter for a policy.  [view source]
• Perl::Critic::Exception::Configuration::Option::Policy::ParameterValue - A problem with the value of a parameter for a policy.  [view source]
• Perl::Critic::Exception::Fatal - A problem that should cause L to stop running.  [view source]
• Perl::Critic::Exception::Fatal::Generic - A problem for which there is no specialized information.  [view source]
• Perl::Critic::Exception::Fatal::Internal - A problem with the L implementation, i.e. a bug.  [view source]
• Perl::Critic::Exception::Fatal::PolicyDefinition - A bug in a policy.  [view source]
• Perl::Critic::Exception::IO - A problem with input or output.  [view source]
• Perl::Critic::Exception::Parse - The code doesn't look like code.  [view source]
• Perl::Critic::OptionsProcessor - The global configuration default values, combined with command-line values.  [view source]
• Perl::Critic::Policy - Base class for all Policy modules.  [view source]
• Perl::Critic::Policy::BuiltinFunctions::ProhibitBooleanGrep - Use C instead of C in boolean context.  [view source]
• Perl::Critic::Policy::BuiltinFunctions::ProhibitComplexMappings - Map blocks should have a single statement.  [view source]
• Perl::Critic::Policy::BuiltinFunctions::ProhibitLvalueSubstr - Use 4-argument C instead of writing C.  [view source]
• Perl::Critic::Policy::BuiltinFunctions::ProhibitReverseSortBlock - Forbid $b before $a in sort blocks.  [view source]
• Perl::Critic::Policy::BuiltinFunctions::ProhibitSleepViaSelect - Use L instead of something like C.  [view source]
• Perl::Critic::Policy::BuiltinFunctions::ProhibitStringyEval - Write C instead of C.  [view source]
• Perl::Critic::Policy::BuiltinFunctions::ProhibitStringySplit - Write C instead of C.  [view source]
• Perl::Critic::Policy::BuiltinFunctions::ProhibitUniversalCan - Write C<< eval { $foo->can($name) } >> instead of C.  [view source]
• Perl::Critic::Policy::BuiltinFunctions::ProhibitUniversalIsa - Write C<< eval { $foo->isa($pkg) } >> instead of C.  [view source]
• Perl::Critic::Policy::BuiltinFunctions::ProhibitVoidGrep - Don't use C in void contexts.  [view source]
• Perl::Critic::Policy::BuiltinFunctions::ProhibitVoidMap - Don't use C  [view source]
• Perl::Critic::Policy::BuiltinFunctions::RequireBlockGrep - Write C instead of C.  [view source]
• Perl::Critic::Policy::BuiltinFunctions::RequireBlockMap - Write C  [view source]
• Perl::Critic::Policy::BuiltinFunctions::RequireGlobFunction - Use C instead of <*>.  [view source]
• Perl::Critic::Policy::BuiltinFunctions::RequireSimpleSortBlock - Sort blocks should have a single statement.  [view source]
• Perl::Critic::Policy::ClassHierarchies::ProhibitAutoloading - AUTOLOAD methods should be avoided.  [view source]
• Perl::Critic::Policy::ClassHierarchies::ProhibitExplicitISA - Employ C instead of C<@ISA>.  [view source]
• Perl::Critic::Policy::ClassHierarchies::ProhibitOneArgBless - Write C instead of just C.  [view source]
• Perl::Critic::Policy::CodeLayout::ProhibitHardTabs - Use spaces instead of tabs.  [view source]
• Perl::Critic::Policy::CodeLayout::ProhibitParensWithBuiltins - Write C instead of C.  [view source]
• Perl::Critic::Policy::CodeLayout::ProhibitQuotedWordLists - Write C instead of C<('foo', 'bar', 'baz')>.  [view source]
• Perl::Critic::Policy::CodeLayout::ProhibitTrailingWhitespace - Don't use whitespace at the end of lines.  [view source]
• Perl::Critic::Policy::CodeLayout::RequireConsistentNewlines - Use the same newline through the source.  [view source]
• Perl::Critic::Policy::CodeLayout::RequireTidyCode - Must run code through L.  [view source]
• Perl::Critic::Policy::CodeLayout::RequireTrailingCommas - Put a comma at the end of every multi-line list declaration, including the last one.  [view source]
• Perl::Critic::Policy::ControlStructures::ProhibitCascadingIfElse - Don't write long "if-elsif-elsif-elsif-elsif...else" chains.  [view source]
• Perl::Critic::Policy::ControlStructures::ProhibitCStyleForLoops - Write C instead of C.  [view source]
• Perl::Critic::Policy::ControlStructures::ProhibitDeepNests - Don't write deeply nested loops and conditionals.  [view source]
• Perl::Critic::Policy::ControlStructures::ProhibitLabelsWithSpecialBlockNames - Don't use labels that are the same as the special block names.  [view source]
• Perl::Critic::Policy::ControlStructures::ProhibitMutatingListFunctions - Don't modify C<$_> in list functions.  [view source]
• Perl::Critic::Policy::ControlStructures::ProhibitNegativeExpressionsInUnlessAndUntilConditions - Don't use operators like C, C, and C within C and C.  [view source]
• Perl::Critic::Policy::ControlStructures::ProhibitPostfixControls - Write C instead of C.  [view source]
• Perl::Critic::Policy::ControlStructures::ProhibitUnlessBlocks - Write C instead of C.  [view source]
• Perl::Critic::Policy::ControlStructures::ProhibitUnreachableCode - Don't write code after an unconditional C.  [view source]
• Perl::Critic::Policy::ControlStructures::ProhibitUntilBlocks - Write C instead of C.  [view source]
• Perl::Critic::Policy::Documentation::PodSpelling - Check your spelling.  [view source]
• Perl::Critic::Policy::Documentation::RequirePackageMatchesPodName - The C<=head1 NAME> section should match the package.  [view source]
• Perl::Critic::Policy::Documentation::RequirePodAtEnd - All POD should be after C<__END__>.  [view source]
• Perl::Critic::Policy::Documentation::RequirePodSections - Organize your POD into the customary sections.  [view source]
• Perl::Critic::Policy::ErrorHandling::RequireCarping - Use functions from L instead of C or C.  [view source]
• Perl::Critic::Policy::ErrorHandling::RequireCheckingReturnValueOfEval - You can't depend upon the value of C<$@>/C<$EVAL_ERROR> to tell whether an C failed.  [view source]
• Perl::Critic::Policy::InputOutput::ProhibitBacktickOperators - Discourage stuff like C<@files = `ls $directory`>.  [view source]
• Perl::Critic::Policy::InputOutput::ProhibitBarewordFileHandles - Write C instead of C.  [view source]
• Perl::Critic::Policy::InputOutput::ProhibitExplicitStdin - Use "<>" or "" or a prompting module instead of "".  [view source]
• Perl::Critic::Policy::InputOutput::ProhibitInteractiveTest - Use prompt() instead of -t.  [view source]
• Perl::Critic::Policy::InputOutput::ProhibitJoinedReadline - Use C or L instead of joined readline.  [view source]
• Perl::Critic::Policy::InputOutput::ProhibitOneArgSelect - Never write C.  [view source]
• Perl::Critic::Policy::InputOutput::ProhibitReadlineInForLoop - Write C<< while( $line = <> ){...} >> instead of C<< for(<>){...} >>.  [view source]
• Perl::Critic::Policy::InputOutput::ProhibitTwoArgOpen - Write C<< open $fh, q{<}, $filename; >> instead of C<< open $fh, "<$filename"; >>.  [view source]
• Perl::Critic::Policy::InputOutput::RequireBracedFileHandleWithPrint - Write C instead of C.  [view source]
• Perl::Critic::Policy::InputOutput::RequireBriefOpen - Close filehandles as soon as possible after opening them.  [view source]
• Perl::Critic::Policy::InputOutput::RequireCheckedClose - Write C<< my $error = close $fh; >> instead of C<< close $fh; >>.  [view source]
• Perl::Critic::Policy::InputOutput::RequireCheckedOpen - Write C<< my $error = open $fh, $mode, $filename; >> instead of C<< open $fh, $mode, $filename; >>.  [view source]
• Perl::Critic::Policy::InputOutput::RequireCheckedSyscalls - Return value of flagged function ignored.  [view source]
• Perl::Critic::Policy::InputOutput::RequireEncodingWithUTF8Layer - Write C<< open $fh, q{<:encoding(UTF-8)}, $filename; >> instead of C<< open $fh, q{{<:utf8}, $filename; >>.  [view source]
• Perl::Critic::Policy::Miscellanea::ProhibitFormats - Do not use C.  [view source]
• Perl::Critic::Policy::Miscellanea::ProhibitTies - Do not use C.  [view source]
• Perl::Critic::Policy::Miscellanea::ProhibitUnrestrictedNoCritic - Forbid a bare C<## no critic>  [view source]
• Perl::Critic::Policy::Miscellanea::ProhibitUselessNoCritic - Remove ineffective "## no critic" annotations.  [view source]
• Perl::Critic::Policy::Miscellanea::RequireRcsKeywords - Put source-control keywords in every file.  [view source]
• Perl::Critic::Policy::Modules::ProhibitAutomaticExportation - Export symbols via C<@EXPORT_OK> or C<%EXPORT_TAGS> instead of C<@EXPORT>.  [view source]
• Perl::Critic::Policy::Modules::ProhibitConditionalUseStatements - Avoid putting conditional logic around compile-time includes.  [view source]
• Perl::Critic::Policy::Modules::ProhibitEvilModules - Ban modules that aren't blessed by your shop.  [view source]
• Perl::Critic::Policy::Modules::ProhibitExcessMainComplexity - Minimize complexity in code that is B of subroutines.  [view source]
• Perl::Critic::Policy::Modules::ProhibitMultiplePackages - Put packages (especially subclasses) in separate files.  [view source]
• Perl::Critic::Policy::Modules::RequireBarewordIncludes - Write C instead of C.  [view source]
• Perl::Critic::Policy::Modules::RequireEndWithOne - End each module with an explicitly C<1;> instead of some funky expression.  [view source]
• Perl::Critic::Policy::Modules::RequireExplicitPackage - Always make the C explicit.  [view source]
• Perl::Critic::Policy::Modules::RequireFilenameMatchesPackage - Package declaration must match filename.  [view source]
• Perl::Critic::Policy::Modules::RequireNoMatchVarsWithUseEnglish - C must be passed a C<-no_match_vars> argument.  [view source]
• Perl::Critic::Policy::Modules::RequireVersionVar - Give every module a C<$VERSION> number.  [view source]
• Perl::Critic::Policy::NamingConventions::Capitalization - Distinguish different program components by case.  [view source]
• Perl::Critic::Policy::NamingConventions::ProhibitAmbiguousNames - Don't use vague variable or subroutine names like 'last' or 'record'.  [view source]
• Perl::Critic::Policy::Objects::ProhibitIndirectSyntax - Prohibit indirect object call syntax.  [view source]
• Perl::Critic::Policy::References::ProhibitDoubleSigils - Write C<@{ $array_ref }> instead of C<@$array_ref>.  [view source]
• Perl::Critic::Policy::RegularExpressions::ProhibitCaptureWithoutTest - Capture variable used outside conditional.  [view source]
• Perl::Critic::Policy::RegularExpressions::ProhibitComplexRegexes - Split long regexps into smaller C chunks.  [view source]
• Perl::Critic::Policy::RegularExpressions::ProhibitEnumeratedClasses - Use named character classes instead of explicit character lists.  [view source]
• Perl::Critic::Policy::RegularExpressions::ProhibitEscapedMetacharacters - Use character classes for literal meta-characters instead of escapes.  [view source]
• Perl::Critic::Policy::RegularExpressions::ProhibitFixedStringMatches - Use C or hash instead of fixed-pattern regexps.  [view source]
• Perl::Critic::Policy::RegularExpressions::ProhibitSingleCharAlternation - Use C<[abc]> instead of C.  [view source]
• Perl::Critic::Policy::RegularExpressions::ProhibitUnusedCapture - Only use a capturing group if you plan to use the captured value.  [view source]
• Perl::Critic::Policy::RegularExpressions::ProhibitUnusualDelimiters - Use only C or C<{}> to delimit regexps.  [view source]
• Perl::Critic::Policy::RegularExpressions::RequireBracesForMultiline - Use C<{> and C<}> to delimit multi-line regexps.  [view source]
• Perl::Critic::Policy::RegularExpressions::RequireDotMatchAnything - Always use the C modifier with regular expressions.  [view source]
• Perl::Critic::Policy::RegularExpressions::RequireExtendedFormatting - Always use the C modifier with regular expressions.  [view source]
• Perl::Critic::Policy::RegularExpressions::RequireLineBoundaryMatching - Always use the C modifier with regular expressions.  [view source]
• Perl::Critic::Policy::Subroutines::ProhibitAmpersandSigils - Don't call functions with a leading ampersand sigil.  [view source]
• Perl::Critic::Policy::Subroutines::ProhibitBuiltinHomonyms - Don't declare your own C function.  [view source]
• Perl::Critic::Policy::Subroutines::ProhibitExcessComplexity - Minimize complexity by factoring code into smaller subroutines.  [view source]
• Perl::Critic::Policy::Subroutines::ProhibitExplicitReturnUndef - Return failure with bare C instead of C.  [view source]
• Perl::Critic::Policy::Subroutines::ProhibitManyArgs - Too many arguments.  [view source]
• Perl::Critic::Policy::Subroutines::ProhibitNestedSubs - C_.  [view source]
• Perl::Critic::Policy::Subroutines::ProhibitReturnSort - Behavior of C is not defined if called in scalar context.  [view source]
• Perl::Critic::Policy::Subroutines::ProhibitSubroutinePrototypes - Don't write C_.  [view source]
• Perl::Critic::Policy::Subroutines::ProhibitUnusedPrivateSubroutines - Prevent unused private subroutines.  [view source]
• Perl::Critic::Policy::Subroutines::ProtectPrivateSubs - Prevent access to private subs in other packages.  [view source]
• Perl::Critic::Policy::Subroutines::RequireArgUnpacking - Always unpack C<@_> first.  [view source]
• Perl::Critic::Policy::Subroutines::RequireFinalReturn - End every path through a subroutine with an explicit C statement.  [view source]
• Perl::Critic::Policy::TestingAndDebugging::ProhibitNoStrict - Prohibit various flavors of C.  [view source]
• Perl::Critic::Policy::TestingAndDebugging::ProhibitNoWarnings - Prohibit various flavors of C.  [view source]
• Perl::Critic::Policy::TestingAndDebugging::ProhibitProlongedStrictureOverride - Don't turn off strict for large blocks of code.  [view source]
• Perl::Critic::Policy::TestingAndDebugging::RequireTestLabels - Tests should all have labels.  [view source]
• Perl::Critic::Policy::TestingAndDebugging::RequireUseStrict - Always C.  [view source]
• Perl::Critic::Policy::TestingAndDebugging::RequireUseWarnings - Always C.  [view source]
• Perl::Critic::Policy::ValuesAndExpressions::ProhibitCommaSeparatedStatements - Don't use the comma operator as a statement separator.  [view source]
• Perl::Critic::Policy::ValuesAndExpressions::ProhibitComplexVersion - Prohibit version values from outside the module.  [view source]
• Perl::Critic::Policy::ValuesAndExpressions::ProhibitConstantPragma - Don't C<< use constant FOO => 15 >>.  [view source]
• Perl::Critic::Policy::ValuesAndExpressions::ProhibitEmptyQuotes - Write C instead of C<''>.  [view source]
• Perl::Critic::Policy::ValuesAndExpressions::ProhibitEscapedCharacters - Write C<"\N{DELETE}"> instead of C<"\x7F">, etc.  [view source]
• Perl::Critic::Policy::ValuesAndExpressions::ProhibitImplicitNewlines - Use concatenation or HEREDOCs instead of literal line breaks in strings.  [view source]
• Perl::Critic::Policy::ValuesAndExpressions::ProhibitInterpolationOfLiterals - Always use single quotes for literal strings.  [view source]
• Perl::Critic::Policy::ValuesAndExpressions::ProhibitLeadingZeros - Write C instead of C<0755>.  [view source]
• Perl::Critic::Policy::ValuesAndExpressions::ProhibitLongChainsOfMethodCalls - Long chains of method calls indicate tightly coupled code.  [view source]
• Perl::Critic::Policy::ValuesAndExpressions::ProhibitMagicNumbers - Don't use values that don't explain themselves.  [view source]
• Perl::Critic::Policy::ValuesAndExpressions::ProhibitMismatchedOperators - Don't mix numeric operators with string operands, or vice-versa.  [view source]
• Perl::Critic::Policy::ValuesAndExpressions::ProhibitMixedBooleanOperators - Write C< !$foo && $bar || $baz > instead of C< not $foo && $bar or $baz>.  [view source]
• Perl::Critic::Policy::ValuesAndExpressions::ProhibitNoisyQuotes - Use C or C instead of quotes for awkward-looking strings.  [view source]
• Perl::Critic::Policy::ValuesAndExpressions::ProhibitQuotesAsQuotelikeOperatorDelimiters - Don't use quotes (C<'>, C<">, C<`>) as delimiters for the quote-like operators.  [view source]
• Perl::Critic::Policy::ValuesAndExpressions::ProhibitSpecialLiteralHeredocTerminator - Don't write C< print <<'__END__' >.  [view source]
• Perl::Critic::Policy::ValuesAndExpressions::ProhibitVersionStrings - Don't use strings like C or C<1.4.5> when including other modules.  [view source]
• Perl::Critic::Policy::ValuesAndExpressions::RequireConstantVersion - Require $VERSION to be a constant rather than a computed value.  [view source]
• Perl::Critic::Policy::ValuesAndExpressions::RequireInterpolationOfMetachars - Warns that you might have used single quotes when you really wanted double-quotes.  [view source]
• Perl::Critic::Policy::ValuesAndExpressions::RequireNumberSeparators - Write C< 141_234_397.0145 > instead of C< 141234397.0145 >.  [view source]
• Perl::Critic::Policy::ValuesAndExpressions::RequireQuotedHeredocTerminator - Write C< print <<'THE_END' > or C< print <<"THE_END" >.  [view source]
• Perl::Critic::Policy::ValuesAndExpressions::RequireUpperCaseHeredocTerminator - Write C< <<'THE_END'; > instead of C< <<'theEnd'; >.  [view source]
• Perl::Critic::Policy::Variables::ProhibitConditionalDeclarations - Do not write C< my $foo = $bar if $baz; >.  [view source]
• Perl::Critic::Policy::Variables::ProhibitEvilVariables - Ban variables that aren't blessed by your shop.  [view source]
• Perl::Critic::Policy::Variables::ProhibitLocalVars - Use C instead of C, except when you have to.  [view source]
• Perl::Critic::Policy::Variables::ProhibitMatchVars - Avoid C<$`>, C<$&>, C<$'> and their English equivalents.  [view source]
• Perl::Critic::Policy::Variables::ProhibitPackageVars - Eliminate globals declared with C or C.  [view source]
• Perl::Critic::Policy::Variables::ProhibitPerl4PackageNames - Use double colon (::) to separate package name components instead of single quotes (').  [view source]
• Perl::Critic::Policy::Variables::ProhibitPunctuationVars - Write C<$EVAL_ERROR> instead of C<$@>.  [view source]
• Perl::Critic::Policy::Variables::ProhibitReusedNames - Do not reuse a variable name in a lexical scope  [view source]
• Perl::Critic::Policy::Variables::ProhibitUnusedVariables - Don't ask for storage you don't need.  [view source]
• Perl::Critic::Policy::Variables::ProtectPrivateVars - Prevent access to private vars in other packages.  [view source]
• Perl::Critic::Policy::Variables::RequireInitializationForLocalVars - Write C instead of just C.  [view source]
• Perl::Critic::Policy::Variables::RequireLexicalLoopIterators - Write C instead of C.  [view source]
• Perl::Critic::Policy::Variables::RequireLocalizedPunctuationVars - Magic variables should be assigned as "local".  [view source]
• Perl::Critic::Policy::Variables::RequireNegativeIndices - Negative array index should be used.  [view source]
• Perl::Critic::PolicyConfig - Configuration data for a Policy.  [view source]
• Perl::Critic::PolicyFactory - Instantiates Policy objects.  [view source]
• Perl::Critic::PolicyListing - Display minimal information about Policies.  [view source]
• Perl::Critic::PolicyParameter - Metadata about a parameter for a Policy.  [view source]
• Perl::Critic::PolicyParameter::Behavior - Default type-specific actions for a parameter.  [view source]
• Perl::Critic::PolicyParameter::Behavior::Boolean - Actions appropriate for a boolean parameter.  [view source]
• Perl::Critic::PolicyParameter::Behavior::Enumeration - Actions appropriate for an enumerated value.  [view source]
• Perl::Critic::PolicyParameter::Behavior::Integer - Actions appropriate for an integer parameter.  [view source]
• Perl::Critic::PolicyParameter::Behavior::String - Actions appropriate for a simple string parameter.  [view source]
• Perl::Critic::PolicyParameter::Behavior::StringList - Actions appropriate for a parameter that is a list of strings.  [view source]
• Perl::Critic::PolicySummary - Descriptions of the Policy modules included with L itself.  [view source]
• Perl::Critic::ProfilePrototype - Generate an initial Perl::Critic profile.  [view source]
• Perl::Critic::Statistics - Compile stats on Perl::Critic violations.  [view source]
• Perl::Critic::TestUtils - Utility functions for testing new Policies.  [view source]
• Perl::Critic::Theme - Construct thematic sets of policies.  [view source]
• Perl::Critic::ThemeListing - List the themes of the installed Policies.  [view source]
• Perl::Critic::UserProfile - The contents of the user's profile, often F<.perlcriticrc>.  [view source]
• Perl::Critic::Utils - General utility subroutines and constants for Perl::Critic and derivative distributions.  [view source]
• Perl::Critic::Utils::Constants - Global constants.  [view source]
• Perl::Critic::Utils::DataConversion - Utilities for converting from one type of data to another.  [view source]
• Perl::Critic::Utils::McCabe - Functions that calculate the McCabe score of source code.  [view source]
• Perl::Critic::Utils::Perl - Utility functions for dealing with Perl language issues.  [view source]
• Perl::Critic::Utils::POD - Utility functions for dealing with POD.  [view source]
• Perl::Critic::Utils::POD::ParseInteriorSequence - Pod::Parser subclass to find all interior sequences.  [view source]
• Perl::Critic::Utils::PPI - Utility functions for dealing with PPI objects.  [view source]
• Perl::Critic::Violation - A violation of a Policy found in some source code.  [view source]
• Test::Perl::Critic::Policy - A framework for testing your custom Policies  [view source]