Improved error message

Author: rochamarcelo

src/Rule/Debug/DisallowDebugFunctionsRule.php

@@ -61,10 +61,11 @@ public function processNode(Node $node, Scope $scope): array
 
         return [
             RuleErrorBuilder::message(sprintf(
-                'Use of debug function "%s" is not allowed',
+                'Use of debug function "%s" is not allowed. %s',
                 $usedName,
+                'The use in shipped code is discouraged because they can leak sensitive information or clutter output.',
             ))
-            ->identifier('cake.entity.arrayAccess')
+            ->identifier('cake.debug.debugFunctionUse')
             ->build(),
         ];
     }

tests/TestCase/Rule/Debug/DisallowDebugFunctionsRuleTest.php

@@ -28,47 +28,47 @@ public function testRule(): void
         // each error consists of the asserted error message, and the asserted error file line
         $this->analyse([__DIR__ . '/Fake/FailingDebugUseLogic.php'], [
             [
-                'Use of debug function "debug" is not allowed',
+                'Use of debug function "debug" is not allowed. The use in shipped code is discouraged because they can leak sensitive information or clutter output.',
                 14, // asserted error line
             ],
             [
-                'Use of debug function "debug_print_backtrace" is not allowed',
+                'Use of debug function "debug_print_backtrace" is not allowed. The use in shipped code is discouraged because they can leak sensitive information or clutter output.',
                 15, // asserted error line
             ],
             [
-                'Use of debug function "debug_zval_dump" is not allowed',
+                'Use of debug function "debug_zval_dump" is not allowed. The use in shipped code is discouraged because they can leak sensitive information or clutter output.',
                 16, // asserted error line
             ],
             [
-                'Use of debug function "print_r" is not allowed',
+                'Use of debug function "print_r" is not allowed. The use in shipped code is discouraged because they can leak sensitive information or clutter output.',
                 19, // asserted error line
             ],
             [
-                'Use of debug function "print_r" is not allowed',
+                'Use of debug function "print_r" is not allowed. The use in shipped code is discouraged because they can leak sensitive information or clutter output.',
                 20, // asserted error line
             ],
             [
-                'Use of debug function "var_dump" is not allowed',
+                'Use of debug function "var_dump" is not allowed. The use in shipped code is discouraged because they can leak sensitive information or clutter output.',
                 21, // asserted error line
             ],
             [
-                'Use of debug function "var_export" is not allowed',
+                'Use of debug function "var_export" is not allowed. The use in shipped code is discouraged because they can leak sensitive information or clutter output.',
                 23, // asserted error line
             ],
             [
-                'Use of debug function "var_export" is not allowed',
+                'Use of debug function "var_export" is not allowed. The use in shipped code is discouraged because they can leak sensitive information or clutter output.',
                 24, // asserted error line
             ],
             [
-                'Use of debug function "stackTrace" is not allowed',
+                'Use of debug function "stackTrace" is not allowed. The use in shipped code is discouraged because they can leak sensitive information or clutter output.',
                 25, // asserted error line
             ],
             [
-                'Use of debug function "pr" is not allowed',
+                'Use of debug function "pr" is not allowed. The use in shipped code is discouraged because they can leak sensitive information or clutter output.',
                 26, // asserted error line
             ],
             [
-                'Use of debug function "dd" is not allowed',
+                'Use of debug function "dd" is not allowed. The use in shipped code is discouraged because they can leak sensitive information or clutter output.',
                 28, // asserted error line
             ],
         ]);