refactor(HasOptionsRector): remove unused doc comment and simplify code

guanguans · guanguans · commit 32e547bdd212 · 2026-02-07T22:09:29.000+08:00
- Eliminated the getRuleDefinition method and its associated doc comment.
- Streamlined the HasOptionsRector class by removing unnecessary code.
- Improved code clarity and maintainability by focusing on essential functionality.
diff --git a/rector-php82.php b/rector-php82.php
@@ -14,7 +14,7 @@
  */
 
 use Guanguans\Notify\Foundation\Rectors\HasHttpClientDocCommentRector;
-use Guanguans\Notify\Foundation\Rectors\HasOptionsRector;
+use Guanguans\Notify\Foundation\Rectors\MessageRector;
 use Rector\Config\RectorConfig;
 use Rector\Php82\Rector\Param\AddSensitiveParameterAttributeRector;
 use Rector\ValueObject\PhpVersion;
@@ -33,7 +33,7 @@
     ->withPhpVersion(PhpVersion::PHP_82)
     ->withRules([
         HasHttpClientDocCommentRector::class,
-        HasOptionsRector::class,
+        MessageRector::class,
     ])
     ->withConfiguredRule(AddSensitiveParameterAttributeRector::class, [
         AddSensitiveParameterAttributeRector::SENSITIVE_PARAMETERS => [
diff --git a/rector.dist.php b/rector.dist.php
@@ -20,7 +20,7 @@
 use Guanguans\Notify\Foundation\Concerns\HasOptions;
 use Guanguans\Notify\Foundation\Method;
 use Guanguans\Notify\Foundation\Rectors\HasHttpClientDocCommentRector;
-use Guanguans\Notify\Foundation\Rectors\HasOptionsRector;
+use Guanguans\Notify\Foundation\Rectors\MessageRector;
 use Guanguans\Notify\Foundation\Response;
 use Guanguans\RectorRules\Rector\File\AddNoinspectionDocblockToFileFirstStmtRector;
 use Guanguans\RectorRules\Rector\FunctionLike\RenameGarbageParamNameRector;
@@ -106,7 +106,7 @@
     ])
     ->withRules([
         HasHttpClientDocCommentRector::class,
-        HasOptionsRector::class,
+        MessageRector::class,
 
         ArraySpreadInsteadOfArrayMergeRector::class,
         JsonThrowOnErrorRector::class,
diff --git a/src/Foundation/Rectors/MessageRector.php b/src/Foundation/Rectors/MessageRector.php
@@ -34,13 +34,11 @@
 use Rector\PhpParser\Node\Value\ValueResolver;
 use Rector\PhpParser\Parser\SimplePhpParser;
 use Rector\Rector\AbstractRector;
-use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
-use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
 /**
  * @internal
  */
-final class HasOptionsRector extends AbstractRector
+final class MessageRector extends AbstractRector
 {
     public function __construct(
         private readonly DocBlockUpdater $docBlockUpdater,
@@ -49,44 +47,6 @@ public function __construct(
         private readonly ValueResolver $valueResolver,
     ) {}
 
-    /**
-     * @throws \Symplify\RuleDocGenerator\Exception\PoorDocumentationException
-     * @throws \Symplify\RuleDocGenerator\Exception\ShouldNotHappenException
-     */
-    public function getRuleDefinition(): RuleDefinition
-    {
-        return new RuleDefinition(
-            'Has options doc comment',
-            [
-                new ConfiguredCodeSample(
-                    <<<'CODE_SAMPLE'
-                        class Message extends \Guanguans\Notify\Foundation\Message
-                        {
-                            protected array $defined = [
-                                'title',
-                                'content',
-                            ];
-                        }
-                        CODE_SAMPLE,
-                    <<<'CODE_SAMPLE'
-                        /**
-                         * @method self title($title)
-                         * @method self content($content)
-                         */
-                        class Message extends \Guanguans\Notify\Foundation\Message
-                        {
-                            protected array $defined = [
-                                'title',
-                                'content',
-                            ];
-                        }
-                        CODE_SAMPLE,
-                    [Message::class => Message::class],
-                ),
-            ],
-        );
-    }
-
     public function getNodeTypes(): array
     {
         return [Class_::class];
