remove hook_info special handling

pfrenssen · Jan 21, 2025 · d87116f · d87116f
1 parent 988f22f
commit d87116f
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 48 deletions.
diff --git a/coder_sniffer/Drupal/Sniffs/Attributes/ValidHookNameSniff.php b/coder_sniffer/Drupal/Sniffs/Attributes/ValidHookNameSniff.php
@@ -22,13 +22,6 @@
 class ValidHookNameSniff implements Sniff
 {
 
-    /**
-     * List of hooks that should not be fixed.
-     *
-     * @var string[]
-     */
-    public array $hookExceptions = ['hook_info'];
-
 
     /**
      * Returns an array of tokens this test wants to listen for.
@@ -69,9 +62,7 @@ public function process(File $phpcsFile, $stackPtr)
                 // Remove outer quotes.
                 $hookNameValue = trim($tokens[$hookName]['content'], '"\'');
 
-                if (in_array($hookNameValue, $this->hookExceptions) === false
-                    && strpos($hookNameValue, 'hook_') === 0
-                ) {
+                if (strpos($hookNameValue, 'hook_') === 0) {
                     $fix = $phpcsFile->addFixableWarning("Hook name should not start with 'hook_'. Hook name used: $hookNameValue", $hookName, 'HookPrefix');
                     if ($fix === true && strlen($hookNameValue) > 5) {
                         // Remove "hook_" prefix.

diff --git a/tests/Drupal/Attributes/ValidHookNameUnitTest.inc b/tests/Drupal/Attributes/ValidHookNameUnitTest.inc
@@ -16,8 +16,8 @@ function module_valid() {
 /**
  * Single quotes.
  */
-#[Hook('hook_node_view')]
-function module_node_view() {
+#[Hook('hook_info')]
+function module_info() {
 
 }
 
@@ -64,22 +64,6 @@ function module_hookpirate_view() {
 
 }
 
-/**
- * "hook_info" is exception. No warning.
- */
-#[Hook('hook_info')]
-function module_hook_info() {
-
-}
-
-/**
- * Named argument. "hook_info" is exception. No warning.
- */
-#[Hook(hook: 'hook_info')]
-function mymodule_hook_info() {
-
-}
-
 /**
  * Valid hook.
  */

diff --git a/tests/Drupal/Attributes/ValidHookNameUnitTest.inc.fixed b/tests/Drupal/Attributes/ValidHookNameUnitTest.inc.fixed
@@ -16,8 +16,8 @@ function module_valid() {
 /**
  * Single quotes.
  */
-#[Hook('node_view')]
-function module_node_view() {
+#[Hook('info')]
+function module_info() {
 
 }
 
@@ -63,22 +63,6 @@ function module_hookpirate_view() {
 
 }
 
-/**
- * "hook_info" is exception. No warning.
- */
-#[Hook('hook_info')]
-function module_hook_info() {
-
-}
-
-/**
- * Named argument. "hook_info" is exception. No warning.
- */
-#[Hook(hook: 'hook_info')]
-function mymodule_hook_info() {
-
-}
-
 /**
  * Valid hook.
  */

diff --git a/tests/Drupal/Attributes/ValidHookNameUnitTest.php b/tests/Drupal/Attributes/ValidHookNameUnitTest.php
@@ -44,8 +44,8 @@ protected function getWarningList(string $testFile): array
             44  => 1,
             52  => 1,
             62  => 1,
-            101 => 1,
-            116 => 1,
+            85  => 1,
+            100 => 1,
         ];
 
     }//end getWarningList()
-Original file line number
+Diff line change
@@ Expand Up / @@ -44,8 +44,8 @@ protected function getWarningList(string $testFile): array @@
 => 1,
 => 1,
 => 1,
-=> 1,
-=> 1,
+=> 1,
+=> 1,
             ];
         }//end getWarningList()
@@ Expand Down @@