Add RouterBoundary support and timestamp option for editors

sopaco · sopaco · commit da14a80304cc · 2025-10-14T22:16:26.000+08:00
- Introduce RouterBoundary and RouterParam types to boundary analysis
- Update BoundaryEditor to generate router documentation
- Add should_include_timestamp to editor agents for prompt control
- Update prompt builder and StepForwardAgent to support timestamp
  inclusion
- Bump version to 1.1.5
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "deepwiki-rs"
-version = "1.1.1"
+version = "1.1.5"
 edition = "2024"
 
 description = "deepwiki-rs(also known as Litho) is a high-performance automatic generation engine for C4 architecture documentation, developed using Rust. It can intelligently analyze project structures, identify core components, parse dependency relationships, and leverage large language models (LLMs) to automatically generate professional architecture documentation."
diff --git a/src/generator/compose/agents/architecture_editor.rs b/src/generator/compose/agents/architecture_editor.rs
@@ -19,6 +19,10 @@ impl StepForwardAgent for ArchitectureEditor {
         MemoryScope::DOCUMENTATION.to_string()
     }
 
+    fn should_include_timestamp(&self) -> bool {
+        true
+    }
+
     fn data_config(&self) -> AgentDataConfig {
         AgentDataConfig {
             required_sources: vec![
diff --git a/src/generator/compose/agents/boundary_editor.rs b/src/generator/compose/agents/boundary_editor.rs
@@ -1,13 +1,16 @@
-use anyhow::Result;
-use async_trait::async_trait;
 use crate::generator::compose::memory::MemoryScope;
 use crate::generator::compose::types::AgentType;
 use crate::generator::context::GeneratorContext;
 use crate::generator::research::memory::MemoryRetriever;
-use crate::generator::research::types::{AgentType as ResearchAgentType, BoundaryAnalysisReport, CLIBoundary, APIBoundary, IntegrationSuggestion};
+use crate::generator::research::types::{
+    APIBoundary, AgentType as ResearchAgentType, BoundaryAnalysisReport, CLIBoundary,
+    IntegrationSuggestion, RouterBoundary,
+};
 use crate::generator::step_forward_agent::{
     AgentDataConfig, DataSource, PromptTemplate, StepForwardAgent,
 };
+use anyhow::Result;
+use async_trait::async_trait;
 
 /// 边界接口文档编辑器 - 将边界分析结果编排为标准化文档
 #[derive(Default)]
@@ -25,6 +28,10 @@ impl StepForwardAgent for BoundaryEditor {
         MemoryScope::DOCUMENTATION.to_string()
     }
 
+    fn should_include_timestamp(&self) -> bool {
+        true
+    }
+
     fn data_config(&self) -> AgentDataConfig {
         AgentDataConfig {
             required_sources: vec![],
@@ -98,26 +105,38 @@ impl BoundaryEditor {
     fn generate_boundary_documentation(&self, report: &BoundaryAnalysisReport) -> String {
         let mut content = String::new();
         content.push_str("# 系统边界接口文档\n\n");
-        content.push_str("本文档描述了系统的外部调用接口，包括CLI命令、API端点、配置参数等边界机制。\n\n");
-        
+        content.push_str(
+            "本文档描述了系统的外部调用接口，包括CLI命令、API端点、配置参数等边界机制。\n\n",
+        );
+
         // 生成CLI接口文档
         if !report.cli_boundaries.is_empty() {
             content.push_str(&self.generate_cli_documentation(&report.cli_boundaries));
         }
-        
+
         // 生成API接口文档
         if !report.api_boundaries.is_empty() {
             content.push_str(&self.generate_api_documentation(&report.api_boundaries));
         }
-        
+
+        // 生成Router路由文档
+        if !report.router_boundaries.is_empty() {
+            content.push_str(&self.generate_router_documentation(&report.router_boundaries));
+        }
+
         // 生成集成建议
         if !report.integration_suggestions.is_empty() {
-            content.push_str(&self.generate_integration_documentation(&report.integration_suggestions));
+            content.push_str(
+                &self.generate_integration_documentation(&report.integration_suggestions),
+            );
         }
 
         // 添加分析置信度
-        content.push_str(&format!("\n---\n\n**分析置信度**: {:.1}/10\n", report.confidence_score));
-        
+        content.push_str(&format!(
+            "\n---\n\n**分析置信度**: {:.1}/10\n",
+            report.confidence_score
+        ));
+
         content
     }
 
@@ -128,102 +147,143 @@ impl BoundaryEditor {
 
         let mut content = String::new();
         content.push_str("## 命令行接口 (CLI)\n\n");
-        
+
         for cli in cli_boundaries {
             content.push_str(&format!("### {}\n\n", cli.command));
             content.push_str(&format!("**描述**: {}\n\n", cli.description));
             content.push_str(&format!("**源文件**: `{}`\n\n", cli.source_location));
-            
+
             if !cli.arguments.is_empty() {
                 content.push_str("**参数**:\n\n");
                 for arg in &cli.arguments {
                     let required_text = if arg.required { "必需" } else { "可选" };
-                    let default_text = arg.default_value.as_ref()
+                    let default_text = arg
+                        .default_value
+                        .as_ref()
                         .map(|v| format!(" (默认: `{}`)", v))
                         .unwrap_or_default();
                     content.push_str(&format!(
-                        "- `{}` ({}): {} - {}{}\n", 
+                        "- `{}` ({}): {} - {}{}\n",
                         arg.name, arg.value_type, required_text, arg.description, default_text
                     ));
                 }
                 content.push_str("\n");
             }
-            
+
             if !cli.options.is_empty() {
                 content.push_str("**选项**:\n\n");
                 for option in &cli.options {
-                    let short_text = option.short_name.as_ref()
+                    let short_text = option
+                        .short_name
+                        .as_ref()
                         .map(|s| format!(", {}", s))
                         .unwrap_or_default();
                     let required_text = if option.required { "必需" } else { "可选" };
-                    let default_text = option.default_value.as_ref()
+                    let default_text = option
+                        .default_value
+                        .as_ref()
                         .map(|v| format!(" (默认: `{}`)", v))
                         .unwrap_or_default();
                     content.push_str(&format!(
-                        "- `{}{}`({}): {} - {}{}\n", 
-                        option.name, short_text, option.value_type, required_text, option.description, default_text
+                        "- `{}{}`({}): {} - {}{}\n",
+                        option.name,
+                        short_text,
+                        option.value_type,
+                        required_text,
+                        option.description,
+                        default_text
                     ));
                 }
                 content.push_str("\n");
             }
-            
+
             if !cli.examples.is_empty() {
                 content.push_str("**使用示例**:\n\n");
                 for example in &cli.examples {
                     content.push_str(&format!("```bash\n{}\n```\n\n", example));
                 }
             }
         }
-        
+
         content
     }
-    
+
     fn generate_api_documentation(&self, api_boundaries: &[APIBoundary]) -> String {
         if api_boundaries.len() == 0 {
             return String::new();
         }
 
         let mut content = String::new();
         content.push_str("## API接口\n\n");
-        
+
         for api in api_boundaries {
             content.push_str(&format!("### {} {}\n\n", api.method, api.endpoint));
             content.push_str(&format!("**描述**: {}\n\n", api.description));
             content.push_str(&format!("**源文件**: `{}`\n\n", api.source_location));
-            
+
             if let Some(request_format) = &api.request_format {
                 content.push_str(&format!("**请求格式**: {}\n\n", request_format));
             }
-            
+
             if let Some(response_format) = &api.response_format {
                 content.push_str(&format!("**响应格式**: {}\n\n", response_format));
             }
-            
+
             if let Some(auth) = &api.authentication {
                 content.push_str(&format!("**认证方式**: {}\n\n", auth));
             }
         }
-        
+
+        content
+    }
+
+    fn generate_router_documentation(&self, router_boundaries: &[RouterBoundary]) -> String {
+        if router_boundaries.len() == 0 {
+            return String::new();
+        }
+
+        let mut content = String::new();
+        content.push_str("## Router路由\n\n");
+
+        for router in router_boundaries {
+            content.push_str(&format!("### {}\n\n", router.path));
+            content.push_str(&format!("**描述**: {}\n\n", router.description));
+            content.push_str(&format!("**源文件**: `{}`\n\n", router.source_location));
+
+            if !router.params.is_empty() {
+                content.push_str("**参数**:\n\n");
+                for param in &router.params {
+                    content.push_str(&format!(
+                        "- `{}` ({}): {}\n",
+                        param.key, param.value_type, param.description
+                    ));
+                }
+            }
+        }
+
         content
     }
 
-    fn generate_integration_documentation(&self, integration_suggestions: &[IntegrationSuggestion]) -> String {
+    fn generate_integration_documentation(
+        &self,
+        integration_suggestions: &[IntegrationSuggestion],
+    ) -> String {
         if integration_suggestions.len() == 0 {
             return String::new();
         }
 
         let mut content = String::new();
         content.push_str("## 集成建议\n\n");
-        
+
         for suggestion in integration_suggestions {
             content.push_str(&format!("### {}\n\n", suggestion.integration_type));
             content.push_str(&format!("{}\n\n", suggestion.description));
-            
+
             if !suggestion.example_code.is_empty() {
                 content.push_str("**示例代码**:\n\n");
                 content.push_str(&format!("```\n{}\n```\n\n", suggestion.example_code));
             }
-            
+
             if !suggestion.best_practices.is_empty() {
                 content.push_str("**最佳实践**:\n\n");
                 for practice in &suggestion.best_practices {
@@ -232,7 +292,7 @@ impl BoundaryEditor {
                 content.push_str("\n");
             }
         }
-        
+
         content
     }
-}
+}
diff --git a/src/generator/compose/agents/key_modules_insight_editor.rs b/src/generator/compose/agents/key_modules_insight_editor.rs
@@ -89,6 +89,10 @@ impl StepForwardAgent for KeyModuleInsightEditor {
         MemoryScope::DOCUMENTATION.to_string()
     }
 
+    fn should_include_timestamp(&self) -> bool {
+        true
+    }
+
     fn data_config(&self) -> AgentDataConfig {
         AgentDataConfig {
             required_sources: vec![
diff --git a/src/generator/compose/agents/overview_editor.rs b/src/generator/compose/agents/overview_editor.rs
@@ -19,6 +19,10 @@ impl StepForwardAgent for OverviewEditor {
         MemoryScope::DOCUMENTATION.to_string()
     }
 
+    fn should_include_timestamp(&self) -> bool {
+        true
+    }
+
     fn data_config(&self) -> AgentDataConfig {
         AgentDataConfig {
             required_sources: vec![
diff --git a/src/generator/compose/agents/workflow_editor.rs b/src/generator/compose/agents/workflow_editor.rs
@@ -19,6 +19,10 @@ impl StepForwardAgent for WorkflowEditor {
         MemoryScope::DOCUMENTATION.to_string()
     }
 
+    fn should_include_timestamp(&self) -> bool {
+        true
+    }
+
     fn data_config(&self) -> AgentDataConfig {
         AgentDataConfig {
             required_sources: vec![
diff --git a/src/generator/research/agents/boundary_analyzer.rs b/src/generator/research/agents/boundary_analyzer.rs
@@ -45,10 +45,8 @@ impl StepForwardAgent for BoundaryAnalyzer {
 你的任务是基于提供的边界相关代码，识别并分析：
 1. CLI命令行接口 - 命令、参数、选项、使用示例
 2. API接口 - HTTP端点、请求/响应格式、认证方式
-3. 配置接口 - 配置参数、数据类型、配置来源
-4. 库接口 - 公共函数、接口签名、可见性
-5. 安全边界考虑 - 潜在风险和缓解策略
-6. 集成建议 - 最佳实践和示例代码
+3. Router路由 - 页面的Router路由、URL路径、路由参数
+4. 集成建议 - 最佳实践和示例代码
 
 重点关注：
 - 从Entry、Api、Controller、Router类型的代码中提取边界信息
@@ -108,8 +106,9 @@ impl StepForwardAgent for BoundaryAnalyzer {
         _context: &GeneratorContext,
     ) -> Result<()> {
         println!("✅ 边界接口分析完成:");
-        println!("   - CLI接口: {} 个", result.cli_boundaries.len());
+        println!("   - CLI命令: {} 个", result.cli_boundaries.len());
         println!("   - API接口: {} 个", result.api_boundaries.len());
+        println!("   - Router路由: {} 个", result.router_boundaries.len());
         println!("   - 集成建议: {} 项", result.integration_suggestions.len());
         println!("   - 置信度: {:.1}/10", result.confidence_score);
 
diff --git a/src/generator/research/types.rs b/src/generator/research/types.rs
@@ -217,6 +217,8 @@ pub struct BoundaryAnalysisReport {
     pub cli_boundaries: Vec<CLIBoundary>,
     /// 供外部调用的网络API边界接口（包括HTTP、RPC等协议）
     pub api_boundaries: Vec<APIBoundary>,
+    /// 页面路由
+    pub router_boundaries: Vec<RouterBoundary>,
     /// 集成建议
     pub integration_suggestions: Vec<IntegrationSuggestion>,
     /// 分析置信度 (1-10分)
@@ -263,6 +265,21 @@ pub struct APIBoundary {
     pub source_location: String,
 }
 
+#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
+pub struct RouterBoundary {
+    pub path: String,
+    pub description: String,
+    pub source_location: String,
+    pub params: Vec<RouterParam>,
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
+pub struct RouterParam {
+    pub key: String,
+    pub value_type: String,
+    pub description: String,
+}
+
 #[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
 pub struct IntegrationSuggestion {
     pub integration_type: String,
@@ -278,6 +295,7 @@ impl Default for BoundaryAnalysisReport {
             api_boundaries: Vec::new(),
             integration_suggestions: Vec::new(),
             confidence_score: 0.0,
+            router_boundaries: Vec::new(),
         }
     }
 }
diff --git a/src/generator/step_forward_agent.rs b/src/generator/step_forward_agent.rs
