feat(core): add code file link support in task description #331

phodal · phodal · commit de78a26f2fec · 2025-03-18T11:22:14.000+08:00
- Add CodeFileLink data class to represent code file links
- Update AgentPlanStep to include codeFileLinks property
- Modify MarkdownPlanParser to extract and handle code file links
- Update TaskPanel to render code file links as hyperlinks
- Add tests for code file link parsing and rendering
diff --git a/core/src/main/kotlin/cc/unitmesh/devti/observer/plan/AgentPlanStep.kt b/core/src/main/kotlin/cc/unitmesh/devti/observer/plan/AgentPlanStep.kt
@@ -8,13 +8,15 @@ import kotlinx.serialization.Serializable
  * @property completed 任务是否已完成
  * @property status 任务状态（COMPLETED, FAILED, IN_PROGRESS, TODO）
  * @property subSteps 子任务列表，用于支持嵌套任务结构
+ * @property codeFileLinks 代码文件链接列表
  */
 @Serializable
 class AgentPlanStep(
     val step: String,
     var completed: Boolean = false,
     var status: TaskStatus = TaskStatus.TODO,
-    var subSteps: MutableList<AgentPlanStep> = mutableListOf()
+    var subSteps: MutableList<AgentPlanStep> = mutableListOf(),
+    var codeFileLinks: List<CodeFileLink> = emptyList()
 ) {
     companion object {
         private val COMPLETED_PATTERN = Regex("^\\[(✓|x|X)\\]\\s*(.*)")
diff --git a/core/src/main/kotlin/cc/unitmesh/devti/observer/plan/MarkdownPlanParser.kt b/core/src/main/kotlin/cc/unitmesh/devti/observer/plan/MarkdownPlanParser.kt
@@ -1,6 +1,7 @@
 package cc.unitmesh.devti.observer.plan
 
 import com.intellij.openapi.diagnostic.logger
+import kotlinx.serialization.Serializable
 import org.intellij.markdown.IElementType
 import org.intellij.markdown.MarkdownElementTypes
 import org.intellij.markdown.ast.ASTNode
@@ -113,6 +114,7 @@ object MarkdownPlanParser {
         val TASK_PATTERN = Regex("^\\s*-\\s*\\[\\s*([xX!*✓]?)\\s*\\]\\s*(.*)")
         val SECTION_PATTERN = Regex("^(\\d+)\\.\\s*(?:\\[([xX!*✓]?)\\]\\s*)?(.+?)(?:\\s*\\[([xX!*✓]?)\\])?$")
         val UNORDERED_ITEM_CLEANER = Regex("^[\\-\\*]\\s+")
+        val CODE_FILE_LINK = Regex("\\[(.*?)\\]\\((.*?)\\)")
     }
 
     fun interpretPlan(content: String): List<AgentTaskEntry> {
@@ -294,17 +296,29 @@ object MarkdownPlanParser {
                 if (taskMatch != null) {
                     val statusMarker = taskMatch.groupValues[1]
                     val description = taskMatch.groupValues[2].trim()
+
+                    // Extract code file links from the description
+                    val codeFileLinks = extractCodeFileLinks(description)
                     val task = AgentPlanStep(
                         description,
                         TaskMarkers.isCompleted(statusMarker),
-                        TaskMarkers.determineStatus(statusMarker)
+                        TaskMarkers.determineStatus(statusMarker),
+                        codeFileLinks = codeFileLinks
                     )
 
                     taskList.add(task)
                 } else {
                     val cleanDescription = taskLine.replace(PatternMatcher.UNORDERED_ITEM_CLEANER, "").trim()
                     if (cleanDescription.isNotEmpty()) {
-                        taskList.add(AgentPlanStep(cleanDescription, false, TaskStatus.TODO))
+                        val codeFileLinks = extractCodeFileLinks(cleanDescription)
+                        taskList.add(
+                            AgentPlanStep(
+                                cleanDescription,
+                                false,
+                                TaskStatus.TODO,
+                                codeFileLinks = codeFileLinks
+                            )
+                        )
                     }
                 }
                 item.children.forEach { childNode ->
@@ -314,6 +328,19 @@ object MarkdownPlanParser {
                 }
             }
         }
+
+        private fun extractCodeFileLinks(text: String): List<CodeFileLink> {
+            val links = mutableListOf<CodeFileLink>()
+            val matches = PatternMatcher.CODE_FILE_LINK.findAll(text)
+
+            matches.forEach { match ->
+                val displayText = match.groupValues[1]
+                val filePath = match.groupValues[2]
+                links.add(CodeFileLink(displayText, filePath))
+            }
+
+            return links
+        }
     }
 
     fun parse(content: String): List<AgentTaskEntry> = interpretPlan(content)
@@ -322,7 +349,19 @@ object MarkdownPlanParser {
         entries.forEachIndexed { index, entry ->
             stringBuilder.append("${index + 1}. ${entry.title}\n")
             entry.steps.forEach { step ->
-                stringBuilder.append("   - [${if (step.completed) "x" else " "}] ${step.step}\n")
+                val stepText = if (step.codeFileLinks.isNotEmpty()) {
+                    var text = step.step
+                    step.codeFileLinks.forEach { link ->
+                        text = text.replace(
+                            "[${link.displayText}](${link.filePath})",
+                            "[${link.displayText}](${link.filePath})"
+                        )
+                    }
+                    text
+                } else {
+                    step.step
+                }
+                stringBuilder.append("   - [${if (step.completed) "x" else " "}] $stepText\n")
             }
         }
         return stringBuilder.toString()
@@ -347,3 +386,9 @@ data class DetailedSectionInfo(
     val completed: Boolean,
     val status: TaskStatus
 )
+
+@Serializable
+data class CodeFileLink(
+    val displayText: String,
+    val filePath: String
+)
diff --git a/core/src/main/kotlin/cc/unitmesh/devti/sketch/ui/plan/TaskPanel.kt b/core/src/main/kotlin/cc/unitmesh/devti/sketch/ui/plan/TaskPanel.kt
@@ -7,18 +7,23 @@ import cc.unitmesh.devti.observer.plan.AgentPlanStep
 import cc.unitmesh.devti.observer.plan.TaskStatus
 import com.intellij.icons.AllIcons
 import com.intellij.openapi.project.Project
+import com.intellij.openapi.vfs.LocalFileSystem
 import com.intellij.ui.components.JBCheckBox
 import com.intellij.ui.components.JBPanel
 import com.intellij.util.ui.JBUI
 import java.awt.Dimension
-import java.awt.FlowLayout
 import javax.swing.BorderFactory
 import javax.swing.BoxLayout
 import javax.swing.JButton
 import javax.swing.JComponent
+import javax.swing.JEditorPane
 import javax.swing.JLabel
 import javax.swing.JMenuItem
 import javax.swing.JPopupMenu
+import javax.swing.event.HyperlinkEvent
+import javax.swing.text.html.HTMLDocument
+import javax.swing.text.html.HTMLEditorKit
+import javax.swing.text.html.StyleSheet
 
 /**
  * Task Panel UI Component responsible for rendering and handling interactions for a single task
@@ -28,7 +33,7 @@ class TaskPanel(
     private val task: AgentPlanStep,
     private val onStatusChange: () -> Unit
 ) : JBPanel<TaskPanel>() {
-    private val taskLabel: JLabel
+    private val taskLabel: JEditorPane
 
     init {
         layout = BoxLayout(this, BoxLayout.X_AXIS)
@@ -81,19 +86,56 @@ class TaskPanel(
         }
     }
 
-    private fun createStyledTaskLabel(): JLabel {
+    private fun createStyledTaskLabel(): JEditorPane {
         val labelText = getLabelTextByStatus()
-        return JLabel("<html>$labelText</html>").apply {
+        val editorKit = HTMLEditorKit()
+        val styleSheet = StyleSheet()
+        styleSheet.addRule("a { color: #4A90E2; text-decoration: none; }")
+        styleSheet.addRule("a:hover { text-decoration: underline; }")
+        editorKit.styleSheet = styleSheet
+
+        val document = HTMLDocument()
+        document.putProperty("IgnoreCharsetDirective", true)
+        project.basePath?.let {
+            val url: String? = LocalFileSystem.getInstance().findFileByPath(it)?.url
+            document.putProperty("Base", url)
+        }
+
+        return JEditorPane().apply {
+            this.editorKit = editorKit
+            this.document = document
+            text = "<html>$labelText</html>"
             border = JBUI.Borders.emptyLeft(5)
+            isEditable = false
+            background = JBUI.CurrentTheme.ToolWindow.background()
+            addHyperlinkListener { e ->
+                if (e.eventType == HyperlinkEvent.EventType.ACTIVATED) {
+                    val url = e.url
+                    val filePath = url.path
+                    val virtualFile = LocalFileSystem.getInstance().findFileByPath(filePath)
+                    if (virtualFile != null) {
+                        com.intellij.openapi.fileEditor.FileEditorManager.getInstance(project)
+                            .openFile(virtualFile, true)
+                    }
+                }
+            }
         }
     }
 
     private fun getLabelTextByStatus(): String {
+        var text = task.step
+        task.codeFileLinks.forEach { link ->
+            text = text.replace(
+                "[${link.displayText}](${link.filePath})",
+                "<a href='${link.filePath}'>${link.displayText}</a>"
+            )
+        }
+
         return when (task.status) {
-            TaskStatus.COMPLETED -> "<strike>${task.step}</strike>"
-            TaskStatus.FAILED -> "<span style='color:red'>${task.step}</span>"
-            TaskStatus.IN_PROGRESS -> "<span style='color:blue;font-style:italic'>${task.step}</span>"
-            TaskStatus.TODO -> task.step
+            TaskStatus.COMPLETED -> "<strike>$text</strike>"
+            TaskStatus.FAILED -> "<span style='color:red'>$text</span>"
+            TaskStatus.IN_PROGRESS -> "<span style='color:blue;font-style:italic'>$text</span>"
+            TaskStatus.TODO -> text
         }
     }
 
diff --git a/core/src/test/kotlin/cc/unitmesh/devti/observer/plan/MarkdownPlanParserTest.kt b/core/src/test/kotlin/cc/unitmesh/devti/observer/plan/MarkdownPlanParserTest.kt
@@ -342,4 +342,116 @@ class MarkdownPlanParserTest {
         assertEquals("数据库表结构确认", plans[0].title)
         assertEquals(TaskStatus.IN_PROGRESS, plans[1].status)
     }
+
+    @Test
+    fun should_parse_code_file_links_in_tasks() {
+        // Given
+        val markdownContent = """
+            1. 分析现有代码结构并识别重构点
+               - [x] 发现 Blog 功能分散在 entity/service/dto 中，存在贫血模型特征（业务逻辑在Service层）
+               - [x] 识别出关键类：[Blog.java](src/main/java/cc/unitmesh/untitled/demo/domain/Blog.java) 是贫血模型，[BlogPost.java](src/main/java/cc/unitmesh/untitled/demo/entity/BlogPost.java) 存在重复概念
+               - [x] 确认当前分层架构不符合 DDD 规范（Repository 直接依赖 Spring Data）
+        """.trimIndent()
+
+        // When
+        val planItems = MarkdownPlanParser.parse(markdownContent)
+
+        // Then
+        Assertions.assertThat(planItems).hasSize(1)
+        Assertions.assertThat(planItems[0].title).isEqualTo("分析现有代码结构并识别重构点")
+        Assertions.assertThat(planItems[0].steps).hasSize(3)
+
+        // 验证第一个任务没有代码文件链接
+        val firstTask = planItems[0].steps[0]
+        Assertions.assertThat(firstTask.codeFileLinks).isEmpty()
+        Assertions.assertThat(firstTask.step).isEqualTo("发现 Blog 功能分散在 entity/service/dto 中，存在贫血模型特征（业务逻辑在Service层）")
+
+        // 验证第二个任务包含两个代码文件链接
+        val secondTask = planItems[0].steps[1]
+        Assertions.assertThat(secondTask.codeFileLinks).hasSize(2)
+        Assertions.assertThat(secondTask.codeFileLinks[0].displayText).isEqualTo("Blog.java")
+        Assertions.assertThat(secondTask.codeFileLinks[0].filePath).isEqualTo("src/main/java/cc/unitmesh/untitled/demo/domain/Blog.java")
+        Assertions.assertThat(secondTask.codeFileLinks[1].displayText).isEqualTo("BlogPost.java")
+        Assertions.assertThat(secondTask.codeFileLinks[1].filePath).isEqualTo("src/main/java/cc/unitmesh/untitled/demo/entity/BlogPost.java")
+
+        // 验证第三个任务没有代码文件链接
+        val thirdTask = planItems[0].steps[2]
+        Assertions.assertThat(thirdTask.codeFileLinks).isEmpty()
+        Assertions.assertThat(thirdTask.step).isEqualTo("确认当前分层架构不符合 DDD 规范（Repository 直接依赖 Spring Data）")
+    }
+
+    @Test
+    fun should_preserve_code_file_links_when_formatting_to_markdown() {
+        // Given
+        val markdownContent = """
+            1. 代码重构计划
+               - [ ] 重构 [UserService.java](src/main/java/com/example/service/UserService.java) 中的用户认证逻辑
+               - [x] 优化 [DatabaseConfig.java](src/main/java/com/example/config/DatabaseConfig.java) 的连接池配置
+        """.trimIndent()
+
+        // When
+        val planItems = MarkdownPlanParser.parse(markdownContent)
+        val formattedMarkdown = MarkdownPlanParser.formatPlanToMarkdown(planItems.toMutableList())
+
+        // Then
+        Assertions.assertThat(formattedMarkdown).contains("[UserService.java](src/main/java/com/example/service/UserService.java)")
+        Assertions.assertThat(formattedMarkdown).contains("[DatabaseConfig.java](src/main/java/com/example/config/DatabaseConfig.java)")
+    }
+
+    @Test
+    fun should_handle_code_file_links_with_special_characters() {
+        // Given
+        val markdownContent = """
+            1. 特殊字符测试
+               - [ ] 检查 [User-DTO.java](src/main/java/com/example/dto/User-DTO.java) 中的字段命名
+               - [ ] 验证 [AuthService.java](src/main/java/com/example/service/AuthService.java) 的认证逻辑
+        """.trimIndent()
+
+        // When
+        val planItems = MarkdownPlanParser.parse(markdownContent)
+
+        // Then
+        Assertions.assertThat(planItems).hasSize(1)
+        Assertions.assertThat(planItems[0].steps).hasSize(2)
+
+        val firstTask = planItems[0].steps[0]
+        Assertions.assertThat(firstTask.codeFileLinks).hasSize(1)
+        Assertions.assertThat(firstTask.codeFileLinks[0].displayText).isEqualTo("User-DTO.java")
+        Assertions.assertThat(firstTask.codeFileLinks[0].filePath).isEqualTo("src/main/java/com/example/dto/User-DTO.java")
+
+        val secondTask = planItems[0].steps[1]
+        Assertions.assertThat(secondTask.codeFileLinks).hasSize(1)
+        Assertions.assertThat(secondTask.codeFileLinks[0].displayText).isEqualTo("AuthService.java")
+        Assertions.assertThat(secondTask.codeFileLinks[0].filePath).isEqualTo("src/main/java/com/example/service/AuthService.java")
+    }
+
+    @Test
+    fun should_handle_multiple_code_file_links_in_single_task() {
+        // Given
+        val markdownContent = """
+            1. 多文件关联分析
+               - [ ] 分析 [Controller.java](src/main/java/com/example/Controller.java) 和 [Service.java](src/main/java/com/example/Service.java) 之间的依赖关系
+               - [ ] 检查 [Repository.java](src/main/java/com/example/Repository.java) 的实现
+        """.trimIndent()
+
+        // When
+        val planItems = MarkdownPlanParser.parse(markdownContent)
+
+        // Then
+        Assertions.assertThat(planItems).hasSize(1)
+        Assertions.assertThat(planItems[0].steps).hasSize(2)
+
+        val firstTask = planItems[0].steps[0]
+        Assertions.assertThat(firstTask.codeFileLinks).hasSize(2)
+        Assertions.assertThat(firstTask.codeFileLinks.map { it.displayText }).containsExactly("Controller.java", "Service.java")
+        Assertions.assertThat(firstTask.codeFileLinks.map { it.filePath }).containsExactly(
+            "src/main/java/com/example/Controller.java",
+            "src/main/java/com/example/Service.java"
+        )
+
+        val secondTask = planItems[0].steps[1]
+        Assertions.assertThat(secondTask.codeFileLinks).hasSize(1)
+        Assertions.assertThat(secondTask.codeFileLinks[0].displayText).isEqualTo("Repository.java")
+        Assertions.assertThat(secondTask.codeFileLinks[0].filePath).isEqualTo("src/main/java/com/example/Repository.java")
+    }
 }
