Add error tips for better developer experience

Author: paulbalandan

src/Rules/Classes/CacheHandlerInstantiationRule.php

@@ -55,9 +55,14 @@ public function processNode(Node $node, Scope $scope): array
             return [];
         }
 
-        return [RuleErrorBuilder::message(sprintf(
-            'Calling new %s() directly is not allowed. Use CacheFactory::getHandler() to get the cache instance.',
-            $reflection->getNativeReflection()->getShortName(),
-        ))->identifier('codeigniter.cacheHandlerInstance')->build()];
+        return [
+            RuleErrorBuilder::message(sprintf(
+                'Calling new %s() directly is incomplete to get the cache instance.',
+                $reflection->getNativeReflection()->getShortName(),
+            ))
+                ->tip('Use CacheFactory::getHandler() or the cache() function to get the cache instance instead.')
+                ->identifier('codeigniter.cacheHandlerInstance')
+                ->build(),
+        ];
     }
 }

src/Rules/Functions/FactoriesFunctionArgumentTypeRule.php

@@ -89,6 +89,10 @@ public function processNode(Node $node, Scope $scope): array
                 $firstParameter->getName(),
                 $function,
                 $nameType->describe(VerbosityLevel::precise())
+            ))->tip(sprintf(
+                'If %s is a valid class string, you can add its possible namespace(s) in <fg=cyan>codeigniter.additional%sNamespaces</> in your <fg=yellow>%%configurationFile%%</>.',
+                $nameType->describe(VerbosityLevel::precise()),
+                ucfirst($function)
             ))->identifier(sprintf('codeigniter.%sArgumentType', $function))->build()];
         }
 

tests/Rules/Classes/CacheHandlerInstantiationRuleTest.php

@@ -38,12 +38,14 @@ public function testRule(): void
     {
         $this->analyse([__DIR__ . '/../../Fixtures/Rules/Classes/cache-handler.php'], [
             [
-                'Calling new FileHandler() directly is not allowed. Use CacheFactory::getHandler() to get the cache instance.',
+                'Calling new FileHandler() directly is incomplete to get the cache instance.',
                 18,
+                'Use CacheFactory::getHandler() or the cache() function to get the cache instance instead.',
             ],
             [
-                'Calling new RedisHandler() directly is not allowed. Use CacheFactory::getHandler() to get the cache instance.',
+                'Calling new RedisHandler() directly is incomplete to get the cache instance.',
                 19,
+                'Use CacheFactory::getHandler() or the cache() function to get the cache instance instead.',
             ],
         ]);
     }

tests/Rules/Functions/FactoriesFunctionArgumentTypeRuleTest.php

@@ -47,10 +47,12 @@ public function testRule(): void
             [
                 'Parameter #1 $name of function config expects a valid class string, \'bar\' given.',
                 23,
+                'If \'bar\' is a valid class string, you can add its possible namespace(s) in <fg=cyan>codeigniter.additionalConfigNamespaces</> in your <fg=yellow>%configurationFile%</>.',
             ],
             [
                 'Parameter #1 $name of function config expects a valid class string, \'Foo\\\\Bar\' given.',
                 24,
+                'If \'Foo\\\\Bar\' is a valid class string, you can add its possible namespace(s) in <fg=cyan>codeigniter.additionalConfigNamespaces</> in your <fg=yellow>%configurationFile%</>.',
             ],
             [
                 'Argument #1 $name (\'Foo\'|\'stdClass\') passed to function config does not extend CodeIgniter\\\\Config\\\\BaseConfig.',
@@ -63,6 +65,7 @@ public function testRule(): void
             [
                 'Parameter #1 $name of function model expects a valid class string, \'foo\' given.',
                 18,
+                'If \'foo\' is a valid class string, you can add its possible namespace(s) in <fg=cyan>codeigniter.additionalModelNamespaces</> in your <fg=yellow>%configurationFile%</>.',
             ],
             [
                 'Argument #1 $name (\'stdClass\') passed to function model does not extend CodeIgniter\\\\Model.',
@@ -75,6 +78,7 @@ public function testRule(): void
             [
                 'Parameter #1 $name of function model expects a valid class string, \'App\' given.',
                 21,
+                'If \'App\' is a valid class string, you can add its possible namespace(s) in <fg=cyan>codeigniter.additionalModelNamespaces</> in your <fg=yellow>%configurationFile%</>.',
             ],
             [
                 'Argument #1 $name (\'Foo\'|\'stdClass\') passed to function model does not extend CodeIgniter\\\\Model.',