Debian Codegraph @

.perlcriticrc

raw
1 # Perl::Critic configuration. -*- conf -*-
2 #
3 # This .perlcriticrc expects precisely the following set of critic
4 # policies and related distributions to be installed, **and no others**:
5 #
6 # SHANCOCK/Perl-Tidy-20210402.tar.gz
7 # PETDANCE/Perl-Critic-1.140.tar.gz
8 # DBOOK/Perl-Critic-Community-v1.0.0.tar.gz
9 # KRYDE/Perl-Critic-Pulp-99.tar.gz
10 # GUGOD/Perl-Critic-TooMuchCode-0.15.tar.gz
11 #
12 # Make sure to keep this list in sync with the CI configuration.
13 #
14 # In order to ensure stable lint results, we explicitly enable or
15 # disable every single policy from the policy packages we use, and we
16 # have an ancillary script (build-aux/scripts/check-perlcritic-config)
17 # that enforces that _all_ installed policies are mentioned and _all_
18 # mentioned policies are installed.
19
20 # Start from the empty set, but with severity maxed.
21 severity = 1
22 only = 1
23
24 # compilation-mode--compatible diagnostic formatting
25 verbose = %f:%l:%c: warning: %m (%p; %e)\n
26
27 # Policies are listed strictly in alphabetical order.
28 # Each disabled policy should be annotated with an explanation.
29
30 [-BuiltinFunctions::ProhibitBooleanGrep]
31 # The rationale for prohibiting boolean 'grep' is sensible
32 # (it doesn't short-circuit, which could be a huge waste of time)
33 # but the recommended alternative is 'any' from List::MoreUtils,
34 # which would be the only CPAN dependency we had.
35
36 [BuiltinFunctions::ProhibitComplexMappings]
37
38 [BuiltinFunctions::ProhibitLvalueSubstr]
39
40 [BuiltinFunctions::ProhibitReverseSortBlock]
41
42 [BuiltinFunctions::ProhibitShiftRef]
43
44 [BuiltinFunctions::ProhibitSleepViaSelect]
45
46 [BuiltinFunctions::ProhibitStringyEval]
47
48 [BuiltinFunctions::ProhibitStringySplit]
49
50 [BuiltinFunctions::ProhibitUniversalCan]
51
52 [BuiltinFunctions::ProhibitUniversalIsa]
53
54 [BuiltinFunctions::ProhibitUselessTopic]
55
56 [BuiltinFunctions::ProhibitVoidGrep]
57
58 [BuiltinFunctions::ProhibitVoidMap]
59
60 [BuiltinFunctions::RequireBlockGrep]
61
62 [BuiltinFunctions::RequireBlockMap]
63
64 [BuiltinFunctions::RequireGlobFunction]
65
66 [BuiltinFunctions::RequireSimpleSortBlock]
67
68 [ClassHierarchies::ProhibitAutoloading]
69
70 [ClassHierarchies::ProhibitExplicitISA]
71
72 [ClassHierarchies::ProhibitOneArgBless]
73
74 [CodeLayout::ProhibitFatCommaNewline]
75
76 [CodeLayout::ProhibitHardTabs]
77
78 [CodeLayout::ProhibitIfIfSameLine]
79
80 [CodeLayout::ProhibitParensWithBuiltins]
81
82 [CodeLayout::ProhibitQuotedWordLists]
83
84 [CodeLayout::ProhibitTrailingWhitespace]
85
86 [CodeLayout::RequireConsistentNewlines]
87
88 [CodeLayout::RequireFinalSemicolon]
89
90 [CodeLayout::RequireTidyCode]
91 perltidyrc = .perltidyrc
92
93 [CodeLayout::RequireTrailingCommaAtNewline]
94
95 [CodeLayout::RequireTrailingCommas]
96
97 [-Community::AmpersandSubCalls]
98 # Duplicates core or pulp policy.
99
100 [-Community::ArrayAssignAref]
101 # Duplicates core or pulp policy.
102
103 [-Community::BarewordFilehandles]
104 # Duplicates core or pulp policy.
105
106 [-Community::ConditionalDeclarations]
107 # Duplicates core or pulp policy.
108
109 [Community::ConditionalImplicitReturn]
110
111 [Community::DeprecatedFeatures]
112
113 [-Community::DiscouragedModules]
114 # FindBin works fine for our purposes, and we can't use CPAN modules.
115 # There is no option to ignore use of just one module
116 # (https://github.com/Grinnz/Perl-Critic-Community/issues/42)
117
118 [Community::DollarAB]
119
120 [-Community::Each]
121 # I don't agree with this style rule.
122
123 [Community::EmptyReturn]
124
125 [-Community::IndirectObjectNotation]
126 # Duplicates core or pulp policy.
127
128 [-Community::LexicalForeachIterator]
129 # Duplicates core or pulp policy.
130
131 [-Community::LoopOnHash]
132 # Duplicates core or pulp policy.
133
134 [Community::ModPerl]
135
136 [Community::MultidimensionalArrayEmulation]
137
138 [-Community::OpenArgs]
139 # Duplicates core or pulp policy.
140
141 [Community::OverloadOptions]
142
143 [-Community::POSIXImports]
144 # Duplicates core or pulp policy.
145
146 [-Community::PackageMatchesFilename]
147 # Duplicates core or pulp policy.
148
149 [Community::PreferredAlternatives]
150
151 [-Community::Prototypes]
152 # Duplicates core or pulp policy.
153
154 [-Community::StrictWarnings]
155 # Duplicates core or pulp policy.
156
157 [Community::Threads]
158
159 [-Community::Wantarray]
160 # I don't agree with this style rule.
161
162 [Community::WarningsSwitch]
163
164 [-Community::WhileDiamondDefaultAssignment]
165 # I don't agree with this style rule.
166
167 [Compatibility::ConstantLeadingUnderscore]
168
169 [Compatibility::ConstantPragmaHash]
170
171 [Compatibility::Gtk2Constants]
172
173 [Compatibility::PodMinimumVersion]
174
175 [Compatibility::ProhibitUnixDevNull]
176
177 [ControlStructures::ProhibitCStyleForLoops]
178
179 [ControlStructures::ProhibitCascadingIfElse]
180 max_elsif = 3
181
182 [ControlStructures::ProhibitDeepNests]
183
184 [ControlStructures::ProhibitLabelsWithSpecialBlockNames]
185
186 [ControlStructures::ProhibitMutatingListFunctions]
187
188 [ControlStructures::ProhibitNegativeExpressionsInUnlessAndUntilConditions]
189
190 [-ControlStructures::ProhibitPostfixControls]
191 # I don't agree with this style rule.
192
193 [ControlStructures::ProhibitUnlessBlocks]
194
195 [ControlStructures::ProhibitUnreachableCode]
196
197 [ControlStructures::ProhibitUntilBlocks]
198
199 [ControlStructures::ProhibitYadaOperator]
200
201 [Documentation::PodSpelling]
202
203 [Documentation::ProhibitAdjacentLinks]
204
205 [Documentation::ProhibitBadAproposMarkup]
206
207 [Documentation::ProhibitDuplicateHeadings]
208
209 [Documentation::ProhibitDuplicateSeeAlso]
210
211 [Documentation::ProhibitLinkToSelf]
212
213 [Documentation::ProhibitParagraphEndComma]
214
215 [Documentation::ProhibitParagraphTwoDots]
216
217 [Documentation::ProhibitUnbalancedParens]
218
219 [Documentation::ProhibitVerbatimMarkup]
220
221 [Documentation::RequireEndBeforeLastPod]
222
223 [Documentation::RequireFilenameMarkup]
224
225 [Documentation::RequireFinalCut]
226
227 [Documentation::RequireLinkedURLs]
228
229 [Documentation::RequirePackageMatchesPodName]
230
231 [Documentation::RequirePodAtEnd]
232
233 [Documentation::RequirePodSections]
234
235 [-ErrorHandling::RequireCarping]
236 # This only makes sense for large libraries with lots of consumers.
237
238 [ErrorHandling::RequireCheckingReturnValueOfEval]
239
240 # All Freenode:: backward compatibility aliases are disabled.
241 # See https://github.com/Grinnz/Perl-Critic-Community/issues/41
242 [-Freenode::AmpersandSubCalls]
243 [-Freenode::ArrayAssignAref]
244 [-Freenode::BarewordFilehandles]
245 [-Freenode::ConditionalDeclarations]
246 [-Freenode::ConditionalImplicitReturn]
247 [-Freenode::DeprecatedFeatures]
248 [-Freenode::DiscouragedModules]
249 [-Freenode::DollarAB]
250 [-Freenode::Each]
251 [-Freenode::EmptyReturn]
252 [-Freenode::IndirectObjectNotation]
253 [-Freenode::LexicalForeachIterator]
254 [-Freenode::LoopOnHash]
255 [-Freenode::ModPerl]
256 [-Freenode::MultidimensionalArrayEmulation]
257 [-Freenode::OpenArgs]
258 [-Freenode::OverloadOptions]
259 [-Freenode::POSIXImports]
260 [-Freenode::PackageMatchesFilename]
261 [-Freenode::PreferredAlternatives]
262 [-Freenode::Prototypes]
263 [-Freenode::StrictWarnings]
264 [-Freenode::Threads]
265 [-Freenode::Wantarray]
266 [-Freenode::WarningsSwitch]
267 [-Freenode::WhileDiamondDefaultAssignment]
268
269 [InputOutput::ProhibitBacktickOperators]
270
271 [InputOutput::ProhibitBarewordFileHandles]
272
273 [InputOutput::ProhibitExplicitStdin]
274
275 [InputOutput::ProhibitInteractiveTest]
276
277 [InputOutput::ProhibitJoinedReadline]
278
279 [InputOutput::ProhibitOneArgSelect]
280
281 [InputOutput::ProhibitReadlineInForLoop]
282
283 [InputOutput::ProhibitTwoArgOpen]
284
285 [InputOutput::RequireBracedFileHandleWithPrint]
286
287 [-InputOutput::RequireBriefOpen]
288 # I can't find any explanation of what qualifies as "brief" and the
289 # diagnostic triggers on perfectly sensible code.
290
291 [InputOutput::RequireCheckedClose]
292
293 [InputOutput::RequireCheckedOpen]
294
295 [InputOutput::RequireCheckedSyscalls]
296 functions = :builtins
297 exclude_functions = print
298
299 [InputOutput::RequireEncodingWithUTF8Layer]
300
301 [Miscellanea::ProhibitFormats]
302
303 [Miscellanea::ProhibitTies]
304
305 [Miscellanea::ProhibitUnrestrictedNoCritic]
306
307 [Miscellanea::ProhibitUselessNoCritic]
308
309 [Miscellanea::TextDomainPlaceholders]
310
311 [Miscellanea::TextDomainUnused]
312
313 [Modules::ProhibitAutomaticExportation]
314
315 [Modules::ProhibitConditionalUseStatements]
316
317 [Modules::ProhibitEvilModules]
318
319 [Modules::ProhibitExcessMainComplexity]
320
321 [Modules::ProhibitModuleShebang]
322
323 [Modules::ProhibitMultiplePackages]
324
325 [Modules::ProhibitPOSIXimport]
326
327 [Modules::ProhibitUseQuotedVersion]
328
329 [Modules::RequireBarewordIncludes]
330
331 [Modules::RequireEndWithOne]
332
333 [Modules::RequireExplicitPackage]
334
335 [Modules::RequireFilenameMatchesPackage]
336
337 [Modules::RequireNoMatchVarsWithUseEnglish]
338
339 [-Modules::RequireVersionVar]
340 # This only makes sense for large libraries with lots of consumers.
341
342 [-NamingConventions::Capitalization]
343 # I don't agree with this style rule.
344
345 [NamingConventions::ProhibitAmbiguousNames]
346
347 [Objects::ProhibitIndirectSyntax]
348
349 [References::ProhibitDoubleSigils]
350
351 [RegularExpressions::ProhibitCaptureWithoutTest]
352
353 [-RegularExpressions::ProhibitComplexRegexes]
354 # The "complex" regexes are not that bad and splitting them up
355 # would only obscure the logic.
356
357 [-RegularExpressions::ProhibitEnumeratedClasses]
358 # I don't agree with this style rule.
359
360 [-RegularExpressions::ProhibitEscapedMetacharacters]
361 # I don't agree with this style rule.
362
363 [RegularExpressions::ProhibitFixedStringMatches]
364
365 [RegularExpressions::ProhibitSingleCharAlternation]
366
367 [RegularExpressions::ProhibitUnusedCapture]
368
369 [RegularExpressions::ProhibitUnusualDelimiters]
370
371 [RegularExpressions::ProhibitUselessTopic]
372
373 [RegularExpressions::RequireBracesForMultiline]
374
375 [-RegularExpressions::RequireDotMatchAnything]
376 # I don't agree with this style rule.
377
378 [-RegularExpressions::RequireExtendedFormatting]
379 # I don't agree with this style rule.
380
381 [-RegularExpressions::RequireLineBoundaryMatching]
382 # I don't agree with this style rule.
383
384 [Subroutines::ProhibitAmpersandSigils]
385
386 [Subroutines::ProhibitBuiltinHomonyms]
387
388 [-Subroutines::ProhibitExcessComplexity]
389 # The "complex" subroutines are not that bad and splitting them up
390 # would only obscure the logic.
391
392 [Subroutines::ProhibitExplicitReturnUndef]
393
394 [Subroutines::ProhibitManyArgs]
395
396 [Subroutines::ProhibitNestedSubs]
397
398 [Subroutines::ProhibitReturnSort]
399
400 [Subroutines::ProhibitSubroutinePrototypes]
401
402 [Subroutines::ProhibitUnusedPrivateSubroutines]
403
404 [Subroutines::ProtectPrivateSubs]
405
406 [Subroutines::RequireArgUnpacking]
407
408 [Subroutines::RequireFinalReturn]
409 terminal_funcs = fail skip error invocation_error subprocess_error
410
411 [TestingAndDebugging::ProhibitNoStrict]
412
413 [TestingAndDebugging::ProhibitNoWarnings]
414 allow = experimental::smartmatch experimental::re_strict
415
416 [TestingAndDebugging::ProhibitProlongedStrictureOverride]
417
418 [TestingAndDebugging::RequireTestLabels]
419
420 [TestingAndDebugging::RequireUseStrict]
421
422 [TestingAndDebugging::RequireUseWarnings]
423
424 [-TooMuchCode::ProhibitDuplicateLiteral]
425 # I don't agree with this style rule.
426
427 [TooMuchCode::ProhibitDuplicateSub]
428
429 [TooMuchCode::ProhibitExcessiveColons]
430
431 [TooMuchCode::ProhibitExtraStricture]
432
433 [TooMuchCode::ProhibitLargeBlock]
434
435 [TooMuchCode::ProhibitLargeTryBlock]
436
437 [TooMuchCode::ProhibitUnnecessaryScalarKeyword]
438
439 [-TooMuchCode::ProhibitUnnecessaryUTF8Pragma]
440 # We intentionally 'use utf8' in every file, regardless of whether it
441 # currently has non-ASCII characters in it.
442
443 [TooMuchCode::ProhibitUnusedConstant]
444
445 [TooMuchCode::ProhibitUnusedImport]
446
447 [TooMuchCode::ProhibitUnusedInclude]
448
449 [ValuesAndExpressions::ConstantBeforeLt]
450
451 [ValuesAndExpressions::NotWithCompare]
452
453 [ValuesAndExpressions::ProhibitArrayAssignAref]
454
455 [ValuesAndExpressions::ProhibitBarewordDoubleColon]
456
457 [ValuesAndExpressions::ProhibitCommaSeparatedStatements]
458
459 [ValuesAndExpressions::ProhibitComplexVersion]
460
461 [ValuesAndExpressions::ProhibitConstantPragma]
462
463 [ValuesAndExpressions::ProhibitDuplicateHashKeys]
464
465 [ValuesAndExpressions::ProhibitEmptyCommas]
466
467 [ValuesAndExpressions::ProhibitEmptyQuotes]
468
469 [ValuesAndExpressions::ProhibitEscapedCharacters]
470
471 [-ValuesAndExpressions::ProhibitFiletest_f]
472 # Doesn't understand the unusual, but unavoidable, uses of -f in this code
473 # (to identify executables without actually running them).
474
475 [ValuesAndExpressions::ProhibitImplicitNewlines]
476
477 [ValuesAndExpressions::ProhibitInterpolationOfLiterals]
478
479 [ValuesAndExpressions::ProhibitLeadingZeros]
480
481 [ValuesAndExpressions::ProhibitLongChainsOfMethodCalls]
482
483 [-ValuesAndExpressions::ProhibitMagicNumbers]
484 # I don't agree with this style rule.
485
486 [ValuesAndExpressions::ProhibitMismatchedOperators]
487
488 [ValuesAndExpressions::ProhibitMixedBooleanOperators]
489
490 [-ValuesAndExpressions::ProhibitNoisyQuotes]
491 # I don't agree with this style rule.
492
493 [ValuesAndExpressions::ProhibitNullStatements]
494
495 [ValuesAndExpressions::ProhibitQuotesAsQuotelikeOperatorDelimiters]
496
497 [ValuesAndExpressions::ProhibitSpecialLiteralHeredocTerminator]
498
499 [ValuesAndExpressions::ProhibitUnknownBackslash]
500
501 [-ValuesAndExpressions::ProhibitVersionStrings]
502 # Version strings were only problematic in versions of Perl older than
503 # our minimum.
504
505 [ValuesAndExpressions::RequireConstantVersion]
506
507 [ValuesAndExpressions::RequireInterpolationOfMetachars]
508
509 [ValuesAndExpressions::RequireNumberSeparators]
510
511 [ValuesAndExpressions::RequireNumericVersion]
512
513 [ValuesAndExpressions::RequireQuotedHeredocTerminator]
514
515 [ValuesAndExpressions::RequireUpperCaseHeredocTerminator]
516
517 [ValuesAndExpressions::UnexpandedSpecialLiteral]
518
519 [Variables::ProhibitAugmentedAssignmentInDeclaration]
520
521 [Variables::ProhibitConditionalDeclarations]
522
523 [Variables::ProhibitLocalVars]
524
525 [Variables::ProhibitLoopOnHash]
526
527 [Variables::ProhibitMatchVars]
528
529 [Variables::ProhibitPackageVars]
530
531 [Variables::ProhibitPerl4PackageNames]
532
533 [-Variables::ProhibitPunctuationVars]
534 # I don't agree with this style rule.
535
536 [Variables::ProhibitReusedNames]
537
538 [Variables::ProhibitUnusedVariables]
539
540 [Variables::ProtectPrivateVars]
541
542 [-Variables::RequireInitializationForLocalVars]
543 # I'd *like* to disable this *only* for $_, where the whole point is
544 # that it gets written to (and read from) implicitly, but that's not
545 # possible.
546
547 [Variables::RequireLexicalLoopIterators]
548
549 [Variables::RequireLocalizedPunctuationVars]
550
551 [Variables::RequireNegativeIndices]