feat(doc): make it works

Author: phodal

gradle.properties

@@ -4,7 +4,7 @@ pluginGroup = com.phodal.autodev
 pluginName = AutoDev
 pluginRepositoryUrl = https://github.com/unit-mesh/auto-dev
 # SemVer format -> https://semver.org
-pluginVersion = 1.1.1
+pluginVersion = 1.1.2
 
 # Supported IDEs: idea, pycharm
 baseIDE=idea

java/src/main/kotlin/cc/unitmesh/idea/provider/JavaLivingDocumentation.kt

@@ -3,6 +3,8 @@ package cc.unitmesh.idea.provider
 import cc.unitmesh.devti.provider.LivingDocumentation
 import cc.unitmesh.devti.provider.LivingDocumentationType
 import com.intellij.codeInsight.daemon.impl.CollectHighlightsUtil
+import com.intellij.openapi.application.ReadAction
+import com.intellij.openapi.command.WriteCommandAction
 import com.intellij.openapi.editor.SelectionModel
 import com.intellij.psi.*
 import com.intellij.psi.util.PsiTreeUtil
@@ -19,24 +21,21 @@ class JavaLivingDocumentation : LivingDocumentation {
 
     override fun updateDoc(psiElement: PsiElement, str: String) {
         val project = psiElement.project
-        val psiElementFactory = JavaPsiFacade.getElementFactory(project)
-        val newDocComment = psiElementFactory.createDocCommentFromText(str)
-
-        if (psiElement is PsiDocCommentOwner) {
-            try {
-                psiElement.docComment?.replace(newDocComment)
-            } catch (e: IncorrectOperationException) {
-                val firstChild = psiElement.firstChild
-                psiElement.addBefore(newDocComment, firstChild)
+        WriteCommandAction.runWriteCommandAction(project, "Living Document", "cc.unitmesh.livingDoc", {
+            val psiElementFactory = JavaPsiFacade.getElementFactory(project)
+            val newDocComment = psiElementFactory.createDocCommentFromText(str)
+
+            if (psiElement is PsiDocCommentOwner) {
+                val oldDocComment = psiElement.docComment
+                if (oldDocComment != null) {
+                    oldDocComment.replace(newDocComment)
+                } else {
+                    psiElement.addBefore(newDocComment, psiElement.firstChild)
+                }
+            } else {
+                throw IncorrectOperationException("Unable to update documentation")
             }
-        } else {
-            throw IncorrectOperationException("Unable to update documentation")
-        }
-    }
-
-
-    override fun findExampleDoc(psiNameIdentifierOwner: PsiNameIdentifierOwner): String {
-        return ""
+        })
     }
 
     override fun findNearestDocumentationTarget(psiElement: PsiElement): PsiNameIdentifierOwner? {

src/main/kotlin/cc/unitmesh/devti/intentions/action/task/LivingDocumentationTask.kt

@@ -11,7 +11,6 @@ import com.intellij.openapi.editor.Editor
 import com.intellij.openapi.progress.ProgressIndicator
 import com.intellij.openapi.progress.Task
 import com.intellij.openapi.project.Project
-import com.intellij.psi.PsiElement
 import com.intellij.psi.PsiNameIdentifierOwner
 import kotlinx.coroutines.flow.collect
 import kotlinx.coroutines.runBlocking
@@ -38,6 +37,7 @@ class LivingDocumentationTask(
             }
         }
 
+        println(result)
         documentation.updateDoc(target, result)
     }
 }
@@ -73,25 +73,23 @@ class LivingDocumentationBuilder(
     }
 
     fun buildPrompt(project: Project?, target: PsiNameIdentifierOwner, fallbackText: String): String {
-        val instruction = StringBuilder(fallbackText)
-        val element = this.contextProviders.firstNotNullOfOrNull { contextProvider ->
-            val context = ReadAction.compute<LLMQueryContext?, Throwable> {
-                contextProvider.from(target)
-            }
-            val contextInstruction = contextInstruction(context)
-            contextInstruction
-        } ?: "write documentation for given code"
+        return ReadAction.compute<String, Throwable> {
+            val instruction = StringBuilder(fallbackText)
+            val element = this.contextProviders.firstNotNullOfOrNull { contextProvider ->
+                contextInstruction(contextProvider.from(target))
+            } ?: "write documentation for given code"
 
-        instruction.append(element)
-        instruction.append(" , do not return example code, do not use @author and @version tags")
-        instruction.append(target.text)
+            instruction.append(element)
+            instruction.append(" , do not return example code, do not use @author and @version tags")
+            instruction.append(target.text)
 
-        val elementText = ReadAction.compute<String, Throwable> {
-            """${target.language.displayName}\n${target}\n```"""
-        }
-        instruction.append(elementText)
+            instruction.append("""${target.language.displayName}\n${target}\n```""")
 
-        return instruction.toString()
+            val startEndString = documentation.startEndString(type)
+            instruction.append("\nstart your documentation here with ${startEndString.first} and ends with: ${startEndString.second} :\n```")
+
+            instruction.toString()
+        }
     }
 
 }

src/main/kotlin/cc/unitmesh/devti/provider/LivingDocumentation.kt

@@ -19,18 +19,13 @@ enum class LivingDocumentationType {
  * 3. living documentation
  */
 interface LivingDocumentation {
-//    val instruction: String
+    //    val instruction: String
     fun startEndString(type: LivingDocumentationType): Pair<String, String>
 
     fun updateDoc(psiElement: PsiElement, str: String)
 
-    fun findExampleDoc(psiNameIdentifierOwner: PsiNameIdentifierOwner): String
-
     fun findNearestDocumentationTarget(psiElement: PsiElement): PsiNameIdentifierOwner?
 
-    /**
-     * Find the documentation targets in the selection, like the method, class
-     */
     fun findDocTargetsInSelection(psiElement: PsiElement, selectionModel: SelectionModel): List<PsiNameIdentifierOwner>
 
     companion object {