Use active voice and improve rule definitions

simonschaufi · simonschaufi · commit 00e53e515dc6 · 2025-08-13T21:31:40.000+02:00
diff --git a/rules/Arguments/Rector/ClassMethod/ArgumentAdderRector.php b/rules/Arguments/Rector/ClassMethod/ArgumentAdderRector.php
@@ -55,7 +55,7 @@ public function __construct(
     public function getRuleDefinition(): RuleDefinition
     {
         return new RuleDefinition(
-            'This Rector adds new default arguments in calls of defined methods and class types.',
+            'Add new default arguments in calls of defined methods and class types',
             [
                 new ConfiguredCodeSample(
                     <<<'CODE_SAMPLE'
diff --git a/rules/Arguments/Rector/ClassMethod/ReplaceArgumentDefaultValueRector.php b/rules/Arguments/Rector/ClassMethod/ReplaceArgumentDefaultValueRector.php
@@ -37,7 +37,7 @@ public function __construct(
     public function getRuleDefinition(): RuleDefinition
     {
         return new RuleDefinition(
-            'Replaces defined map of arguments in defined methods and their calls.',
+            'Replace defined map of arguments in defined methods and their calls',
             [
                 new ConfiguredCodeSample(
                     <<<'CODE_SAMPLE'
diff --git a/rules/CodeQuality/Rector/Include_/AbsolutizeRequireAndIncludePathRector.php b/rules/CodeQuality/Rector/Include_/AbsolutizeRequireAndIncludePathRector.php
@@ -35,7 +35,7 @@ public function __construct(
     public function getRuleDefinition(): RuleDefinition
     {
         return new RuleDefinition(
-            'include/require to absolute path. This Rector might introduce backwards incompatible code, when the include/require being changed depends on the current working directory.',
+            'Migrate include/require to absolute path. This Rector might introduce backwards incompatible code, when the include/require being changed depends on the current working directory.',
             [
                 new CodeSample(
                     <<<'CODE_SAMPLE'
diff --git a/rules/DeadCode/Rector/Array_/RemoveDuplicatedArrayKeyRector.php b/rules/DeadCode/Rector/Array_/RemoveDuplicatedArrayKeyRector.php
@@ -30,7 +30,7 @@ public function __construct(
 
     public function getRuleDefinition(): RuleDefinition
     {
-        return new RuleDefinition('Remove duplicated key in defined arrays.', [
+        return new RuleDefinition('Remove duplicated key in defined arrays', [
             new CodeSample(
                 <<<'CODE_SAMPLE'
 $item = [
diff --git a/rules/Php70/Rector/ClassMethod/Php4ConstructorRector.php b/rules/Php70/Rector/ClassMethod/Php4ConstructorRector.php
@@ -47,7 +47,7 @@ public function provideMinPhpVersion(): int
     public function getRuleDefinition(): RuleDefinition
     {
         return new RuleDefinition(
-            'Changes PHP 4 style constructor to __construct.',
+            'Change PHP 4 style constructor to `__construct`',
             [
                 new CodeSample(
                     <<<'CODE_SAMPLE'
diff --git a/rules/Php70/Rector/FunctionLike/ExceptionHandlerTypehintRector.php b/rules/Php70/Rector/FunctionLike/ExceptionHandlerTypehintRector.php
@@ -30,7 +30,7 @@ final class ExceptionHandlerTypehintRector extends AbstractRector implements Min
     public function getRuleDefinition(): RuleDefinition
     {
         return new RuleDefinition(
-            'Change typehint from `Exception` to `Throwable`.',
+            'Change typehint from `Exception` to `Throwable`',
             [
                 new CodeSample(
                     <<<'CODE_SAMPLE'
diff --git a/rules/Php71/Rector/TryCatch/MultiExceptionCatchRector.php b/rules/Php71/Rector/TryCatch/MultiExceptionCatchRector.php
@@ -26,7 +26,7 @@ public function __construct(
     public function getRuleDefinition(): RuleDefinition
     {
         return new RuleDefinition(
-            'Changes multi catch of same exception to single one | separated.',
+            'Change multiple catch statements of the same exception to a single one `|` separated',
             [
                 new CodeSample(
                     <<<'CODE_SAMPLE'
diff --git a/rules/Php72/Rector/While_/WhileEachToForeachRector.php b/rules/Php72/Rector/While_/WhileEachToForeachRector.php
@@ -35,7 +35,7 @@ public function provideMinPhpVersion(): int
     public function getRuleDefinition(): RuleDefinition
     {
         return new RuleDefinition(
-            'each() function is deprecated, use foreach() instead.',
+            'Use `foreach()` instead of `each()`',
             [
                 new CodeSample(
                     <<<'CODE_SAMPLE'
diff --git a/rules/Php73/Rector/ConstFetch/SensitiveConstantNameRector.php b/rules/Php73/Rector/ConstFetch/SensitiveConstantNameRector.php
@@ -96,7 +96,7 @@ public function provideMinPhpVersion(): int
     public function getRuleDefinition(): RuleDefinition
     {
         return new RuleDefinition(
-            'Changes case insensitive constants to sensitive ones.',
+            'Change case insensitive constants to sensitive ones',
             [
                 new CodeSample(
                     <<<'CODE_SAMPLE'
diff --git a/rules/Php73/Rector/FuncCall/SensitiveDefineRector.php b/rules/Php73/Rector/FuncCall/SensitiveDefineRector.php
@@ -25,7 +25,7 @@ public function provideMinPhpVersion(): int
     public function getRuleDefinition(): RuleDefinition
     {
         return new RuleDefinition(
-            'Changes case insensitive constants to sensitive ones.',
+            'Change case insensitive constant definition to sensitive one',
             [new CodeSample(
                 <<<'CODE_SAMPLE'
 define('FOO', 42, true);
diff --git a/rules/Php74/Rector/FuncCall/MoneyFormatToNumberFormatRector.php b/rules/Php74/Rector/FuncCall/MoneyFormatToNumberFormatRector.php
@@ -39,7 +39,7 @@ public function provideMinPhpVersion(): int
     public function getRuleDefinition(): RuleDefinition
     {
         return new RuleDefinition(
-            'Change money_format() to equivalent number_format()',
+            'Change `money_format()` to equivalent `number_format()`',
             [
                 new CodeSample(
                     <<<'CODE_SAMPLE'
diff --git a/rules/Php82/Rector/New_/FilesystemIteratorSkipDotsRector.php b/rules/Php82/Rector/New_/FilesystemIteratorSkipDotsRector.php
@@ -32,7 +32,7 @@ public function __construct(
     public function getRuleDefinition(): RuleDefinition
     {
         return new RuleDefinition(
-            'Prior PHP 8.2 FilesystemIterator::SKIP_DOTS was always set and could not be removed, therefore FilesystemIterator::SKIP_DOTS is added in order to keep this behaviour.',
+            'Prior PHP 8.2 FilesystemIterator::SKIP_DOTS was always set and could not be removed, therefore FilesystemIterator::SKIP_DOTS is added in order to keep this behaviour',
             [
                 new CodeSample(
                     'new FilesystemIterator(__DIR__, FilesystemIterator::KEY_AS_FILENAME);',
diff --git a/rules/Php83/Rector/FuncCall/RemoveGetClassGetParentClassNoArgsRector.php b/rules/Php83/Rector/FuncCall/RemoveGetClassGetParentClassNoArgsRector.php
@@ -23,7 +23,7 @@ final class RemoveGetClassGetParentClassNoArgsRector extends AbstractRector impl
     public function getRuleDefinition(): RuleDefinition
     {
         return new RuleDefinition(
-            'Replace calls to get_class() and get_parent_class() without arguments with self::class and parent::class.',
+            'Replace calls to `get_class()` and `get_parent_class()` without arguments with `self::class` and `parent::class`',
             [
                 new CodeSample(
                     <<<'OLD_CODE_SAMPLE'
diff --git a/rules/Removing/Rector/ClassMethod/ArgumentRemoverRector.php b/rules/Removing/Rector/ClassMethod/ArgumentRemoverRector.php
@@ -38,7 +38,7 @@ public function __construct(
     public function getRuleDefinition(): RuleDefinition
     {
         return new RuleDefinition(
-            'Removes defined arguments in defined methods and their calls.',
+            'Remove defined arguments in defined methods and their calls',
             [
                 new ConfiguredCodeSample(
                     <<<'CODE_SAMPLE'
diff --git a/rules/Renaming/Rector/ClassConstFetch/RenameClassConstFetchRector.php b/rules/Renaming/Rector/ClassConstFetch/RenameClassConstFetchRector.php
@@ -30,7 +30,7 @@ final class RenameClassConstFetchRector extends AbstractRector implements Config
     public function getRuleDefinition(): RuleDefinition
     {
         return new RuleDefinition(
-            'Replaces defined class constants in their calls.',
+            'Replace defined class constants in their calls',
             [
                 new ConfiguredCodeSample(
                     <<<'CODE_SAMPLE'
diff --git a/rules/Renaming/Rector/ClassMethod/RenameAnnotationRector.php b/rules/Renaming/Rector/ClassMethod/RenameAnnotationRector.php
@@ -41,7 +41,7 @@ public function __construct(
     public function getRuleDefinition(): RuleDefinition
     {
         return new RuleDefinition(
-            'Turns defined annotations above properties and methods to their new values.',
+            'Turn defined annotations above properties and methods to their new values',
             [
                 new ConfiguredCodeSample(
                     <<<'CODE_SAMPLE'
diff --git a/rules/Visibility/Rector/ClassConst/ChangeConstantVisibilityRector.php b/rules/Visibility/Rector/ClassConst/ChangeConstantVisibilityRector.php
@@ -34,7 +34,7 @@ public function __construct(
     public function getRuleDefinition(): RuleDefinition
     {
         return new RuleDefinition(
-            'Change visibility of constant from parent class.',
+            'Change visibility of constant from parent class',
             [
                 new ConfiguredCodeSample(
                     <<<'CODE_SAMPLE'
diff --git a/rules/Visibility/Rector/ClassMethod/ChangeMethodVisibilityRector.php b/rules/Visibility/Rector/ClassMethod/ChangeMethodVisibilityRector.php
@@ -36,7 +36,7 @@ public function __construct(
     public function getRuleDefinition(): RuleDefinition
     {
         return new RuleDefinition(
-            'Change visibility of method from parent class.',
+            'Change visibility of method from parent class',
             [
                 new ConfiguredCodeSample(
                     <<<'CODE_SAMPLE'
diff --git a/rules/Visibility/Rector/ClassMethod/ExplicitPublicClassMethodRector.php b/rules/Visibility/Rector/ClassMethod/ExplicitPublicClassMethodRector.php
@@ -24,7 +24,7 @@ public function __construct(
     public function getRuleDefinition(): RuleDefinition
     {
         return new RuleDefinition(
-            'Add explicit public method visibility.',
+            'Add explicit public method visibility',
             [
                 new CodeSample(
                     <<<'CODE_SAMPLE'

Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ public function __construct(`
`55`	`55`	`public function getRuleDefinition(): RuleDefinition`
`56`	`56`	`{`
`57`	`57`	`return new RuleDefinition(`
`58`		`- 'This Rector adds new default arguments in calls of defined methods and class types.',`
	`58`	`+ 'Add new default arguments in calls of defined methods and class types',`
`59`	`59`	`[`
`60`	`60`	`new ConfiguredCodeSample(`
`61`	`61`	`<<<'CODE_SAMPLE'`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ public function __construct(`
`37`	`37`	`public function getRuleDefinition(): RuleDefinition`
`38`	`38`	`{`
`39`	`39`	`return new RuleDefinition(`
`40`		`- 'Replaces defined map of arguments in defined methods and their calls.',`
	`40`	`+ 'Replace defined map of arguments in defined methods and their calls',`
`41`	`41`	`[`
`42`	`42`	`new ConfiguredCodeSample(`
`43`	`43`	`<<<'CODE_SAMPLE'`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ public function __construct(`
`35`	`35`	`public function getRuleDefinition(): RuleDefinition`
`36`	`36`	`{`
`37`	`37`	`return new RuleDefinition(`
`38`		`- 'include/require to absolute path. This Rector might introduce backwards incompatible code, when the include/require being changed depends on the current working directory.',`
	`38`	`+ 'Migrate include/require to absolute path. This Rector might introduce backwards incompatible code, when the include/require being changed depends on the current working directory.',`
`39`	`39`	`[`
`40`	`40`	`new CodeSample(`
`41`	`41`	`<<<'CODE_SAMPLE'`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ public function __construct(`
`30`	`30`
`31`	`31`	`public function getRuleDefinition(): RuleDefinition`
`32`	`32`	`{`
`33`		`- return new RuleDefinition('Remove duplicated key in defined arrays.', [`
	`33`	`+ return new RuleDefinition('Remove duplicated key in defined arrays', [`
`34`	`34`	`new CodeSample(`
`35`	`35`	`<<<'CODE_SAMPLE'`
`36`	`36`	`$item = [`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ public function provideMinPhpVersion(): int`
`47`	`47`	`public function getRuleDefinition(): RuleDefinition`
`48`	`48`	`{`
`49`	`49`	`return new RuleDefinition(`
`50`		`- 'Changes PHP 4 style constructor to __construct.',`
	`50`	+ 'Change PHP 4 style constructor to `__construct`',
`51`	`51`	`[`
`52`	`52`	`new CodeSample(`
`53`	`53`	`<<<'CODE_SAMPLE'`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ final class ExceptionHandlerTypehintRector extends AbstractRector implements Min`
`30`	`30`	`public function getRuleDefinition(): RuleDefinition`
`31`	`31`	`{`
`32`	`32`	`return new RuleDefinition(`
`33`		- 'Change typehint from `Exception` to `Throwable`.',
	`33`	+ 'Change typehint from `Exception` to `Throwable`',
`34`	`34`	`[`
`35`	`35`	`new CodeSample(`
`36`	`36`	`<<<'CODE_SAMPLE'`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ public function __construct(`
`26`	`26`	`public function getRuleDefinition(): RuleDefinition`
`27`	`27`	`{`
`28`	`28`	`return new RuleDefinition(`
`29`		`- 'Changes multi catch of same exception to single one \| separated.',`
	`29`	+ 'Change multiple catch statements of the same exception to a single one `\|` separated',
`30`	`30`	`[`
`31`	`31`	`new CodeSample(`
`32`	`32`	`<<<'CODE_SAMPLE'`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ public function provideMinPhpVersion(): int`
`35`	`35`	`public function getRuleDefinition(): RuleDefinition`
`36`	`36`	`{`
`37`	`37`	`return new RuleDefinition(`
`38`		`- 'each() function is deprecated, use foreach() instead.',`
	`38`	+ 'Use `foreach()` instead of `each()`',
`39`	`39`	`[`
`40`	`40`	`new CodeSample(`
`41`	`41`	`<<<'CODE_SAMPLE'`
Original file line number	Diff line number	Diff line change
`@@ -96,7 +96,7 @@ public function provideMinPhpVersion(): int`
`96`	`96`	`public function getRuleDefinition(): RuleDefinition`
`97`	`97`	`{`
`98`	`98`	`return new RuleDefinition(`
`99`		`- 'Changes case insensitive constants to sensitive ones.',`
	`99`	`+ 'Change case insensitive constants to sensitive ones',`
`100`	`100`	`[`
`101`	`101`	`new CodeSample(`
`102`	`102`	`<<<'CODE_SAMPLE'`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ public function provideMinPhpVersion(): int`
`25`	`25`	`public function getRuleDefinition(): RuleDefinition`
`26`	`26`	`{`
`27`	`27`	`return new RuleDefinition(`
`28`		`- 'Changes case insensitive constants to sensitive ones.',`
	`28`	`+ 'Change case insensitive constant definition to sensitive one',`
`29`	`29`	`[new CodeSample(`
`30`	`30`	`<<<'CODE_SAMPLE'`
`31`	`31`	`define('FOO', 42, true);`