t/critic/perlcriticrc

   1 ## Perl Critic configuration file
   2 severity = 1
   3 verbose = %f %l:%c (Severity: %s)\n  %P (%s)\n  near '%r'\n%d\n
   4 program-extensions = .pl .t
   5
   6 ##
   7 ## Tune tests
   8 ##
   9
  10 [Documentation::RequirePodSections]
  11 lib_sections = NAME | DESCRIPTION | CHANGES
  12 script_sections = NAME | SYNOPSIS | DESCRIPTION
  13
  14 [InputOutput::ProhibitBacktickOperators]
  15 # TODO: Add new Dpkg::Program module and switch those to it ?
  16 only_in_void_context = 1
  17
  18 [NamingConventions::ProhibitAmbiguousNames]
  19 # Allow set(), which is the common name for a setter.
  20 forbid = abstract bases close contract last left no record right second
  21
  22 [RegularExpressions::ProhibitUnusualDelimiters]
  23 allow_all_brackets = 1
  24
  25 [RegularExpressions::RequireBracesForMultiline]
  26 allow_all_brackets = 1
  27
  28 [RegularExpressions::RequireExtendedFormatting]
  29 minimum_regex_length_to_complain_about = 60
  30
  31 [Subroutines::RequireArgUnpacking]
  32 allow_delegation_to = new clone
  33
  34 [ValuesAndExpressions::ProhibitInterpolationOfLiterals]
  35 # TODO: Switch these to q{} ?
  36 allow_if_string_contains_single_quote = 1
  37
  38 ##
  39 ## Disable tests
  40 ##
  41
  42 # Here complex is meant as long, but long is not necessarily complex.
  43 [-BuiltinFunctions::ProhibitComplexMappings]
  44
  45 # Needed when generating code.
  46 [-BuiltinFunctions::ProhibitStringyEval]
  47
  48 # BUG: Bogus check.
  49 [-Documentation::PodSpelling]
  50
  51 # While this might be good for performance, it is bad for keeping docs updated.
  52 [-Documentation::RequirePodAtEnd]
  53
  54 # Too many false positives.
  55 [-CodeLayout::RequireTidyCode]
  56
  57 # Forcing this just turns into noise (depending on the context, it makes sense).
  58 [-CodeLayout::RequireTrailingCommas]
  59
  60 # These are fine, and given/when are marked as experimental.
  61 [-ControlStructures::ProhibitCascadingIfElse]
  62
  63 # These are fine, and too many in the code base anyway.
  64 [-ControlStructures::ProhibitPostfixControls]
  65
  66 # These are fine, usually as long as they are not double negations.
  67 [-ControlStructures::ProhibitUnlessBlocks]
  68
  69 # BUG: Too many false positives.
  70 [-ControlStructures::ProhibitUnreachableCode]
  71
  72 # Not relevant anymore, the mentioned problems were fixed in Perl 5.14.
  73 [-ErrorHandling::RequireCheckingReturnValueOfEval]
  74
  75 # Needed, using <>/<@ARGV> is not correct, Prompt is not a core module.
  76 [-InputOutput::ProhibitExplicitStdin]
  77
  78 # TODO: Maybe, some of these are part of the public/current API.
  79 [-Modules::ProhibitAutomaticExportation]
  80
  81 # Here complex is meant as long, but long is not necessarily complex.
  82 [-Modules::ProhibitExcessMainComplexity]
  83
  84 # BUG: Too many false positives; non-modules all trigger.
  85 [-Modules::RequireVersionVar]
  86
  87 # We work primarily with ASCII, so we need to specify the exact characters
  88 # to match.
  89 [-RegularExpressions::ProhibitEnumeratedClasses]
  90
  91 # When . is used in the code it means what it does.
  92 [-RegularExpressions::RequireDotMatchAnything]
  93
  94 # When ^ or $ are used in the code they mean what they do.
  95 [-RegularExpressions::RequireLineBoundaryMatching]
  96
  97 # TODO: While valid, these are part of the public/current API.
  98 [-Subroutines::ProhibitBuiltinHomonyms]
  99
 100 # TODO: Needed but we should switch away, and with perl 5.36 use signatures.
 101 [-Subroutines::ProhibitSubroutinePrototypes]
 102
 103 # Adding these seems like more noise.
 104 [-Subroutines::RequireFinalReturn]
 105
 106 # Readers need to know perl, English module is worse.
 107 [-Variables::ProhibitPunctuationVars]
 108 [-Modules::RequireNoMatchVarsWithUseEnglish]
 109
 110 # Readers need to know perl.
 111 [-Variables::RequireInitializationForLocalVars]
 112
 113 # BUG: Too many false positives; on ::main and for $ENV, $SIG, $?, $a, $b.
 114 [-Variables::RequireLocalizedPunctuationVars]
 115
 116 # Readonly is not a core module.
 117 [-ValuesAndExpressions::ProhibitConstantPragma]
 118
 119 # TODO: Check it out, using other quotes might be less readable and uniform.
 120 [-ValuesAndExpressions::ProhibitEmptyQuotes]
 121
 122 # Using charnames is less clear.
 123 [-ValuesAndExpressions::ProhibitEscapedCharacters]
 124
 125 # Used for help output.
 126 [-ValuesAndExpressions::ProhibitImplicitNewlines]
 127
 128 # TODO: Octals are fine, but revisit with perl 5.34 octal syntax 0o<nnnn>.
 129 [-ValuesAndExpressions::ProhibitLeadingZeros]
 130
 131 # TODO: Check it out, some magic numbers are fine, octals for example.
 132 [-ValuesAndExpressions::ProhibitMagicNumbers]
 133
 134 # BUG: False positives on long hex numbers, even when separated.
 135 [-ValuesAndExpressions::RequireNumberSeparators]