⬆️ Standardization of the rules structure

Author: martinsoenen

README.md

@@ -57,7 +57,7 @@ Ensure banned functions like `dd()` are not called.
 
 *Identifier : xefi.booleanPropertyNaming*
 
-Ensure that a Boolean is always named with an “is” at the beginning of its name, to clarify the condition it represents.
+Ensure that a Boolean is always named with an `is` at the beginning of its name, to clarify the condition it represents.
 
 ### Max Line Per Class Rule
 

src/Rules/BooleanPropertyNamingRule.php

@@ -25,7 +25,6 @@ public function processNode(Node $node, Scope $scope): array
 
             if ($propertyType === "bool" && substr($propertyName, 0, 2 ) !== "is") {
                 $errors[] = RuleErrorBuilder::message('A boolean property should start with "is".')
-                    ->line($node->getLine())
                     ->identifier('xefi.booleanPropertyNaming')
                     ->build();
             }

src/Rules/MaxLinePerClassRule.php

@@ -28,13 +28,17 @@ public function processNode(Node $node, Scope $scope): array
             return [
                 RuleErrorBuilder::message(
                     sprintf(
-                        'The %s class has more than %d code lines. Please reduce it. The recommended class length is %d lines.',
+                        'The %s class has more than %d code lines. Please reduce it.',
                         $node->name->toString(),
-                        self::MAX_LINES,
+                        self::MAX_LINES
+                    )
+                )
+                ->tip(
+                    sprintf(
+                        'The recommended class length is %d lines.',
                         self::RECOMMENDED_LINES
                     )
                 )
-                ->line($node->getLine())
                 ->identifier('xefi.maxLinePerClass')
                 ->build(),
             ];

src/Rules/MaxLinePerMethodRule.php

@@ -28,13 +28,17 @@ public function processNode(Node $node, Scope $scope): array
             return [
                 RuleErrorBuilder::message(
                     sprintf(
-                        'The %s function has more than %d code lines. Please reduce it. The recommended method length is %d lines.',
+                        'The %s function has more than %d code lines. Please reduce it.',
                         $node->name->toString(),
-                        self::MAX_LINES,
+                        self::MAX_LINES
+                    )
+                )
+                ->tip(
+                    sprintf(
+                        'The recommended method length is %d lines.',
                         self::RECOMMENDED_LINES
                     )
                 )
-                ->line($node->getLine())
                 ->identifier('xefi.maxLinePerMethod')
                 ->build(),
             ];

src/Rules/NoBasicExceptionRule.php

@@ -21,7 +21,6 @@ public function processNode(Node $node, Scope $scope): array
             if ($exceptionClass instanceof Node\Name && $exceptionClass->toString() === 'Exception') {
                 return [
                     RuleErrorBuilder::message('Basic exceptions are not allowed. Please create a custom Exception instead.')
-                        ->line($node->getLine())
                         ->identifier('xefi.noBasicException')
                         ->build()
                 ];

src/Rules/NoGenericWordRule.php

@@ -64,7 +64,6 @@ public function processNode(Node $node, Scope $scope): array
                         $varName
                     )
                 )
-                ->line($node->getLine())
                 ->identifier('xefi.noGenericWord')
                 ->build()
             ];

src/Rules/NoLaravelObserverRule.php

@@ -34,7 +34,6 @@ protected function checkObserveMethod(array &$errors, Node $node) : void
     {
         if ($node instanceof Node\Expr\StaticCall && $node->name?->toString() === 'observe') {
             $errors[] = RuleErrorBuilder::message('Observers are forbidden because it can create technical debt. Please use Event & Listeners instead.')
-                ->line($node->getLine())
                 ->identifier(self::$ruleIdentifier)
                 ->build();
         }
@@ -48,7 +47,6 @@ protected function checkClassesAndNamespaces(array &$errors, Node $node, Scope $
 
             if (str_ends_with($className, 'Observer') || str_contains($namespace, 'Observers')) {
                 $errors[] = RuleErrorBuilder::message('Observers are forbidden because it can create technical debt. Please use Event & Listeners instead.')
-                    ->line($node->getLine())
                     ->identifier(self::$ruleIdentifier)
                     ->build();
             }
@@ -62,7 +60,6 @@ protected function checkObservedByAttribute(array &$errors, Node $node) : void
                 foreach ($attrGroup->attrs as $attr) {
                     if ($attr->name->getParts() !== null && in_array('ObservedBy', $attr->name->getParts(), true)) {
                         $errors[] = RuleErrorBuilder::message('Observers are forbidden because it can create technical debt. Please use Event & Listeners instead.')
-                            ->line($node->getLine())
                             ->identifier(self::$ruleIdentifier)
                             ->build();
                         break 2;

src/Rules/NoTryCatchRule.php

@@ -19,7 +19,6 @@ public function processNode(Node $node, Scope $scope): array
     {
         return [
             RuleErrorBuilder::message("Try-catch's are forbidden. Please use Exceptions instead.")
-                ->line($node->getLine())
                 ->identifier('xefi.noTryCatch')
                 ->build(),
         ];

tests/Rules/MaxLinePerClassRuleTest.php

@@ -23,7 +23,8 @@ public function testRuleDumpAnException(): void
         // each error consists of the asserted error message, and the asserted error file line
         $this->analyse([__DIR__ . '/data/MaxLinePerClassRule/TwoHundredLinesClass.php'], [
             [
-                "The TwoHundredLinesClass class has more than 200 code lines. Please reduce it. The recommended class length is 100 lines.", // asserted error message
+                "The TwoHundredLinesClass class has more than 200 code lines. Please reduce it.
+    💡 The recommended class length is 100 lines.", // asserted error message
                 5, // asserted error line
             ],
         ]);

tests/Rules/MaxLinePerMethodRuleTest.php

@@ -23,7 +23,8 @@ public function testWithMultipleLines(): void
         // each error consists of the asserted error message, and the asserted error file line
         $this->analyse([__DIR__ . '/data/MaxLinePerMethodRule/MultipleLinesMethods.php'], [
             [
-                "The fortyOneLines function has more than 40 code lines. Please reduce it. The recommended method length is 20 lines.", // asserted error message
+                "The fortyOneLines function has more than 40 code lines. Please reduce it.
+    💡 The recommended method length is 20 lines.", // asserted error message
                 93, // asserted error line
             ],
         ]);