Add rule to detect redundant trait usage #912
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This rule detects when a class uses traits redundantly - specifically when
a class uses both a trait A and trait B, where trait A already uses trait B
(either directly or transitively).
For example:
```php
trait BarTrait {
public function bar() {}
}
trait FooTrait {
use BarTrait;
public function foo() {}
}
class MyClass {
use FooTrait;
use BarTrait; // Redundant! Already included via FooTrait
}
```
The rule helps improve code maintainability by:
- Reducing unnecessary trait usage
- Making trait dependencies clearer
- Potentially improving performance by reducing trait resolution overhead
Includes comprehensive test coverage for:
- Direct redundant trait usage
- Transitive redundant trait usage
- Valid non-redundant trait usage
- Single trait usage (no redundancy possible)
- Add Exception import statement instead of using fully qualified name - Add missing newline at end of file
Add strict comparison parameter (true) to in_array() calls as required by PHPStan strict rules configuration.
AronNovak
changed the title
|
My concern is that this isn't entirely specific to Drupal development and could be in its own package. I like the rule and wish PHPStan told me this already. I just don't know if it belongs here. |
|
@mglaman Thanks for the suggestion and the swift response. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a new PHPStan rule
NoRedundantTraitUseRulethat detects when a class uses traits redundantly - specifically when a class uses both a trait A and trait B, where trait A already uses trait B (either directly or transitively).Motivation
This rule was initially developed for a Drupal project where it significantly improved PHPStan analysis performance by identifying and eliminating redundant trait usage.