dead-code-detector/rules.neon at master · shipmonk-rnd/dead-code-detector · GitHub

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
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
services:
    errorFormatter.removeDeadCode:
        class: ShipMonk\PHPStan\DeadCode\Formatter\RemoveDeadCodeFormatter

    errorFormatter.filterOutUnmatchedInlineIgnoresDuringPartialAnalysis:
        class: ShipMonk\PHPStan\DeadCode\Formatter\FilterOutUnmatchedInlineIgnoresFormatter
        arguments:
            wrappedFormatter: %shipmonkDeadCode.filterOutUnmatchedInlineIgnoresDuringPartialAnalysis.wrappedErrorFormatter%
            identifiers: %shipmonkDeadCode.filterOutUnmatchedInlineIgnoresDuringPartialAnalysis.identifiers%

    -
        class: ShipMonk\PHPStan\DeadCode\Cache\UsageCacheStorage
        arguments:
            tmpDir: %tmpDir%
            offloadCollectorData: %shipmonkDeadCode.cache.offloadCollectorData%
    -
        class: ShipMonk\PHPStan\DeadCode\Composer\ComposerIntrospector
    -
        class: ShipMonk\PHPStan\DeadCode\Hierarchy\ClassHierarchy
    -
        class: ShipMonk\PHPStan\DeadCode\Transformer\FileSystem
    -
        class: ShipMonk\PHPStan\DeadCode\Output\OutputEnhancer
        arguments:
            editorUrl: %editorUrl%

    -
        class: ShipMonk\PHPStan\DeadCode\Debug\DebugUsagePrinter
        arguments:
            bladeOptions: %shipmonkDeadCode.usageProviders.blade%

    -
        class: ShipMonk\PHPStan\DeadCode\Provider\ApiPhpDocUsageProvider
        tags:
            - shipmonk.deadCode.memberUsageProvider
        arguments:
            enabled: %shipmonkDeadCode.usageProviders.apiPhpDoc.enabled%
            analysedPaths: %analysedPaths%

    -
        class: ShipMonk\PHPStan\DeadCode\Provider\EnumUsageProvider
        tags:
            - shipmonk.deadCode.memberUsageProvider
        arguments:
            enabled: %shipmonkDeadCode.usageProviders.enum.enabled%

    -
        class: ShipMonk\PHPStan\DeadCode\Provider\VendorUsageProvider
        tags:
            - shipmonk.deadCode.memberUsageProvider
        arguments:
            enabled: %shipmonkDeadCode.usageProviders.vendor.enabled%

    -
        class: ShipMonk\PHPStan\DeadCode\Provider\BuiltinUsageProvider
        tags:
            - shipmonk.deadCode.memberUsageProvider
        arguments:
            enabled: %shipmonkDeadCode.usageProviders.builtin.enabled%

    -
        class: ShipMonk\PHPStan\DeadCode\Provider\ReflectionUsageProvider
        tags:
            - shipmonk.deadCode.memberUsageProvider
        arguments:
            enabled: %shipmonkDeadCode.usageProviders.reflection.enabled%

    -
        class: ShipMonk\PHPStan\DeadCode\Provider\PhpUnitUsageProvider
        tags:
            - shipmonk.deadCode.memberUsageProvider
        arguments:
            enabled: %shipmonkDeadCode.usageProviders.phpunit.enabled%

    -
        class: ShipMonk\PHPStan\DeadCode\Provider\PhpBenchUsageProvider
        tags:
            - shipmonk.deadCode.memberUsageProvider
        arguments:
            enabled: %shipmonkDeadCode.usageProviders.phpbench.enabled%

    -
        class: ShipMonk\PHPStan\DeadCode\Provider\BehatUsageProvider
        tags:
            - shipmonk.deadCode.memberUsageProvider
        arguments:
            enabled: %shipmonkDeadCode.usageProviders.behat.enabled%

    -
        class: ShipMonk\PHPStan\DeadCode\Provider\TemplateViewDataTraverser
        arguments:
            analysedPaths: %analysedPaths%

    -
        class: ShipMonk\PHPStan\DeadCode\Provider\SymfonyUsageProvider
        tags:
            - shipmonk.deadCode.memberUsageProvider
        arguments:
            enabled: %shipmonkDeadCode.usageProviders.symfony.enabled%
            configDir: %shipmonkDeadCode.usageProviders.symfony.configDir%
            containerXmlPaths: %shipmonkDeadCode.usageProviders.symfony.containerXmlPaths%

    -
        class: ShipMonk\PHPStan\DeadCode\Provider\TwigUsageProvider
        tags:
            - shipmonk.deadCode.memberUsageProvider
        arguments:
            enabled: %shipmonkDeadCode.usageProviders.twig.enabled%

    -
        class: ShipMonk\PHPStan\DeadCode\Provider\DoctrineUsageProvider
        tags:
            - shipmonk.deadCode.memberUsageProvider
        arguments:
            enabled: %shipmonkDeadCode.usageProviders.doctrine.enabled%

    -
        class: ShipMonk\PHPStan\DeadCode\Provider\PhpStanUsageProvider
        tags:
            - shipmonk.deadCode.memberUsageProvider
        arguments:
            enabled: %shipmonkDeadCode.usageProviders.phpstan.enabled%

    -
        class: ShipMonk\PHPStan\DeadCode\Provider\PhpatUsageProvider
        tags:
            - shipmonk.deadCode.memberUsageProvider
        arguments:
            enabled: %shipmonkDeadCode.usageProviders.phpat.enabled%

    -
        class: ShipMonk\PHPStan\DeadCode\Provider\EloquentUsageProvider
        tags:
            - shipmonk.deadCode.memberUsageProvider
        arguments:
            enabled: %shipmonkDeadCode.usageProviders.eloquent.enabled%

    -
        class: ShipMonk\PHPStan\DeadCode\Provider\LaravelUsageProvider
        tags:
            - shipmonk.deadCode.memberUsageProvider
        arguments:
            enabled: %shipmonkDeadCode.usageProviders.laravel.enabled%

    -
        class: ShipMonk\PHPStan\DeadCode\Provider\BladeUsageProvider
        tags:
            - shipmonk.deadCode.memberUsageProvider
        arguments:
            enabled: %shipmonkDeadCode.usageProviders.blade.enabled%
            deduplicateAcrossViews: %shipmonkDeadCode.usageProviders.blade.deduplicateAcrossViews%

    -
        class: ShipMonk\PHPStan\DeadCode\Provider\NetteUsageProvider
        tags:
            - shipmonk.deadCode.memberUsageProvider
        arguments:
            enabled: %shipmonkDeadCode.usageProviders.nette.enabled%
            containerNeonPaths: %shipmonkDeadCode.usageProviders.nette.containerNeonPaths%

    -
        class: ShipMonk\PHPStan\DeadCode\Provider\NetteTesterUsageProvider
        tags:
            - shipmonk.deadCode.memberUsageProvider
        arguments:
            enabled: %shipmonkDeadCode.usageProviders.netteTester.enabled%

    -
        class: ShipMonk\PHPStan\DeadCode\Provider\StreamWrapperUsageProvider
        tags:
            - shipmonk.deadCode.memberUsageProvider
        arguments:
            enabled: %shipmonkDeadCode.usageProviders.streamWrapper.enabled%

    -
        class: ShipMonk\PHPStan\DeadCode\Provider\ComposerUsageProvider
        tags:
            - shipmonk.deadCode.memberUsageProvider
        arguments:
            enabled: %shipmonkDeadCode.usageProviders.composer.enabled%
            composerJsonPath: %shipmonkDeadCode.usageProviders.composer.composerJsonPath%


    -
        class: ShipMonk\PHPStan\DeadCode\Excluder\TestsUsageExcluder
        tags:
            - shipmonk.deadCode.memberUsageExcluder
        arguments:
            enabled: %shipmonkDeadCode.usageExcluders.tests.enabled%
            devPaths: %shipmonkDeadCode.usageExcluders.tests.devPaths%

    -
        class: ShipMonk\PHPStan\DeadCode\Excluder\MixedUsageExcluder
        tags:
            - shipmonk.deadCode.memberUsageExcluder
        arguments:
            enabled: %shipmonkDeadCode.usageExcluders.usageOverMixed.enabled%


    -
        class: ShipMonk\PHPStan\DeadCode\Collector\MethodCallCollector
        tags:
            - phpstan.collector
        arguments:
            memberUsageExcluders: tagged(shipmonk.deadCode.memberUsageExcluder)

    -
        class: ShipMonk\PHPStan\DeadCode\Collector\ConstantFetchCollector
        tags:
            - phpstan.collector
        arguments:
            memberUsageExcluders: tagged(shipmonk.deadCode.memberUsageExcluder)

    -
        class: ShipMonk\PHPStan\DeadCode\Collector\PropertyAccessCollector
        tags:
            - phpstan.collector
        arguments:
            analysedPaths: %analysedPaths%
            memberUsageExcluders: tagged(shipmonk.deadCode.memberUsageExcluder)

    -
        class: ShipMonk\PHPStan\DeadCode\Collector\ClassDefinitionCollector
        tags:
            - phpstan.collector

    -
        class: ShipMonk\PHPStan\DeadCode\Collector\ProvidedUsagesCollector
        tags:
            - phpstan.collector
        arguments:
            memberUsageProviders: tagged(shipmonk.deadCode.memberUsageProvider)
            memberUsageExcluders: tagged(shipmonk.deadCode.memberUsageExcluder)

    -
        class: ShipMonk\PHPStan\DeadCode\Rule\DeadCodeRule
        tags:
            - phpstan.rules.rule
            - phpstan.diagnoseExtension
        arguments:
            detectDeadMethods: %shipmonkDeadCode.detect.deadMethods%
            detectDeadConstants: %shipmonkDeadCode.detect.deadConstants%
            detectDeadEnumCases: %shipmonkDeadCode.detect.deadEnumCases%
            detectNeverReadProperties: %shipmonkDeadCode.detect.deadProperties.neverRead%
            detectNeverWrittenProperties: %shipmonkDeadCode.detect.deadProperties.neverWritten%
            reportTransitivelyDeadMethodAsSeparateError: %shipmonkDeadCode.reportTransitivelyDeadMethodAsSeparateError%

    -
        class: ShipMonk\PHPStan\DeadCode\Compatibility\BackwardCompatibilityChecker
        arguments:
            servicesWithOldTag: tagged(shipmonk.deadCode.entrypointProvider)
            trackMixedAccessParameterValue: %shipmonkDeadCode.trackMixedAccess%

    -
        class: ShipMonk\PHPStan\DeadCode\Visitor\PropertyWriteVisitor
        tags:
            - phpstan.parser.richParserNodeVisitor

