mirror of
https://github.com/rectorphp/rector.git
synced 2024-06-05 10:50:48 +00:00
Updated Rector to commit ef333de3d58a4649558971b19f4814fd92823abe
ef333de3d5
[DeadCode] Add RemoveUselessReadOnlyTagRector (#5790)
This commit is contained in:
parent
717507e265
commit
dc2feca4d5
|
@ -1,4 +1,4 @@
|
||||||
# 369 Rules Overview
|
# 370 Rules Overview
|
||||||
|
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
|
@ -10,7 +10,7 @@
|
||||||
|
|
||||||
- [CodingStyle](#codingstyle) (28)
|
- [CodingStyle](#codingstyle) (28)
|
||||||
|
|
||||||
- [DeadCode](#deadcode) (43)
|
- [DeadCode](#deadcode) (44)
|
||||||
|
|
||||||
- [EarlyReturn](#earlyreturn) (9)
|
- [EarlyReturn](#earlyreturn) (9)
|
||||||
|
|
||||||
|
@ -2886,6 +2886,29 @@ Remove `@param` docblock with same type as parameter type
|
||||||
|
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
|
### RemoveUselessReadOnlyTagRector
|
||||||
|
|
||||||
|
Remove useless `@readonly` annotation on native readonly type
|
||||||
|
|
||||||
|
- class: [`Rector\DeadCode\Rector\Property\RemoveUselessReadOnlyTagRector`](../rules/DeadCode/Rector/Property/RemoveUselessReadOnlyTagRector.php)
|
||||||
|
|
||||||
|
```diff
|
||||||
|
final class SomeClass
|
||||||
|
{
|
||||||
|
- /**
|
||||||
|
- * @readonly
|
||||||
|
- */
|
||||||
|
private readonly string $name;
|
||||||
|
|
||||||
|
public function __construct(string $name)
|
||||||
|
{
|
||||||
|
$this->name = $name;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
### RemoveUselessReturnExprInConstructRector
|
### RemoveUselessReturnExprInConstructRector
|
||||||
|
|
||||||
Remove useless return Expr in `__construct()`
|
Remove useless return Expr in `__construct()`
|
||||||
|
|
|
@ -0,0 +1,107 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare (strict_types=1);
|
||||||
|
namespace Rector\DeadCode\Rector\Property;
|
||||||
|
|
||||||
|
use PhpParser\Node;
|
||||||
|
use PhpParser\Node\Param;
|
||||||
|
use PhpParser\Node\Stmt\Class_;
|
||||||
|
use PhpParser\Node\Stmt\Property;
|
||||||
|
use PHPStan\PhpDocParser\Ast\PhpDoc\GenericTagValueNode;
|
||||||
|
use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode;
|
||||||
|
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
|
||||||
|
use Rector\Comments\NodeDocBlock\DocBlockUpdater;
|
||||||
|
use Rector\Privatization\NodeManipulator\VisibilityManipulator;
|
||||||
|
use Rector\Rector\AbstractRector;
|
||||||
|
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
|
||||||
|
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
|
||||||
|
/**
|
||||||
|
* @see \Rector\Tests\DeadCode\Rector\Property\RemoveUselessReadOnlyTagRector\RemoveUselessReadOnlyTagRectorTest
|
||||||
|
*/
|
||||||
|
final class RemoveUselessReadOnlyTagRector extends AbstractRector
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* @readonly
|
||||||
|
* @var \Rector\Privatization\NodeManipulator\VisibilityManipulator
|
||||||
|
*/
|
||||||
|
private $visibilityManipulator;
|
||||||
|
/**
|
||||||
|
* @readonly
|
||||||
|
* @var \Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory
|
||||||
|
*/
|
||||||
|
private $phpDocInfoFactory;
|
||||||
|
/**
|
||||||
|
* @readonly
|
||||||
|
* @var \Rector\Comments\NodeDocBlock\DocBlockUpdater
|
||||||
|
*/
|
||||||
|
private $docBlockUpdater;
|
||||||
|
public function __construct(VisibilityManipulator $visibilityManipulator, PhpDocInfoFactory $phpDocInfoFactory, DocBlockUpdater $docBlockUpdater)
|
||||||
|
{
|
||||||
|
$this->visibilityManipulator = $visibilityManipulator;
|
||||||
|
$this->phpDocInfoFactory = $phpDocInfoFactory;
|
||||||
|
$this->docBlockUpdater = $docBlockUpdater;
|
||||||
|
}
|
||||||
|
public function getRuleDefinition() : RuleDefinition
|
||||||
|
{
|
||||||
|
return new RuleDefinition('Remove useless @readonly annotation on native readonly type', [new CodeSample(<<<'CODE_SAMPLE'
|
||||||
|
final class SomeClass
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* @readonly
|
||||||
|
*/
|
||||||
|
private readonly string $name;
|
||||||
|
|
||||||
|
public function __construct(string $name)
|
||||||
|
{
|
||||||
|
$this->name = $name;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
CODE_SAMPLE
|
||||||
|
, <<<'CODE_SAMPLE'
|
||||||
|
final class SomeClass
|
||||||
|
{
|
||||||
|
private readonly string $name;
|
||||||
|
|
||||||
|
public function __construct(string $name)
|
||||||
|
{
|
||||||
|
$this->name = $name;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
CODE_SAMPLE
|
||||||
|
)]);
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* @return array<class-string<Node>>
|
||||||
|
*/
|
||||||
|
public function getNodeTypes() : array
|
||||||
|
{
|
||||||
|
return [Class_::class, Property::class, Param::class];
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* @param Class_|Property|Param $node
|
||||||
|
*/
|
||||||
|
public function refactor(Node $node) : ?Node
|
||||||
|
{
|
||||||
|
// for param, only on property promotion
|
||||||
|
if ($node instanceof Param && $node->flags === 0) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
if (!$this->visibilityManipulator->isReadonly($node)) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
$phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($node);
|
||||||
|
$readonlyDoc = $phpDocInfo->getByName('readonly');
|
||||||
|
if (!$readonlyDoc instanceof PhpDocTagNode) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
if (!$readonlyDoc->value instanceof GenericTagValueNode) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
if ($readonlyDoc->value->value !== '') {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
$phpDocInfo->removeByName('readonly');
|
||||||
|
$this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($node);
|
||||||
|
return $node;
|
||||||
|
}
|
||||||
|
}
|
|
@ -19,12 +19,12 @@ final class VersionResolver
|
||||||
* @api
|
* @api
|
||||||
* @var string
|
* @var string
|
||||||
*/
|
*/
|
||||||
public const PACKAGE_VERSION = '717e3e00ca93c371f8633f6ea17ea1b5e686657a';
|
public const PACKAGE_VERSION = 'ef333de3d58a4649558971b19f4814fd92823abe';
|
||||||
/**
|
/**
|
||||||
* @api
|
* @api
|
||||||
* @var string
|
* @var string
|
||||||
*/
|
*/
|
||||||
public const RELEASE_DATE = '2024-04-03 07:35:59';
|
public const RELEASE_DATE = '2024-04-03 07:36:10';
|
||||||
/**
|
/**
|
||||||
* @var int
|
* @var int
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -38,6 +38,7 @@ use Rector\DeadCode\Rector\If_\UnwrapFutureCompatibleIfPhpVersionRector;
|
||||||
use Rector\DeadCode\Rector\Node\RemoveNonExistingVarAnnotationRector;
|
use Rector\DeadCode\Rector\Node\RemoveNonExistingVarAnnotationRector;
|
||||||
use Rector\DeadCode\Rector\Plus\RemoveDeadZeroAndOneOperationRector;
|
use Rector\DeadCode\Rector\Plus\RemoveDeadZeroAndOneOperationRector;
|
||||||
use Rector\DeadCode\Rector\Property\RemoveUnusedPrivatePropertyRector;
|
use Rector\DeadCode\Rector\Property\RemoveUnusedPrivatePropertyRector;
|
||||||
|
use Rector\DeadCode\Rector\Property\RemoveUselessReadOnlyTagRector;
|
||||||
use Rector\DeadCode\Rector\Property\RemoveUselessVarTagRector;
|
use Rector\DeadCode\Rector\Property\RemoveUselessVarTagRector;
|
||||||
use Rector\DeadCode\Rector\PropertyProperty\RemoveNullPropertyInitializationRector;
|
use Rector\DeadCode\Rector\PropertyProperty\RemoveNullPropertyInitializationRector;
|
||||||
use Rector\DeadCode\Rector\Return_\RemoveDeadConditionAboveReturnRector;
|
use Rector\DeadCode\Rector\Return_\RemoveDeadConditionAboveReturnRector;
|
||||||
|
@ -86,6 +87,7 @@ final class DeadCodeLevel
|
||||||
// docblock
|
// docblock
|
||||||
RemoveUselessParamTagRector::class,
|
RemoveUselessParamTagRector::class,
|
||||||
RemoveUselessReturnTagRector::class,
|
RemoveUselessReturnTagRector::class,
|
||||||
|
RemoveUselessReadOnlyTagRector::class,
|
||||||
RemoveNonExistingVarAnnotationRector::class,
|
RemoveNonExistingVarAnnotationRector::class,
|
||||||
RemoveUselessVarTagRector::class,
|
RemoveUselessVarTagRector::class,
|
||||||
RemovePhpVersionIdCheckRector::class,
|
RemovePhpVersionIdCheckRector::class,
|
||||||
|
|
1
vendor/composer/autoload_classmap.php
vendored
1
vendor/composer/autoload_classmap.php
vendored
|
@ -1288,6 +1288,7 @@ return array(
|
||||||
'Rector\\DeadCode\\Rector\\Plus\\RemoveDeadZeroAndOneOperationRector' => $baseDir . '/rules/DeadCode/Rector/Plus/RemoveDeadZeroAndOneOperationRector.php',
|
'Rector\\DeadCode\\Rector\\Plus\\RemoveDeadZeroAndOneOperationRector' => $baseDir . '/rules/DeadCode/Rector/Plus/RemoveDeadZeroAndOneOperationRector.php',
|
||||||
'Rector\\DeadCode\\Rector\\PropertyProperty\\RemoveNullPropertyInitializationRector' => $baseDir . '/rules/DeadCode/Rector/PropertyProperty/RemoveNullPropertyInitializationRector.php',
|
'Rector\\DeadCode\\Rector\\PropertyProperty\\RemoveNullPropertyInitializationRector' => $baseDir . '/rules/DeadCode/Rector/PropertyProperty/RemoveNullPropertyInitializationRector.php',
|
||||||
'Rector\\DeadCode\\Rector\\Property\\RemoveUnusedPrivatePropertyRector' => $baseDir . '/rules/DeadCode/Rector/Property/RemoveUnusedPrivatePropertyRector.php',
|
'Rector\\DeadCode\\Rector\\Property\\RemoveUnusedPrivatePropertyRector' => $baseDir . '/rules/DeadCode/Rector/Property/RemoveUnusedPrivatePropertyRector.php',
|
||||||
|
'Rector\\DeadCode\\Rector\\Property\\RemoveUselessReadOnlyTagRector' => $baseDir . '/rules/DeadCode/Rector/Property/RemoveUselessReadOnlyTagRector.php',
|
||||||
'Rector\\DeadCode\\Rector\\Property\\RemoveUselessVarTagRector' => $baseDir . '/rules/DeadCode/Rector/Property/RemoveUselessVarTagRector.php',
|
'Rector\\DeadCode\\Rector\\Property\\RemoveUselessVarTagRector' => $baseDir . '/rules/DeadCode/Rector/Property/RemoveUselessVarTagRector.php',
|
||||||
'Rector\\DeadCode\\Rector\\Return_\\RemoveDeadConditionAboveReturnRector' => $baseDir . '/rules/DeadCode/Rector/Return_/RemoveDeadConditionAboveReturnRector.php',
|
'Rector\\DeadCode\\Rector\\Return_\\RemoveDeadConditionAboveReturnRector' => $baseDir . '/rules/DeadCode/Rector/Return_/RemoveDeadConditionAboveReturnRector.php',
|
||||||
'Rector\\DeadCode\\Rector\\StaticCall\\RemoveParentCallWithoutParentRector' => $baseDir . '/rules/DeadCode/Rector/StaticCall/RemoveParentCallWithoutParentRector.php',
|
'Rector\\DeadCode\\Rector\\StaticCall\\RemoveParentCallWithoutParentRector' => $baseDir . '/rules/DeadCode/Rector/StaticCall/RemoveParentCallWithoutParentRector.php',
|
||||||
|
|
1
vendor/composer/autoload_static.php
vendored
1
vendor/composer/autoload_static.php
vendored
|
@ -1507,6 +1507,7 @@ class ComposerStaticInit67be42e0079886f0083b7116ae1de531
|
||||||
'Rector\\DeadCode\\Rector\\Plus\\RemoveDeadZeroAndOneOperationRector' => __DIR__ . '/../..' . '/rules/DeadCode/Rector/Plus/RemoveDeadZeroAndOneOperationRector.php',
|
'Rector\\DeadCode\\Rector\\Plus\\RemoveDeadZeroAndOneOperationRector' => __DIR__ . '/../..' . '/rules/DeadCode/Rector/Plus/RemoveDeadZeroAndOneOperationRector.php',
|
||||||
'Rector\\DeadCode\\Rector\\PropertyProperty\\RemoveNullPropertyInitializationRector' => __DIR__ . '/../..' . '/rules/DeadCode/Rector/PropertyProperty/RemoveNullPropertyInitializationRector.php',
|
'Rector\\DeadCode\\Rector\\PropertyProperty\\RemoveNullPropertyInitializationRector' => __DIR__ . '/../..' . '/rules/DeadCode/Rector/PropertyProperty/RemoveNullPropertyInitializationRector.php',
|
||||||
'Rector\\DeadCode\\Rector\\Property\\RemoveUnusedPrivatePropertyRector' => __DIR__ . '/../..' . '/rules/DeadCode/Rector/Property/RemoveUnusedPrivatePropertyRector.php',
|
'Rector\\DeadCode\\Rector\\Property\\RemoveUnusedPrivatePropertyRector' => __DIR__ . '/../..' . '/rules/DeadCode/Rector/Property/RemoveUnusedPrivatePropertyRector.php',
|
||||||
|
'Rector\\DeadCode\\Rector\\Property\\RemoveUselessReadOnlyTagRector' => __DIR__ . '/../..' . '/rules/DeadCode/Rector/Property/RemoveUselessReadOnlyTagRector.php',
|
||||||
'Rector\\DeadCode\\Rector\\Property\\RemoveUselessVarTagRector' => __DIR__ . '/../..' . '/rules/DeadCode/Rector/Property/RemoveUselessVarTagRector.php',
|
'Rector\\DeadCode\\Rector\\Property\\RemoveUselessVarTagRector' => __DIR__ . '/../..' . '/rules/DeadCode/Rector/Property/RemoveUselessVarTagRector.php',
|
||||||
'Rector\\DeadCode\\Rector\\Return_\\RemoveDeadConditionAboveReturnRector' => __DIR__ . '/../..' . '/rules/DeadCode/Rector/Return_/RemoveDeadConditionAboveReturnRector.php',
|
'Rector\\DeadCode\\Rector\\Return_\\RemoveDeadConditionAboveReturnRector' => __DIR__ . '/../..' . '/rules/DeadCode/Rector/Return_/RemoveDeadConditionAboveReturnRector.php',
|
||||||
'Rector\\DeadCode\\Rector\\StaticCall\\RemoveParentCallWithoutParentRector' => __DIR__ . '/../..' . '/rules/DeadCode/Rector/StaticCall/RemoveParentCallWithoutParentRector.php',
|
'Rector\\DeadCode\\Rector\\StaticCall\\RemoveParentCallWithoutParentRector' => __DIR__ . '/../..' . '/rules/DeadCode/Rector/StaticCall/RemoveParentCallWithoutParentRector.php',
|
||||||
|
|
Loading…
Reference in New Issue
Block a user