fix(VariableComment): Allow intersection types in @var comment (#3392…

…423)
pfrenssen · Oct 15, 2023 · ba6e623 · ba6e623
1 parent c3f8e28
commit ba6e623
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 0 deletions.
diff --git a/coder_sniffer/Drupal/Sniffs/Commenting/VariableCommentSniff.php b/coder_sniffer/Drupal/Sniffs/Commenting/VariableCommentSniff.php
@@ -50,6 +50,7 @@ public function processMemberVar(File $phpcsFile, $stackPtr)
             T_NULLABLE,
             T_READONLY,
             T_TYPE_UNION,
+            T_TYPE_INTERSECTION,
             T_FALSE,
             T_NULL,
         ];

diff --git a/tests/Drupal/Commenting/VariableCommentUnitTest.inc b/tests/Drupal/Commenting/VariableCommentUnitTest.inc
@@ -84,4 +84,16 @@ class Test {
    */
   protected string $constant;
 
+  /**
+   * Intersection type support, it is allowed to repeat it in the var type.
+   *
+   * @var \Drupal\user\UserStorageInterface&\PHPUnit\Framework\MockObject\MockObject
+   */
+  protected UserStorageInterface&MockObject $userStorageMock;
+
+  /**
+   * It is also allowed to leave the var comment out since there is a type.
+   */
+  protected UserStorageInterface&MockObject $userStorageMock2;
+
 }
diff --git a/tests/Drupal/Commenting/VariableCommentUnitTest.inc.fixed b/tests/Drupal/Commenting/VariableCommentUnitTest.inc.fixed
@@ -88,4 +88,16 @@ class Test {
    */
   protected string $constant;
 
+  /**
+   * Intersection type support, it is allowed to repeat it in the var type.
+   *
+   * @var \Drupal\user\UserStorageInterface&\PHPUnit\Framework\MockObject\MockObject
+   */
+  protected UserStorageInterface&MockObject $userStorageMock;
+
+  /**
+   * It is also allowed to leave the var comment out since there is a type.
+   */
+  protected UserStorageInterface&MockObject $userStorageMock2;
+
 }