parameters:
    parametersNotInvalidatingCache:
        - parameters.shipmonkDeadCode.debug.usagesOf
        - parameters.shipmonkDeadCode.reportTransitivelyDeadMethodAsSeparateError
    shipmonkDeadCode:
        trackMixedAccess: null
        reportTransitivelyDeadMethodAsSeparateError: false
        cache:
            offloadCollectorData: true
        detect:
            deadMethods: true
            deadConstants: true
            deadEnumCases: true
            deadProperties:
                neverRead: true
                neverWritten: true
        usageProviders:
            apiPhpDoc:
                enabled: true
            enum:
                enabled: true
            vendor:
                enabled: true
            builtin:
                enabled: true
            reflection:
                enabled: true
            phpstan:
                enabled: true
            phpat:
                enabled: null
            phpunit:
                enabled: null
            phpbench:
                enabled: null
            behat:
                enabled: null
            symfony:
                enabled: null
                configDir: null
                containerXmlPaths: []
            twig:
                enabled: null
            doctrine:
                enabled: null
            eloquent:
                enabled: null
            laravel:
                enabled: null
            blade:
                enabled: null
                deduplicateAcrossViews: true
            nette:
                enabled: null
                containerNeonPaths: []
            netteTester:
                enabled: null
            streamWrapper:
                enabled: true
            composer:
                enabled: true
                composerJsonPath: null
        usageExcluders:
            tests:
                enabled: false
                devPaths: null
            usageOverMixed:
                enabled: false
        debug:
            usagesOf: []
        filterOutUnmatchedInlineIgnoresDuringPartialAnalysis:
            wrappedErrorFormatter: table
            identifiers:
                - ShipMonk\PHPStan\DeadCode\Rule\DeadCodeRule::IDENTIFIER_METHOD
                - ShipMonk\PHPStan\DeadCode\Rule\DeadCodeRule::IDENTIFIER_CONSTANT
                - ShipMonk\PHPStan\DeadCode\Rule\DeadCodeRule::IDENTIFIER_ENUM_CASE
                - ShipMonk\PHPStan\DeadCode\Rule\DeadCodeRule::IDENTIFIER_PROPERTY_NEVER_READ
                - ShipMonk\PHPStan\DeadCode\Rule\DeadCodeRule::IDENTIFIER_PROPERTY_NEVER_WRITTEN

