feat(sql): add functionality to update living documentation

This commit adds the functionality to update living documentation in the `SqlLivingDocumentationProvider` class. It includes the ability to insert the new documentation at the correct position, reformat the code, and run the update as a write command action. Additionally, the commit includes changes to the `CustomLivingDocTask`, `CustomDocumentationIntention`, and `BasedDocumentationIntention` classes to support the new functionality.

Author: phodal

exts/database/src/main/kotlin/cc/unitmesh/database/provider/SqlLivingDocumentationProvider.kt

@@ -2,29 +2,38 @@ package cc.unitmesh.database.provider
 
 import cc.unitmesh.devti.custom.document.LivingDocumentationType
 import cc.unitmesh.devti.provider.LivingDocumentation
+import com.intellij.openapi.command.WriteCommandAction
 import com.intellij.openapi.editor.Editor
 import com.intellij.openapi.editor.SelectionModel
 import com.intellij.psi.PsiElement
 import com.intellij.psi.PsiNameIdentifierOwner
+import com.intellij.psi.codeStyle.CodeStyleManager
 
 class SqlLivingDocumentationProvider : LivingDocumentation {
     override val forbiddenRules: List<String>
-        get() = TODO("Not yet implemented")
+        get() = listOf()
 
     override fun startEndString(type: LivingDocumentationType): Pair<String, String> {
         return Pair("--", "--")
     }
 
     override fun updateDoc(target: PsiElement, newDoc: String, type: LivingDocumentationType, editor: Editor) {
-        TODO("Not yet implemented")
+        val project = target.project
+        val codeStyleManager = CodeStyleManager.getInstance(project)
+        val file = target.containingFile
+
+        val doc = newDoc + "\n"
+
+        WriteCommandAction.runWriteCommandAction(project, "Living Document", "cc.unitmesh.livingDoc", {
+            val startOffset = target.textRange.startOffset
+            val newEndOffset = startOffset + doc.length
+
+            editor.document.insertString(startOffset, doc)
+            codeStyleManager.reformatText(file, startOffset, newEndOffset)
+        })
     }
 
     override fun findNearestDocumentationTarget(psiElement: PsiElement): PsiNameIdentifierOwner? {
-//        return when (psiElement) {
-//            is SqlDdlStatement -> psiElement
-//            is SqlDeclareStatement -> psiElement
-//            else -> null
-//        }
         return null
     }
 

src/main/kotlin/cc/unitmesh/devti/custom/CustomDocumentationIntention.kt

@@ -8,7 +8,7 @@ import com.intellij.openapi.editor.Editor
 import com.intellij.openapi.progress.ProgressManager
 import com.intellij.openapi.progress.Task
 import com.intellij.openapi.progress.impl.BackgroundableProcessIndicator
-import com.intellij.psi.PsiNameIdentifierOwner
+import com.intellij.psi.PsiElement
 
 class CustomDocumentationIntention(override val config: CustomDocumentationConfig) : BasedDocumentationIntention() {
 
@@ -17,14 +17,13 @@ class CustomDocumentationIntention(override val config: CustomDocumentationConfi
     override fun getFamilyName(): String = "AutoDev: Custom Documentation Intention"
     override fun priority(): Int = 99
 
-    override fun writingDocument(editor: Editor, element: PsiNameIdentifierOwner, documentation: LivingDocumentation) {
+    override fun writingDocument(editor: Editor, element: PsiElement, documentation: LivingDocumentation) {
         val task: Task.Backgroundable = CustomLivingDocTask(editor, element, config)
         ProgressManager.getInstance()
             .runProcessWithProgressAsynchronously(task, BackgroundableProcessIndicator(task))
     }
 
     companion object {
-        fun create(config: CustomDocumentationConfig): CustomDocumentationIntention =
-            CustomDocumentationIntention(config)
+        fun create(config: CustomDocumentationConfig) = CustomDocumentationIntention(config)
     }
 }

src/main/kotlin/cc/unitmesh/devti/custom/document/CustomLivingDocTask.kt

@@ -6,13 +6,13 @@ import com.intellij.openapi.diagnostic.logger
 import com.intellij.openapi.editor.Editor
 import com.intellij.openapi.progress.ProgressIndicator
 import com.intellij.openapi.progress.Task
-import com.intellij.psi.PsiNameIdentifierOwner
-import kotlinx.coroutines.flow.*
+import com.intellij.psi.PsiElement
+import kotlinx.coroutines.flow.cancellable
 import kotlinx.coroutines.runBlocking
 
 class CustomLivingDocTask(
     val editor: Editor,
-    val target: PsiNameIdentifierOwner,
+    val target: PsiElement,
     val config: CustomDocumentationConfig,
 ) :
     Task.Backgroundable(editor.project, config.title) {

src/main/kotlin/cc/unitmesh/devti/intentions/action/base/BasedDocumentationIntention.kt

@@ -4,11 +4,13 @@ import cc.unitmesh.devti.custom.document.CustomDocumentationConfig
 import cc.unitmesh.devti.custom.document.LivingDocumentationType
 import cc.unitmesh.devti.intentions.action.task.LivingDocumentationTask
 import cc.unitmesh.devti.provider.LivingDocumentation
+import com.intellij.openapi.diagnostic.logger
 import com.intellij.openapi.editor.Editor
 import com.intellij.openapi.progress.ProgressManager
 import com.intellij.openapi.progress.Task
 import com.intellij.openapi.progress.impl.BackgroundableProcessIndicator
 import com.intellij.openapi.project.Project
+import com.intellij.psi.PsiElement
 import com.intellij.psi.PsiFile
 import com.intellij.psi.PsiManager
 import com.intellij.psi.PsiNameIdentifierOwner
@@ -21,6 +23,8 @@ abstract class BasedDocumentationIntention : AbstractChatIntention() {
 
     override fun startInWriteAction(): Boolean = false
 
+    val logger = logger<BasedDocumentationIntention>()
+
     override fun invoke(project: Project, editor: Editor?, file: PsiFile?) {
         if (editor == null || file == null) return
         if (!isAvailable(project, editor, file)) return
@@ -35,22 +39,28 @@ abstract class BasedDocumentationIntention : AbstractChatIntention() {
             val findFile: PsiFile = PsiManager.getInstance(project).findFile(rootFile.virtualFile) ?: return
 
             // find all targets in selection
-            documentation.findDocTargetsInSelection(findFile, selectionModel).map {
-                writingDocument(editor, it, documentation)
+            val targetsInSelection = documentation.findDocTargetsInSelection(findFile, selectionModel)
+            if (targetsInSelection.isNotEmpty()) {
+                targetsInSelection.map {
+                    writingDocument(editor, it, documentation)
+                }
+            } else {
+                writingDocument(editor, findFile, documentation)
             }
+
             return
-        } else {
-            val element = PsiUtilBase.getElementAtCaret(editor) ?: return
-            val nearestDocumentationTarget = documentation.findNearestDocumentationTarget(element) ?: return
+        }
+        val element = PsiUtilBase.getElementAtCaret(editor) ?: return
+        val nearestDocumentationTarget = documentation.findNearestDocumentationTarget(element)
+        if (nearestDocumentationTarget != null) {
             writingDocument(editor, nearestDocumentationTarget, documentation)
-
             return
         }
 
-
+        logger.warn("No selected text and no nearest documentation target found")
     }
 
-    open fun writingDocument(editor: Editor, element: PsiNameIdentifierOwner, documentation: LivingDocumentation) {
+    open fun writingDocument(editor: Editor, element: PsiElement, documentation: LivingDocumentation) {
         val task = LivingDocumentationTask(editor, element, LivingDocumentationType.COMMENT, documentation)
         ProgressManager.getInstance()
             .runProcessWithProgressAsynchronously(task, BackgroundableProcessIndicator(task))

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

@@ -11,8 +11,8 @@ import com.intellij.openapi.editor.Editor
 import com.intellij.openapi.progress.ProgressIndicator
 import com.intellij.openapi.progress.Task
 import com.intellij.psi.PsiElement
-import com.intellij.psi.PsiNameIdentifierOwner
 import kotlinx.coroutines.runBlocking
+import kotlinx.coroutines.flow.*
 
 /**
  * The `LivingDocumentationTask` class represents a background task for generating living documentation.