/
phpstan.neon
376 lines (296 loc) · 17.9 KB
/
phpstan.neon
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
includes:
- vendor/symplify/phpstan-rules/config/symplify-rules.neon
- vendor/symplify/phpstan-rules/config/rector-rules.neon
parameters:
level: 8
reportUnmatchedIgnoredErrors: false
# @see https://github.com/tomasVotruba/cognitive-complexity
cognitive_complexity:
class: 50
function: 11
# requires exact closure types
checkMissingCallableSignature: true
paths:
- rector.php
- bin
- config
- src
- rules
# tests
- tests
- rules-tests
- utils
scanDirectories:
- stubs
scanFiles:
- src/Contract/PhpParser/Node/StmtsAwareInterface.php
excludePaths:
- '*tests/*/Fixture/*'
- '*tests/*/Fixture*'
- '*tests/*/Source/*'
- '*tests/*/Source*'
# tests
- tests/DependencyInjection/config
- src/functions
ignoreErrors:
-
identifier: missingType.generics
-
message: '#Class cognitive complexity is \d+, keep it under \d+#'
paths:
- rules/Php70/EregToPcreTransformer.php
- src/NodeTypeResolver/NodeTypeResolver.php
- src/NodeTypeResolver/PHPStan/Scope/PHPStanNodeScopeResolver.php
- src/PHPStanStaticTypeMapper/TypeMapper/UnionTypeMapper.php
- src/PhpParser/Printer/BetterStandardPrinter.php #41
- src/PhpDocParser/PhpDocParser/PhpDocNodeTraverser.php
- rules/TypeDeclaration/Rector/ClassMethod/StrictArrayParamDimFetchRector.php
- src/CustomRules/SimpleNodeDumper.php
-
message: '#Cognitive complexity for "(.*?)" is (.*?), keep it under 11#'
paths:
- rules/Php70/EregToPcreTransformer.php
- src/PhpParser/Node/Value/ValueResolver.php
- rules/DeadCode/NodeManipulator/LivingCodeManipulator.php
- rules/Php80/NodeResolver/SwitchExprsResolver.php
- src/NodeTypeResolver/NodeTypeResolver.php
- src/BetterPhpDocParser/PhpDocParser/DoctrineAnnotationDecorator.php
- src/Parallel/Application/ParallelFileProcessor.php
# rector rules
- rules/*/Rector/*Rector.php
- utils/Rector/MoveAbstractRectorToChildrenRector.php
- src/PhpDocParser/PhpDocParser/PhpDocNodeTraverser.php
- src/NodeTypeResolver/PHPStan/Scope/PHPStanNodeScopeResolver.php
- src/Configuration/RectorConfigBuilder.php
- rules/TypeDeclaration/PHPStan/ObjectTypeSpecifier.php
- src/PhpAttribute/NodeFactory/PhpNestedAttributeGroupFactory.php
# is nested expr
-
message: '#Access to an undefined property PhpParser\\Node\\Expr\:\:\$expr#'
path: rules/DeadCode/NodeManipulator/LivingCodeManipulator.php
# lack of generic array in nikic/php-parser
- '#Method (.*?) should return array<PhpParser\\Node\\(.*?)\> but returns array<PhpParser\\Node\>#'
-
message: '#There should be no empty class#'
paths:
- src/StaticTypeMapper/ValueObject/Type/*Type.php
# generics nullable bugs
-
message: '#Method (.*?) should return (.*?)\|null but returns PhpParser\\Node\|null#'
path: src/PhpParser/Node/BetterNodeFinder.php
- '#Method (.*?) should return array<T of PhpParser\\Node\> but returns array<PhpParser\\Node\>#'
- '#Property Rector\\PhpParser\\Node\\AssignAndBinaryMap\:\:\$binaryOpToAssignClasses \(array<class\-string<PhpParser\\Node\\Expr\\BinaryOp\>, class\-string<PhpParser\\Node\\Expr\\BinaryOp\>\>\) does not accept array#'
-
message: '#Function "property_exists\(\)" cannot be used/left in the code#'
paths:
# on PhpParser Nodes
- src/NodeNameResolver/NodeNameResolver.php
- src/BetterPhpDocParser/PhpDocParser/BetterPhpDocParser.php
- src/BetterPhpDocParser/PhpDocParser/DoctrineAnnotationDecorator.php
- '#(.*?) class\-string, string given#'
-
message: '#Use explicit return value over magic &reference#'
paths:
- src/PhpDocParser/PhpDocParser/PhpDocNodeTraverser.php
- rules/Php70/EregToPcreTransformer.php
- src/BetterPhpDocParser/PhpDocManipulator/PhpDocClassRenamer.php
- src/NodeTypeResolver/PHPStan/Type/TypeFactory.php
# known types
- '#Parameter (.*?) expects PhpParser\\Node, PhpParser\\Node\|null given#'
# array_index on generic types
- '#Method Rector\\NodeTypeResolver\\PHPStan\\Type\\TypeFactory\:\:uniquateTypes\(\) should return array<TType of PHPStan\\Type\\Type\> but returns array<int, PHPStan\\Type\\Type\>#'
- '#Method Rector\\Arguments\\ArgumentDefaultValueReplacer\:\:processReplaces\(\) should return \(TCall of PhpParser\\Node\\Expr\\FuncCall\|PhpParser\\Node\\Expr\\MethodCall\|PhpParser\\Node\\Expr\\New_\|PhpParser\\Node\\Expr\\StaticCall\|PhpParser\\Node\\Stmt\\ClassMethod\)\|null but returns PhpParser\\Node\\Stmt\\ClassMethod\|null#'
# native filesystem calls, required for performance reasons
-
message: '#"@\\unlink\(\$tmpPath\)" is forbidden to use#'
paths:
- src/Caching/ValueObject/Storage/FileCacheStorage.php
-
message: '#"@\\copy(.*?)" is forbidden to use#'
paths:
- src/Caching/ValueObject/Storage/FileCacheStorage.php
-
message: '#"@\\var_export\(new \\Rector\\Caching\\ValueObject\\CacheItem\(\$variableKey, \$data\), true\)" is forbidden to use#'
paths:
- src/Caching/ValueObject/Storage/FileCacheStorage.php
-
message: '#Parameter \#2 \$length of function str_split expects int<1, max\>, int given#'
paths:
- rules/Php74/Rector/LNumber/AddLiteralSeparatorToNumberRector.php
# many internal cases
- '#Calling (.*?) is not covered by backward compatibility promise\. The method might change in a minor PHPStan version#'
# known value object, nullable due to typed property
-
message: '#Cannot call method (.*?)\(\) on (.*?)\\ProcessPool\|null#'
path: src/Parallel/Application/ParallelFileProcessor.php
# generics
- '#Parameter \#1 \$stmts of class Rector\\PhpParser\\Node\\CustomNode\\FileWithoutNamespace constructor expects array<PhpParser\\Node\\Stmt\>, array<TNode of PhpParser\\Node\> given#'
-
message: '#Use value object over return of values#'
paths:
- src/BetterPhpDocParser/PhpDocParser/StaticDoctrineAnnotationParser/ArrayParser.php
- rules/EarlyReturn/Rector/If_/ChangeNestedIfsToEarlyReturnRector.php
- rules/Php70/EregToPcreTransformer.php
- rules/DeadCode/NodeManipulator/LivingCodeManipulator.php
- rules/EarlyReturn/Rector/If_/ChangeAndIfToEarlyReturnRector.php
- src/PhpParser/NodeTransformer.php
# mapper re-use
- '#Parameter \#1 \$type of method Rector\\PHPStanStaticTypeMapper\\TypeMapper\\ObjectWithoutClassTypeMapper\:\:mapToPhpParserNode\(\) expects PHPStan\\Type\\ObjectWithoutClassType, PHPStan\\Type\\Accessory\\Has(Property|Method)Type given#'
# Scope vs MutatingScope interchangable false positive
- '#Parameter \#3 \$nodeCallback of method PHPStan\\Analyser\\NodeScopeResolver\:\:processNodes\(\) expects callable\(PhpParser\\Node, PHPStan\\Analyser\\Scope\)\: void, (callable|Closure)\(PhpParser\\Node, PHPStan\\Analyser\\MutatingScope\)\: void given#'
# internal reflection
- '#Instead of "new ClassReflection\(\)" use ReflectionProvider service or "\(new PHPStan\\Reflection\\ClassReflection\(<desired_type>\)\)" for static reflection to work#'
# import container config
-
message: '#Use explicit names over dynamic ones#'
path: src/Testing/PHPUnit/AbstractTestCase.php
- '#Callable callable\(PHPStan\\Type\\Type\)\: PHPStan\\Type\\Type invoked with 2 parameters, 1 required#'
# known value
- '#Method Rector\\Php\\PhpVersionProvider\:\:provide\(\) should return 50200\|50300\|50400\|50500\|50600\|70000\|70100\|70200\|70300\|70400\|80000\|80100\|80200\|80300\|80400\|100000 but returns int#'
# stubs-rector directory exists on target-repository
-
message: '#The path "/\.\./\.\./stubs\-rector" was not found#'
path: src/Autoloading/BootstrapFilesIncluder.php # 54
-
message: '#Function "class_exists\(\)" cannot be used/left in the code#'
paths:
# autoload check in bin file
- bin/rector.php
# for config class reflection
- src/Bootstrap/ExtensionConfigResolver.php
- src/DependencyInjection/LazyContainerFactory.php
- src/Validation/RectorConfigValidator.php
# use of internal phpstan classes
-
message: '#Creating new PHPStan\\Reflection\\BetterReflection\\SourceLocator\\Optimized(.*?)SourceLocator is not covered by backward compatibility promise\. The class might change in a minor PHPStan version#'
path: src/NodeTypeResolver/Reflection/BetterReflection/SourceLocatorProvider/DynamicSourceLocatorProvider.php
-
message: '#Do not name "[a-z]", shorter than 2 chars#'
paths:
# override parent method named "p"
- src/PhpParser/Printer/BetterStandardPrinter.php
# regex
- rules/Php70/EregToPcreTransformer.php
-
message: '#@\\ini_set\(.*\)" is forbidden to use#'
path: bin/rector.php
# mixed type correction
-
message: '#New objects with "\$(first|second)KeyType" name are overridden\. This can lead to unwanted bugs, please pick a different name to avoid it#'
path: src/NodeTypeResolver/TypeComparator/TypeComparator.php
-
message: '#New objects with "\$staticType" name are overridden\. This can lead to unwanted bugs, please pick a different name to avoid it#'
path: src/NodeTypeResolver/PhpDocNodeVisitor/NameImportingPhpDocNodeVisitor.php
-
message: '#New objects with "\$fullyQualifiedObjectType" name are overridden\. This can lead to unwanted bugs, please pick a different name to avoid it#'
path: src/NodeTypeResolver/PhpDocNodeVisitor/NameImportingPhpDocNodeVisitor.php
# phpdoc node traversing
-
message: '#Use explicit names over dynamic ones#'
path: "src/PhpDocParser/PhpDocParser/PhpDocNodeTraverser.php"
-
message: '#Creating new PHPStan\\Parser\\(CachedParser|SimpleParser) is not covered by backward compatibility promise\. The class might change in a minor PHPStan version#'
path: src/PhpDocParser/PhpParser/SmartPhpParserFactory.php
# known existing class
-
message: '#Instead of "instanceof/is_a\(\)" use ReflectionProvider service or "\(new ObjectType\(<desired_type>\)\)\->isSuperTypeOf\(<element_type>\)" for static reflection to work#'
path: src/Skipper/Skipper/SkipSkipper.php
# the local instanceof for known types
- '#Instead of "instanceof/is_a\(\)" use ReflectionProvider service or "\(new ObjectType\(<desired_type>\)\)\->isSuperTypeOf\(<element_type>\)" for static reflection to work#'
# required for reflection
-
message: '#Function "(.*?)\(\)" cannot be used/left in the code#'
path: src/Util/Reflection/PrivatesAccessor.php
-
message: '#Method Rector\\Util\\ArrayParametersMerger\:\:mergeLeftToRightWithCallable\(\) has parameter \$mergeCallback with no signature specified for callable#'
path: src/Util/ArrayParametersMerger.php
# fixture class
- '#Class "Rector\\Tests\\Issues\\ScopeNotAvailable\\Variable\\ArrayItemForeachValueRector" is missing @see annotation with test case class reference#'
-
message: '#Parameter \#1 \$phpVersion of method Rector\\Config\\RectorConfig\:\:phpVersion\(\) expects 50200\|50300\|50400\|50500\|50600\|70000\|70100\|70200\|70300\|70400\|80000\|80100\|80200\|80300\|80400\|100000, (.*?) given#'
path: rules-tests
-
message: '#Class (.*?) not found#'
paths:
- rules-tests/*/config/*
# trusted items
- '#Parameter \#1 \$nodes of method PhpParser\\PrettyPrinterAbstract\:\:pCommaSeparatedMultiline\(\) expects array<PhpParser\\Node>, array<PhpParser\\Node\\Expr\\ArrayItem\|null> given#'
# class string
- '#Parameter \#1 \$name of method PHPStan\\BetterReflection\\Reflection\\Adapter\\ReflectionClass\:\:getAttributes\(\) expects class\-string\|null, string given#'
# useless
- '#Parameter \#1 \$suffix of method PHPUnit\\Framework\\Assert\:\:assertStringEndsWith\(\) expects non\-empty\-string, string given#'
-
message: '#Function "(function_exists|dump_node)\(\)" cannot be used/left in the code#'
path: src/functions/node_helper.php
# false positive on enums
- '#Method Rector\\Console\\Command\\SetupCICommand\:\:resolveCurrentCI\(\) never returns (.*?) so it can be removed from the return type#'
# stmts aware/expression generics
- '#PhpParser\\Node\\Stmt\\Expression is not generic#'
- '#Parameter \#3 \$assign of method Rector\\CodeQuality\\Rector\\FunctionLike\\SimplifyUselessVariableRector\:\:processSimplifyUselessVariable\(\) expects PhpParser\\Node\\Expr\\Assign\|PhpParser\\Node\\Expr\\AssignOp, PhpParser\\Node\\Expr given#'
# false positive
-
message: '#Offset 0 does not exist on array<PhpParser\\Node\\Stmt>\|null#'
path: rules/Php70/Rector/ClassMethod/Php4ConstructorRector.php
# chicken/egg
-
message: '#Function "(d|dd)\(\)" cannot be used/left in the code#'
path: tests/debug_functions.php
# debug functions
-
message: '#Function "function_exists\(\)" cannot be used/left in the code\: use ReflectionProvider\->has\*\(\) instead#'
path: tests/debug_functions.php
# method signature kept for symmetry of hasParentClassMethod() with getParentClassMethod()
-
message: '#Parameters should use "PhpParser\\Node\\Stmt\\ClassMethod" types as the only types passed to this method#'
path: src/VendorLocker/ParentClassMethodTypeOverrideGuard.php
# checks for rector always autoloaded rules only
-
message: '#Function "(class_exists|interface_exists)\(\)" cannot be used/left in the code\: use ReflectionProvider\->has\*\(\) instead#'
path: src/Skipper/SkipCriteriaResolver/SkippedClassResolver.php
# ignore until PHPParser returns more precise types
-
message: '#Parameter \#1 \$useType of callable callable\(0\|1\|2\|3, PhpParser\\Node\\Stmt\\UseUse, string\): void expects 0\|1\|2\|3, int given.#'
path: rules/CodingStyle/ClassNameImport/UseImportsTraverser.php
- '#(.*?)\\Contract\\PhpParser\\Node\\StmtsAwareInterface\:\:\$stmts#'
# dev rule
- '#Class "Rector\\Utils\\Rector\\MoveAbstractRectorToChildrenRector" is missing @see annotation with test case class reference#'
# optional as changes behavior, should be used explicitly outside PHP upgrade
- '#Register "Rector\\Php73\\Rector\\FuncCall\\JsonThrowOnErrorRector" service to "php73\.php" config set#'
- '#Register "Rector\\Php81\\Rector\\ClassConst\\FinalizePublicClassConstantRector" service to "php81\.php" config set#'
# soon to be extended
-
path: src/Reflection/ClassModifierChecker.php
message: '#Parameters should use "PhpParser\\Node\\Stmt\\ClassMethod" types as the only types passed to this method#'
# known enum from strings
- '#Method Rector\\Php\\PolyfillPackagesProvider\:\:filterPolyfillPackages\(\) should return array\<.*\> but returns array<int, non\-falsy\-string>#'
# closure detailed
- '#Method Rector\\Config\\RectorConfig\:\:singleton\(\) has parameter \$concrete with no signature specified for Closure#'
-
message: '#Class cognitive complexity is \d+, keep it under 50#'
paths:
- src/PhpParser/Node/Value/ValueResolver.php
- src/Configuration/RectorConfigBuilder.php
# dynamic printer
-
message: '#Use explicit names over dynamic ones#'
path: src/CustomRules/SimpleNodeDumper.php
# complex logic, to keep on single place for easy adjustments
-
message: '#Cognitive complexity for "Rector\\CustomRules\\SimpleNodeDumper(.*?)" is \d+, keep it under 11#'
path: src/CustomRules/SimpleNodeDumper.php
# way to invoke repeated quesitons in symfony
-
message: '#While loop condition is always true#'
path: src/Console/Command/DetectNodeCommand.php
# known node variables
-
message: '#Access to an undefined property PhpParser\\Node\\Scalar\:\:\$value#'
path: src/CustomRules/SimpleNodeDumper.php
-
message: '#Offset \(int\|string\) on non\-empty\-array<PHPStan\\PhpDocParser\\Ast\\PhpDoc\\PhpDocChildNode> in isset\(\) always exists and is not nullable#'
path: src/BetterPhpDocParser/PhpDocParser/DoctrineAnnotationDecorator.php
# false positive
-
message: '#Parameters should use "array" types as the only types passed to this method#'
path: src/Util/NodePrinter.php
- '#Cognitive complexity for "Rector\\TypeDeclaration\\NodeAnalyzer\\CallerParamMatcher\:\:matchCallParamType\(\)" is 12, keep it under 11#'