fixes #186 RedundantDocCommentTagInspection - Skip checking array sha…

…pes (#187)
funivan · Dec 16, 2023 · bf0b1b1 · bf0b1b1
1 parent 8a53a6a
commit bf0b1b1
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 35 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 <!-- Keep a Changelog guide -> https://keepachangelog.com -->
 
+# PhpClean Changelog
+## [Unreleased]
+### Fixed
+- #186 RedundantDocCommentTagInspection - Skip checking array shapes 
+
+
 # PhpClean Changelog
 ## [2023.04.01]
 ### Fixed

diff --git a/...ivan/idea/phpClean/inspections/redundantDocCommentTag/RedundantDocCommentTagInspection.kt b/...ivan/idea/phpClean/inspections/redundantDocCommentTag/RedundantDocCommentTagInspection.kt
@@ -53,7 +53,7 @@ class RedundantDocCommentTagInspection : PhpCleanInspection() {
                     val doc = tag.type.toStringResolved()
                     val declared = type.toStringResolved()
                     if (doc == declared) {
-                        val skip = (tag.firstPsiChild as? PhpDocType)?.canonicalText?.contains(Regex("[<\\]]+"))
+                        val skip = (tag.firstPsiChild as? PhpDocType)?.canonicalText?.contains(Regex("[<\\]\\{]+"))
                         if (skip == false) {
                             holder.registerProblem(
                                     tag,

diff --git a/.../idea/phpClean/inspections/redundantDocCommentTag/RedundantDocCommentTagInspectionTest.kt b/.../idea/phpClean/inspections/redundantDocCommentTag/RedundantDocCommentTagInspectionTest.kt
@@ -7,15 +7,13 @@ class RedundantDocCommentTagInspectionTest : BaseInspectionTest() {
     @Test
     fun testRedundantReturnType() {
         assert(
-            RedundantDocCommentTagInspection(),
-            """
+            RedundantDocCommentTagInspection(), """
                     <?php
                      /**
                       *<warning descr="Redundant PhpDoc tag">@return void</warning>
                       */
                      function show(string ${'$'}message):void {}
-                    """,
-            """
+                    """, """
                     <?php
                     function show(string ${'$'}message):void {}
                     """
@@ -25,16 +23,14 @@ class RedundantDocCommentTagInspectionTest : BaseInspectionTest() {
     @Test
     fun testRedundantReturnTypeWithNonEmptyComment() {
         assert(
-            RedundantDocCommentTagInspection(),
-            """
+            RedundantDocCommentTagInspection(), """
                     <?php
                      /**
                       * Hello world
                       *<warning descr="Redundant PhpDoc tag">@return void</warning>
                       */
                      function show(string ${'$'}message):void {}
-                    """,
-            """
+                    """, """
                     <?php
                      /**
                       * Hello world
@@ -47,16 +43,14 @@ class RedundantDocCommentTagInspectionTest : BaseInspectionTest() {
     @Test
     fun testRedundantParameterTag() {
         assert(
-            RedundantDocCommentTagInspection(),
-            """
+            RedundantDocCommentTagInspection(), """
                     <?php
                      /**
                       *<warning descr="Redundant PhpDoc tag">@param string ${'$'}message</warning>
                       * @param string ${'$'}test
                       */
                      function show(int ${'$'}a, string ${'$'}message):void {}
-                    """,
-            """
+                    """, """
                     <?php
                      /**
                       * @param string ${'$'}test
@@ -69,8 +63,7 @@ class RedundantDocCommentTagInspectionTest : BaseInspectionTest() {
     @Test
     fun testRedundantParameterTagWithClassFQN() {
         assert(
-            RedundantDocCommentTagInspection(),
-            """
+            RedundantDocCommentTagInspection(), """
                     <?php
                     class A{
                      /**
@@ -86,8 +79,7 @@ class RedundantDocCommentTagInspectionTest : BaseInspectionTest() {
     @Test
     fun testReturnMultipleTypes() {
         assert(
-            RedundantDocCommentTagInspection(),
-            """
+            RedundantDocCommentTagInspection(), """
                     <?php
                      /**
                       * @return \Generator|string[]
@@ -100,8 +92,7 @@ class RedundantDocCommentTagInspectionTest : BaseInspectionTest() {
     @Test
     fun testCheckEmptyTag() {
         assert(
-            RedundantDocCommentTagInspection(),
-            """
+            RedundantDocCommentTagInspection(), """
                     <?php
                      /**
                       * @return  
@@ -114,8 +105,7 @@ class RedundantDocCommentTagInspectionTest : BaseInspectionTest() {
     @Test
     fun testCheckNullableReturnType() {
         assert(
-            RedundantDocCommentTagInspection(),
-            """
+            RedundantDocCommentTagInspection(), """
                     <?php
                      /**
                       *<warning descr="Redundant PhpDoc tag">@return bool|null</warning>
@@ -128,8 +118,7 @@ class RedundantDocCommentTagInspectionTest : BaseInspectionTest() {
     @Test
     fun testCheckNullableParameterType() {
         assert(
-            RedundantDocCommentTagInspection(),
-            """
+            RedundantDocCommentTagInspection(), """
                     <?php
                      /**
                       *<warning descr="Redundant PhpDoc tag">@param stdClass|null ${'$'}o</warning>
@@ -142,8 +131,7 @@ class RedundantDocCommentTagInspectionTest : BaseInspectionTest() {
     @Test
     fun testRedundantFieldTag() {
         assert(
-            RedundantDocCommentTagInspection(),
-            """
+            RedundantDocCommentTagInspection(), """
                     <?php
                     class PhpClean {
                         /**
@@ -158,8 +146,7 @@ class RedundantDocCommentTagInspectionTest : BaseInspectionTest() {
     @Test
     fun testFieldTagWithClassFQN() {
         assert(
-            RedundantDocCommentTagInspection(),
-            """
+            RedundantDocCommentTagInspection(), """
                     <?php
                     class PhpClean {
                         /**
@@ -171,11 +158,28 @@ class RedundantDocCommentTagInspectionTest : BaseInspectionTest() {
         )
     }
 
+    @Test
+    fun testIgnoreArrayShapeTags() {
+        assert(
+            RedundantDocCommentTagInspection(), """
+                    <?php
+                    class PhpClean {
+                     /**
+                      * @param array{id: int, name: string} ${'$'}variable
+                      * @return array{id: int, name: string}
+                      */
+                      function example(array ${'$'}variable): array{
+                        return ['id'=>123, 'name'=>'test'];
+                      }
+                    }
+                    """
+        )
+    }
+
     @Test
     fun testFieldTagWithMultipleTypes() {
         assert(
-            RedundantDocCommentTagInspection(),
-            """
+            RedundantDocCommentTagInspection(), """
                     <?php
                     class PhpClean {
                         /**
@@ -190,8 +194,7 @@ class RedundantDocCommentTagInspectionTest : BaseInspectionTest() {
     @Test
     fun testFieldWithEmptyTag() {
         assert(
-            RedundantDocCommentTagInspection(),
-            """
+            RedundantDocCommentTagInspection(), """
                     <?php
                     class PhpClean {
                         /**
@@ -206,8 +209,7 @@ class RedundantDocCommentTagInspectionTest : BaseInspectionTest() {
     @Test
     fun testCheckNullableFieldType() {
         assert(
-            RedundantDocCommentTagInspection(),
-            """
+            RedundantDocCommentTagInspection(), """
                     <?php
                     class PhpClean {
                         /**
@@ -222,8 +224,7 @@ class RedundantDocCommentTagInspectionTest : BaseInspectionTest() {
     @Test
     fun testGenericType() {
         assert(
-            RedundantDocCommentTagInspection(),
-            """
+            RedundantDocCommentTagInspection(), """
                     <?php
                     class PhpClean {
                      /**