refactor(rules): Rename 'implement' to 'nativeThrowable'

guanguans · guanguans · commit 86a52b187cc9 · 2026-01-15T19:38:14.000+08:00
- Updated configuration and rule files to use 'nativeThrowable' instead of 'implement'.
- Improved clarity in the code by using more descriptive terminology.
- Ensured consistency across all related files for better maintainability.
diff --git a/config/rules.neon b/config/rules.neon
@@ -6,14 +6,14 @@ parameters:
 	guanguans:
 		allRules: true
 		exceptionMustImplementNativeThrowable:
-			implement: \Throwable
+			nativeThrowable: \Throwable
 			enabled: %guanguans.allRules%
 
 parametersSchema:
 	guanguans: structure([
 		allRules: bool()
 		exceptionMustImplementNativeThrowable: structure([
-			implement: string()
+			nativeThrowable: string()
 			enabled: bool(),
 		])
 	])
@@ -22,4 +22,4 @@ services:
 	-
 		class: Guanguans\PHPStanRules\Rule\ExceptionMustImplementNativeThrowableRule
 		arguments:
-			implement: %guanguans.exceptionMustImplementNativeThrowable.implement%
+			nativeThrowable: %guanguans.exceptionMustImplementNativeThrowable.nativeThrowable%
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -63,7 +63,7 @@ parameters:
             enabled: false
     guanguans:
         exceptionMustImplementNativeThrowable:
-            implement: Guanguans\PHPStanRules\Contract\ThrowableContract
+            nativeThrowable: Guanguans\PHPStanRules\Contract\ThrowableContract
             enabled: false
     cognitive_complexity:
         class: 42
diff --git a/src/Rule/ExceptionMustImplementNativeThrowableRule.php b/src/Rule/ExceptionMustImplementNativeThrowableRule.php
@@ -32,14 +32,14 @@ final class ExceptionMustImplementNativeThrowableRule implements Rule
 {
     /** @api */
     public const ERROR_MESSAGE = 'The exception [%s] must implement the native throwable [%s].';
-    private string $implement;
+    private string $nativeThrowable;
 
     /**
-     * @param class-string<\Throwable> $implement
+     * @param class-string<\Throwable> $nativeThrowable
      */
-    public function __construct(string $implement)
+    public function __construct(string $nativeThrowable)
     {
-        $this->implement = $implement;
+        $this->nativeThrowable = $nativeThrowable;
     }
 
     public function getNodeType(): string
@@ -58,7 +58,7 @@ public function processNode(Node $node, Scope $scope): array
             /** 暂不处理匿名类 `new class() extends Exception {}` 的情况. */
             !$node->class instanceof Name
             || !is_subclass_of($class = $node->class->toString(), \Throwable::class)
-            || is_subclass_of($class, $this->implement)
+            || is_subclass_of($class, $this->nativeThrowable)
         ) {
             return [];
         }
@@ -72,6 +72,6 @@ public function processNode(Node $node, Scope $scope): array
 
     private function createErrorMessage(string $class): string
     {
-        return \sprintf(self::ERROR_MESSAGE, $class, $this->implement);
+        return \sprintf(self::ERROR_MESSAGE, $class, $this->nativeThrowable);
     }
 }
diff --git a/tests/Rule/ExceptionMustImplementNativeThrowableRule/config/configured_rule.neon b/tests/Rule/ExceptionMustImplementNativeThrowableRule/config/configured_rule.neon
@@ -5,5 +5,5 @@ parameters:
     guanguans:
         allRules: false
         exceptionMustImplementNativeThrowable:
-            implement: Guanguans\PHPStanRules\Contract\ThrowableContract
+            nativeThrowable: Guanguans\PHPStanRules\Contract\ThrowableContract
             enabled: true

Original file line number	Diff line number	Diff line change
`@@ -32,14 +32,14 @@ final class ExceptionMustImplementNativeThrowableRule implements Rule`
`32`	`32`	`{`
`33`	`33`	`/** @api */`
`34`	`34`	`public const ERROR_MESSAGE = 'The exception [%s] must implement the native throwable [%s].';`
`35`		`- private string $implement;`
	`35`	`+ private string $nativeThrowable;`
`36`	`36`
`37`	`37`	`/**`
`38`		`- * @param class-string<\Throwable> $implement`
	`38`	`+ * @param class-string<\Throwable> $nativeThrowable`
`39`	`39`	`*/`
`40`		`- public function __construct(string $implement)`
	`40`	`+ public function __construct(string $nativeThrowable)`
`41`	`41`	`{`
`42`		`- $this->implement = $implement;`
	`42`	`+ $this->nativeThrowable = $nativeThrowable;`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`public function getNodeType(): string`
`@@ -58,7 +58,7 @@ public function processNode(Node $node, Scope $scope): array`
`58`	`58`	/** 暂不处理匿名类 `new class() extends Exception {}` 的情况. */
`59`	`59`	`!$node->class instanceof Name`
`60`	`60`	`\|\| !is_subclass_of($class = $node->class->toString(), \Throwable::class)`
`61`		`- \|\| is_subclass_of($class, $this->implement)`
	`61`	`+ \|\| is_subclass_of($class, $this->nativeThrowable)`
`62`	`62`	`) {`
`63`	`63`	`return [];`
`64`	`64`	`}`
`@@ -72,6 +72,6 @@ public function processNode(Node $node, Scope $scope): array`
`72`	`72`
`73`	`73`	`private function createErrorMessage(string $class): string`
`74`	`74`	`{`
`75`		`- return \sprintf(self::ERROR_MESSAGE, $class, $this->implement);`
	`75`	`+ return \sprintf(self::ERROR_MESSAGE, $class, $this->nativeThrowable);`
`76`	`76`	`}`
`77`	`77`	`}`