feat(typescript): refactor JSDoc comment insertion logic to handle nu…

…ll values and exceptions more gracefully #2
unit-mesh · Apr 10, 2024 · 5231b70 · 5231b70
1 parent 30f301e
commit 5231b70
Showing 1 changed file with 21 additions and 11 deletions.
diff --git a/...ript/src/main/kotlin/cc/unitmesh/ide/javascript/provider/JavaScriptLivingDocumentation.kt b/...ript/src/main/kotlin/cc/unitmesh/ide/javascript/provider/JavaScriptLivingDocumentation.kt
@@ -52,18 +52,16 @@ class JavaScriptLivingDocumentation : LivingDocumentation {
                         ?: findDocFallback(target)
 
                     try {
-                        val createJSDocComment: PsiElement = JSPsiElementFactory.createJSDocComment(newDoc, target)
-
-                        if (existingComment != null) {
-                            existingComment.replace(createJSDocComment)
-                        } else {
-                            val parent = target.parent
-                            parent.addBefore(createJSDocComment, target)
-                            JSChangeUtil.addWs(parent.node, target.node, "\n")
-                        }
+                        didInsertComment(newDoc, target, existingComment)
                     } catch (e: Exception) {
-                        editor.document.insertString(startOffset, newDoc)
-                        codeStyleManager.reformatText(target.containingFile, startOffset, newEndOffset)
+                        // second attempt
+                        val fromSuggestion = LivingDocumentation.buildDocFromSuggestion(newDoc, "/**", "*/")
+                        try {
+                            didInsertComment(fromSuggestion, target, existingComment)
+                        } catch (e: Exception) {
+                            editor.document.insertString(startOffset, newDoc)
+                            codeStyleManager.reformatText(target.containingFile, startOffset, newEndOffset)
+                        }
                     }
                 }
 
@@ -80,6 +78,18 @@ class JavaScriptLivingDocumentation : LivingDocumentation {
         })
     }
 
+    private fun didInsertComment(newDoc: String, target: PsiElement, existingComment: JSDocComment?) {
+        val createJSDocComment: PsiElement = JSPsiElementFactory.createJSDocComment(newDoc, target)
+
+        if (existingComment != null) {
+            existingComment.replace(createJSDocComment)
+        } else {
+            val parent = target.parent
+            parent.addBefore(createJSDocComment, target)
+            JSChangeUtil.addWs(parent.node, target.node, "\n")
+        }
+    }
+
     private fun findDocFallback(documentationTarget: PsiElement): JSDocComment? {
         val parentOfDestructuring: PsiElement? by lazy {
             var context = documentationTarget.context