refactor(plan-parser): simplify plan parsing logic and UI borders #331

phodal · phodal · commit 54e36f8e8950 · 2025-03-15T16:39:48.000+08:00
- Replace XML `&lt;THOUGHT&gt;` tags with code-fence blocks for plan content.
- Simplify UI borders in `ThoughtPlanSketchProvider` by using `JBUI.Borders.empty()`.
- Refactor `MarkdownPlanParser` to handle flat ordered lists and improve section processing.
- Add test case for parsing markdown with single section and tasks.
diff --git a/core/src/main/kotlin/cc/unitmesh/devti/sketch/ui/ThoughtPlanSketchProvider.kt b/core/src/main/kotlin/cc/unitmesh/devti/sketch/ui/ThoughtPlanSketchProvider.kt
@@ -55,7 +55,7 @@ class PlanSketch(
     private fun createPlanUI() {
         planItems.forEachIndexed { index, planItem ->
             val titlePanel = JBPanel<JBPanel<*>>(FlowLayout(FlowLayout.LEFT)).apply {
-                border = JBEmptyBorder(JBUI.insets(4, 0))
+                border = JBUI.Borders.empty()
             }
 
             val titleText = if (planItem.completed) 
@@ -64,13 +64,13 @@ class PlanSketch(
                 "<html><b>${index + 1}. ${planItem.title}</b></html>"
                 
             val sectionLabel = JLabel(titleText)
-            sectionLabel.border = JBUI.Borders.empty(4, 0)
+            sectionLabel.border = JBUI.Borders.empty()
             titlePanel.add(sectionLabel)
             contentPanel.add(titlePanel)
 
             planItem.tasks.forEachIndexed { taskIndex, task ->
                 val taskPanel = JBPanel<JBPanel<*>>(FlowLayout(FlowLayout.LEFT)).apply {
-                    border = JBEmptyBorder(JBUI.insets(2, 20, 2, 0))
+                    border = JBUI.Borders.empty()
                 }
 
                 val checkbox = JBCheckBox(task).apply {
diff --git a/core/src/main/kotlin/cc/unitmesh/devti/sketch/ui/plan/MarkdownPlanParser.kt b/core/src/main/kotlin/cc/unitmesh/devti/sketch/ui/plan/MarkdownPlanParser.kt
@@ -46,10 +46,48 @@ object MarkdownPlanParser {
 
     private fun parsePlanItems(node: ASTNode, content: String): List<PlanItem> {
         val planItems = mutableListOf<PlanItem>()
+        val topLevelOrderedLists = findTopLevelOrderedLists(node)
+        if (topLevelOrderedLists.isNotEmpty() && isFlatOrderedList(topLevelOrderedLists.first(), content)) {
+            processFlatOrderedList(topLevelOrderedLists.first(), content, planItems)
+        } else {
+            processSectionedList(node, content, planItems)
+        }
+        
+        return planItems
+    }
+    
+    private fun findTopLevelOrderedLists(node: ASTNode): List<ASTNode> {
+        val orderedLists = mutableListOf<ASTNode>()
+        
+        node.children.forEach { child ->
+            if (child.type == MarkdownElementTypes.ORDERED_LIST) {
+                orderedLists.add(child)
+            }
+        }
+        
+        return orderedLists
+    }
+    
+    private fun processFlatOrderedList(node: ASTNode, content: String, planItems: MutableList<PlanItem>) {
+        node.children.forEach { listItemNode ->
+            if (listItemNode.type == MarkdownElementTypes.LIST_ITEM) {
+                val listItemText = listItemNode.getTextInNode(content).toString().trim()
+                val titleMatch = "^(\\d+)\\.\\s*(.+?)(?:\\s*$CHECKMARK)?$".toRegex().find(listItemText)
+                
+                if (titleMatch != null) {
+                    val title = titleMatch.groupValues[2].trim()
+                    val completed = listItemText.contains(CHECKMARK)
+                    planItems.add(PlanItem(title, emptyList(), completed))
+                }
+            }
+        }
+    }
+    
+    private fun processSectionedList(node: ASTNode, content: String, planItems: MutableList<PlanItem>) {
         var currentSectionTitle = ""
         var currentSectionItems = mutableListOf<String>()
         var currentSectionCompleted = false
-
+        
         node.accept(object : RecursiveVisitor() {
             override fun visitNode(node: ASTNode) {
                 when (node.type) {
@@ -70,7 +108,7 @@ object MarkdownPlanParser {
 
                                 if (titleMatch != null) {
                                     // Save previous section if exists
-                                    if (currentSectionTitle.isNotEmpty() && currentSectionItems.isNotEmpty()) {
+                                    if (currentSectionTitle.isNotEmpty()) {
                                         planItems.add(PlanItem(
                                             currentSectionTitle, 
                                             currentSectionItems.toList(),
@@ -101,39 +139,53 @@ object MarkdownPlanParser {
 
                 super.visitNode(node)
             }
-
-            private fun processTaskItems(listNode: ASTNode, content: String, itemsList: MutableList<String>) {
-                listNode.children.forEach { taskItemNode ->
-                    if (taskItemNode.type == MarkdownElementTypes.LIST_ITEM) {
-                        val taskText = taskItemNode.getTextInNode(content).toString().trim()
-                        // Extract just the first line for the task
-                        val firstLineEnd = taskText.indexOf('\n')
-                        val taskFirstLine = if (firstLineEnd > 0) {
-                            taskText.substring(0, firstLineEnd).trim()
-                        } else {
-                            taskText
-                        }
-                        
-                        // Process task text and retain the checkmark in the text
-                        val cleanTaskText = taskFirstLine.replace(Regex("^[\\-\\*]\\s+"), "").trim()
-                        if (cleanTaskText.isNotEmpty()) {
-                            itemsList.add(cleanTaskText)
-                        }
-                    }
-                }
-            }
         })
 
         // 添加最后一个章节（如果有）
-        if (currentSectionTitle.isNotEmpty() && currentSectionItems.isNotEmpty()) {
+        if (currentSectionTitle.isNotEmpty()) {
             planItems.add(PlanItem(
                 currentSectionTitle, 
                 currentSectionItems.toList(),
                 currentSectionCompleted
             ))
         }
+    }
 
-        return planItems
+    private fun isFlatOrderedList(node: ASTNode, content: String): Boolean {
+        var hasNestedLists = false
+        
+        node.children.forEach { listItemNode ->
+            if (listItemNode.type == MarkdownElementTypes.LIST_ITEM) {
+                listItemNode.children.forEach { childNode ->
+                    if (childNode.type == MarkdownElementTypes.UNORDERED_LIST) {
+                        hasNestedLists = true
+                    }
+                }
+            }
+        }
+        
+        return !hasNestedLists
+    }
+
+    private fun processTaskItems(listNode: ASTNode, content: String, itemsList: MutableList<String>) {
+        listNode.children.forEach { taskItemNode ->
+            if (taskItemNode.type == MarkdownElementTypes.LIST_ITEM) {
+                val taskText = taskItemNode.getTextInNode(content).toString().trim()
+                // Extract just the first line for the task
+                val firstLineEnd = taskText.indexOf('\n')
+                val taskFirstLine = if (firstLineEnd > 0) {
+                    taskText.substring(0, firstLineEnd).trim()
+                } else {
+                    taskText
+                }
+                
+                // Process task text and retain the checkmark in the text
+                val cleanTaskText = taskFirstLine.replace(Regex("^[\\-\\*]\\s+"), "").trim()
+                if (cleanTaskText.isNotEmpty()) {
+                    itemsList.add(cleanTaskText)
+                }
+            }
+        }
     }
     
     // For debugging purposes
diff --git a/core/src/main/resources/genius/en/code/plan.devin b/core/src/main/resources/genius/en/code/plan.devin
@@ -40,7 +40,7 @@ Here is the rule you should follow:
 
 1. Thoroughly review `<user.question>`. Create an initial plan that includes all the necessary steps to
  resolve `<user.question>`, using the recommended steps provided below,  and incorporating any requirements from
-  the `<user.question>`. Place your plan inside the XML tag `<THOUGHT>` within the code language `plan`.
+  the `<user.question>`. Place your plan inside code-fence block which language is `plan`.
 2. Review the project’s codebase, examining not only its structure but also the specific implementation details, to
    identify all segments that may contribute to or help resolve the issue described in `<user.question>`.
 3. If `<user.question>` describes an error, create a script to reproduce it and run the script to confirm the error.
@@ -57,18 +57,6 @@ Here is the rule you should follow:
 If `<user.question>` directly contradicts any of these steps, follow the instructions from `<user.question>`
 first. Be thorough in your thinking process, so it's okay if it is lengthy.
 
-For each step, document your reasoning process inside `<THOUGHT>` tags. Include the following information, enclosed within XML tags:
-
-1. `plan`: An updated plan incorporating the outcomes from the previous step. Mark progress by adding `✓` after each task in the plan that was fully completed before this step during the **current session**. Use the symbol `!` for tasks that have a latest status as failed, and use `*` for tasks that are currently in progress. If there are sub-tasks, mark their progress statuses as well. Ensure all progress statuses are marked accurately and appropriately reflect the hierarchical relationships of statuses between tasks and sub-tasks. For example, if all sub-tasks are completed, the parent task should also be marked as completed.
-
-For example:
-
-<THOUGHT>
-```plan
-Some plan
-```plan
-</THOUGHT>
-
 Here is user.question:
 
 <user.question>user.question</user.question>
diff --git a/core/src/main/resources/genius/zh/code/plan.devin b/core/src/main/resources/genius/zh/code/plan.devin
@@ -40,7 +40,7 @@ Here is the rule you should follow:
 
 1. Thoroughly review `<user.question>`. Create an initial plan that includes all the necessary steps to
  resolve `<user.question>`, using the recommended steps provided below,  and incorporating any requirements from
-  the `<user.question>`. Place your plan inside the XML tag `<THOUGHT>` within the code language `plan`.
+  the `<user.question>`. Place your plan inside code-fence block which language is `plan`.
 2. Review the project’s codebase, examining not only its structure but also the specific implementation details, to
    identify all segments that may contribute to or help resolve the issue described in `<user.question>`.
 3. If `<user.question>` describes an error, create a script to reproduce it and run the script to confirm the error.
@@ -57,18 +57,6 @@ Here is the rule you should follow:
 If `<user.question>` directly contradicts any of these steps, follow the instructions from `<user.question>`
 first. Be thorough in your thinking process, so it's okay if it is lengthy.
 
-For each step, document your reasoning process inside `<THOUGHT>` tags. Include the following information, enclosed within XML tags:
-
-1. `plan`: An updated plan incorporating the outcomes from the previous step. Mark progress by adding `✓` after each task in the plan that was fully completed before this step during the **current session**. Use the symbol `!` for tasks that have a latest status as failed, and use `*` for tasks that are currently in progress. If there are sub-tasks, mark their progress statuses as well. Ensure all progress statuses are marked accurately and appropriately reflect the hierarchical relationships of statuses between tasks and sub-tasks. For example, if all sub-tasks are completed, the parent task should also be marked as completed.
-
-For example:
-
-<THOUGHT>
-```plan
-Some plan
-```plan
-</THOUGHT>
-
 Here is user.question:
 
 <user.question>user.question</user.question>
diff --git a/core/src/test/kotlin/cc/unitmesh/devti/sketch/ui/plan/MarkdownPlanParserTest.kt b/core/src/test/kotlin/cc/unitmesh/devti/sketch/ui/plan/MarkdownPlanParserTest.kt
@@ -26,6 +26,31 @@ class MarkdownPlanParserTest {
         )
     }
 
+    @Test
+    fun should_parse_markdown_with_single_section_and_tasks_no_subitem() {
+        // Given
+        val markdownContent = """
+            1. 在 BlogRepository 中添加基于作者的删除方法
+            2. 在 BlogService 中实现批量删除逻辑
+            3. 在 BlogController 中添加 DELETE 端点
+            4. 确保数据库表结构与实体类映射正确
+        """.trimIndent()
+
+        // When
+        val planItems = MarkdownPlanParser.parse(markdownContent)
+
+        // Then
+        assertThat(planItems).hasSize(4)
+        assertThat(planItems[0].title).isEqualTo("在 BlogRepository 中添加基于作者的删除方法")
+        assertThat(planItems[0].tasks).isEmpty()
+        assertThat(planItems[1].title).isEqualTo("在 BlogService 中实现批量删除逻辑")
+        assertThat(planItems[1].tasks).isEmpty()
+        assertThat(planItems[2].title).isEqualTo("在 BlogController 中添加 DELETE 端点")
+        assertThat(planItems[2].tasks).isEmpty()
+        assertThat(planItems[3].title).isEqualTo("确保数据库表结构与实体类映射正确")
+        assertThat(planItems[3].tasks).isEmpty()
+    }
+
     @Test
     fun should_parse_markdown_with_multiple_sections_and_tasks() {
         // Given