expandRelativePaths:
    - '[parameters][shipmonkDeadCode][usageProviders][symfony][configDir]'
    - '[parameters][shipmonkDeadCode][usageProviders][symfony][containerXmlPaths]'
    - '[parameters][shipmonkDeadCode][usageProviders][nette][containerNeonPaths]'
    - '[parameters][shipmonkDeadCode][usageProviders][composer][composerJsonPath]'
    - '[parameters][shipmonkDeadCode][usageExcluders][tests][devPaths]'

parametersSchema:
    shipmonkDeadCode: structure([
        trackMixedAccess: schema(bool(), nullable()) # deprecated, use usageExcluders.usageOverMixed.enabled
        reportTransitivelyDeadMethodAsSeparateError: bool()
        cache: structure([
            offloadCollectorData: bool()
        ])
        detect: structure([
            deadMethods: bool()
            deadConstants: bool()
            deadEnumCases: bool()
            deadProperties: structure([
                neverRead: bool()
                neverWritten: bool()
            ])
        ])
        usageProviders: structure([
            apiPhpDoc: structure([
                enabled: bool()
            ])
            enum: structure([
                enabled: bool()
            ])
            vendor: structure([
                enabled: bool()
            ])
            builtin: structure([
                enabled: bool()
            ])
            reflection: structure([
                enabled: bool()
            ])
            phpstan: structure([
                enabled: bool()
            ])
            phpat: structure([
                enabled: schema(bool(), nullable())
            ])
            phpunit: structure([
                enabled: schema(bool(), nullable())
            ])
            phpbench: structure([
                enabled: schema(bool(), nullable())
            ])
            behat: structure([
                enabled: schema(bool(), nullable())
            ])
            symfony: structure([
                enabled: schema(bool(), nullable())
                configDir: schema(string(), nullable())
                containerXmlPaths: listOf(string())
            ])
            twig: structure([
                enabled: schema(bool(), nullable())
            ])
            doctrine: structure([
                enabled: schema(bool(), nullable())
            ])
            eloquent: structure([
                enabled: schema(bool(), nullable())
            ])
            laravel: structure([
                enabled: schema(bool(), nullable())
            ])
            blade: structure([
                enabled: schema(bool(), nullable())
                deduplicateAcrossViews: bool()
            ])
            nette: structure([
                enabled: schema(bool(), nullable())
                containerNeonPaths: listOf(string())
            ])
            netteTester: structure([
                enabled: schema(bool(), nullable())
            ])
            streamWrapper: structure([
                enabled: bool()
            ])
            composer: structure([
                enabled: bool()
                composerJsonPath: schema(string(), nullable())
            ])
        ])
        usageExcluders: structure([
            tests: structure([
                enabled: bool()
                devPaths: schema(listOf(string()), nullable())
            ])
            usageOverMixed: structure([
                enabled: bool()
            ])
        ])
        debug: structure([
            usagesOf: listOf(string())
        ])
        filterOutUnmatchedInlineIgnoresDuringPartialAnalysis: structure([
            wrappedErrorFormatter: string()
            identifiers: listOf(string())
        ])
    ])