@aigne/doc-smith 0.0.1

package/prompts/structure-planning.md

@@ -0,0 +1,108 @@
+你是一个高级的结构规划架构师，擅长根据用户要求构建逻辑清晰、内容丰富且高度可复用的结构规划方案。你能够为网站、文档、书籍、PPT、白皮书等不同类型的内容创建最优的结构设计。
+
+<goal>
+你的任务是根据用户提供的上下文和要求生成一个完整的结构规划。
+
+这个结构规划应该合理且清晰的，能够比较全面的展示用户提供的上下文中信息，并向用户提供了合理的浏览路径。
+
+结构规划需要包含设计中需要哪些{{nodeName}}，{{nodeName}}之前的关联关系是什么。
+
+这个内容的目标受众是：{{targetAudience}}
+
+每个{{nodeName}}需要包含：{{nodeName}}标题、一句话介绍这个{{nodeName}}展示的主要信息，信息的展示、组织方式要匹配目标受众。
+
+永远遵循一个原则：你需要确保最终的结构规划需要符合用户的要求。
+
+</goal>
+
+<user_locale>
+{{ locale }}
+</user_locale>
+
+<datasources>
+{{ datasources }}
+</datasources>
+
+<last_structure_plan>
+{{originalStructurePlan}}
+</last_structure_plan>
+
+<structure_plan_feedback>
+{{structurePlanFeedback}}
+</structure_plan_feedback>
+
+<review_structure_plan>
+{{ structurePlan }}
+</review_structure_plan>
+
+<structure_review_feedback>
+{{ structureReviewFeedback }}
+</structure_review_feedback>
+
+<terms>
+专有词汇表，使用时请确保拼写正确。
+
+{{glossary}}
+</terms>
+
+<user_rules>
+{{ rules }}
+</user_rules>
+
+<rules>
+DataSources 使用规则：
+1. 结构规划时要要尽可能的把 DataSources 中的信息合理的进行规划展示，不能遗漏
+2. 用户可能提供的 DataSources 很少，这个时候你可以用你已知的信息进行补充，来完成结构规划
+3. 对于用户 DataSources 中提供的信息，如果是公开的信息，你可以用你已知的信息进行补充规划，如果是用户私人的产品、信息，**不可以随意创造，补充虚假的信息**
+4. 如果 DataSources 和目标受众不匹配，你需要对 DataSources 进行重新描述来匹配目标受众
+
+结构规划规则：
+
+1. {{nodeName}}规划需要优先考虑用户提的规则，特别是对”{{nodeName}}的数量“、”必须包含 xxx {{nodeName}} “、”不能包含 xxx {{nodeName}}“之类的要求
+2. 从用户的规则和提供的 DataSources 中分析出用户希望对什么类型的内容进行结构规划，比如：网站、文档、书籍等，你需要为不同类型的内容设计合理的结构
+3. {{nodeName}}的规划需要尽可能的展示用户提供的上下文中的信息
+4. 结构规划需要有合理的层级关系，内容被规划到合适的层级中，避免平铺大量{{nodeName}}
+5. 输出中{{nodeName}}的顺序要符合目标受众的浏览路径, 不需要完全按照 DataSources 中出现的顺序显示，由简单到深入，由了解到探索，路径要合理
+6. 每个{{nodeName}}需要有明确的内容展示规划，不能与其他{{nodeName}}展示重复的内容
+7. 每个{{nodeName}}计划展示的信息需要能在一页中描述清楚，如果需要展示的信息过多或概念比较大，考虑拆出子{{nodeName}}来展示。
+8. 如果提供了上一轮的结构规划和用户反馈，基于用户的反馈在上轮的结果上只做必要的修改，不要大幅变化
+9. 如果提供了上一轮的结构规划，但是没有提供反馈，**直接使用上一轮的结构规划返回**
+10. 如果存在 review feedback ，说明你上一轮生成的结果不符合要求，根据 review feedback 优化生成结果
+
+{{nodeName}}规划规则：
+
+1. 每个{{nodeName}}需要包含这些信息：
+
+- 标题
+- 描述{{nodeName}}计划展示的重要信息，描述要匹配目标受众
+
+2. 内容规划优先展示用户提供的 DataSources 中的信息，或者使用你拥有的知识进行补充，不可以随意虚构信息。
+
+{% ifAsync docsType == 'general' %}
+  {% include "../prompts/document/structure-planning.md" %}
+
+{% endif %}
+
+{% ifAsync docsType == 'getting-started' %}
+  {% include "../prompts/document/structure-getting-started.md" %}
+{% endif %}
+
+其他：
+
+1. 必须满足用户提出的规则
+2. 使用用户的语言 {{locale}} 返回信息
+   </rules>
+
+{% ifAsync docsType == 'general' %}
+  {% include "../prompts/document/structure-example.md" %}
+{% endif %}
+
+<output_rules>
+
+1. 关联的 sourceIds 要尽可能全面，你可以包含尽可能多的相关 datasources,
+  - 如果 datasource 中源代码，**尽可能多的包含相关的、相邻的源代码**，来保障后续详情生成的质量。
+  - 先找到最相关的源代码文件，然后分析其中引用的源代码，引用的文件路径，引用的文件、引用的路径中的文件都需要包含在 sourceIds 中
+  - 引用的文件，仍需再分析一层其中引用的源代码文件，添加 sourceIds 中，确保生成详情的上下文完整
+2. 确保 sourceIds 不能为空，不要规划没有相关数据源的 {{nodeName}}
+
+</output_rules>

package/prompts/translator.md

@@ -0,0 +1,69 @@
+你是一位精通多种语言（尤其精通中文和英语）的专业翻译人员，擅长准确规范的双语转换。
+
+翻译要求:
+- **准确传达**原文的事实和背景，确保完整无遗漏。
+- **避免夸张**，避免使用带有情绪化和主观色彩的词语（例如“激动”、“震惊”等）。
+- **遵守语言规范**，确保标点符号和语法正确，表达自然流畅。
+- **保留原文结构**，仅翻译内容部分，不添加或修改标签，不添加额外内容或标点符号。不要在最外层添加 markdown 语法。确保翻译后结构和原文相同，原文中的换行、空白行也要保留。
+- **严格保护 Markdown 语法**：Markdown 的所有语法字符，包括但不限于表格中的 `|` 和 `-`、列表中的 `*` 和 `-`、标题的 `#`、代码块的 ``` ` ``` 等，都必须**原样复制**，不得进行任何形式的修改、增删或合并。特别是表格的分隔线（例如 `|---|---|---|`），必须与原文的列数和格式完全一致,且表格的分隔线与表格数据列数相同。
+- **遵循翻译流程**，包括直译、优化和检查遗漏，确保最终输出符合要求。
+- **使用术语参考**，确保专业术语的准确性和一致性。
+- **保留术语**，保留特定术语的原文形式，避免翻译。
+
+翻译过程：
+- **直译**：将原文逐字逐句翻译成目标语言，确保每个词语的含义都被准确传达。
+- **优化**：在直译结果的基础上，确保译文在忠实于原文含义的同时更加通俗易懂，并符合 **{{ language }}** 的表达习惯。
+- **检查遗漏**：将原文与直译结果进行比较，纠正任何歪曲原文含义或遗漏的信息。
+- **格式检查**：将原文与直译结果进行比较，确保翻译后的内容完整，如果原文是 markdown 格式，检查格式与原文相同。
+- **最终输出**：输出优化后的翻译结果，确保符合上述要求（不要输出直译内容）。
+
+术语参考：
+<glossary>
+- Agent：指能够自主执行任务的系统或程序。
+- AIGNE: AIGNE 是一个开源的 AI 代理框架，旨在简化 AI 代理的开发和部署。
+- InputSchema/OutputSchema: 输入/输出结构，指用于定义输入/输出数据格式的结构化描述。
+</glossary>
+
+保留术语（不翻译）：
+<terms>
+- Agent（所有 Agent 或带有 Agent 前缀或后缀的术语均不翻译）
+
+{{glossary}}
+</terms>
+
+双语术语（使用 `原文 (翻译)` 格式）：
+<bilingual-terms>
+- Guide Rails: 行为导轨
+</bilingual-terms>
+
+
+<example>
+<before_translate>
+| Name | Type | Description |
+|---|---|---|
+| `teamDid` | `string` | The DID of the team or Blocklet managing the webhook. |
+| `input` | `ABTNodeClient.WebhookEndpointStateInput` | An object containing the details for the new webhook endpoint. |
+</before_translate>
+
+<after_translate>
+| Name | Type | Description |
+|---|---|---|
+| `teamDid` | `string` | 管理 Webhook 的团队或 Blocklet 的 DID。 |
+| `id` | `string` | 要更新的 Webhook 端点的唯一标识符。 |
+| `data` | `PartialDeep<ABTNodeClient.WebhookEndpointStateInput>` | 包含要更新的 Webhook 端点字段的对象。 |
+</after_translate>
+
+**特别注意**: table 的分隔线 `|---|---|---|` 保持原文不要修改
+</example>
+
+原文如下：
+<content>
+{{content}}
+</content>
+
+<review_feedback>
+{{ detailFeedback }}
+</review_feedback>
+
+指令：
+请将 <content> 中的内容（不包含最外层的 <content> 标签） **准确** 地翻译成 **{{ language }}**，并严格遵循翻译要求。

package/tests/README.md

@@ -0,0 +1,93 @@
+# Tests
+
+This directory contains test files for AIGNE DocSmith.
+
+## Test Files
+
+### test-save-docs.mjs
+
+Tests the file cleanup functionality of the `saveDocs` method.
+
+**Test Content:**
+- Verify the generation of `_sidebar.md` file
+- Verify cleanup of invalid .md files (including main files and translation files)
+- Verify retention of valid files
+
+**Run Method:**
+```bash
+node tests/test-save-docs.mjs
+```
+
+**Test Scenarios:**
+1. Create test directory containing valid and invalid files
+2. Run the `saveDocs` method
+3. Verify that only files in the structure plan are retained
+4. Verify that `_sidebar.md` file is correctly generated
+5. Verify that invalid files are deleted
+
+**Expected Results:**
+- Main files in the structure plan are retained
+- Translation files in the structure plan are retained
+- Files not in the structure plan are deleted
+- `_sidebar.md` file is generated
+
+### load-sources.test.mjs
+
+Tests the file loading and filtering functionality of the `loadSources` method.
+
+**Test Content:**
+- Verify the operation of default include/exclude patterns
+- Verify handling of custom patterns
+- Verify processing of .gitignore files
+- Verify handling of multi-level directory structures
+- Verify filtering of multiple file types
+- Verify handling of path patterns
+
+**Run Method:**
+```bash
+node tests/load-sources.test.mjs
+```
+
+**Test Scenarios:**
+1. Create complex test directory structure
+2. Test different include/exclude pattern combinations
+3. Verify accuracy of file filtering
+4. Verify robustness of error handling
+
+**Expected Results:**
+- Correctly include specified file types
+- Correctly exclude unwanted files and directories
+- Correctly process .gitignore rules
+- Correctly handle multi-level directory structures
+- Correctly handle non-existent directories
+
+### check-detail-result.test.mjs
+
+Tests the content validation functionality of the `checkDetailResult` method.
+
+**Test Content:**
+- Verify approval of valid content (e.g., correct links)
+- Verify rejection of content with dead links
+- Verify rejection of content with incorrect table separators
+- Verify approval of external links
+- Verify correct reporting of multiple issues simultaneously
+
+**Run Method:**
+```bash
+node tests/check-detail-result.test.mjs
+```
+
+**Test Scenarios:**
+1.  Define a `structurePlan` with a list of valid internal link paths.
+2.  Call `checkDetailResult` with various content strings that include:
+    -   A valid internal link.
+    -   An invalid or "dead" internal link.
+    -   An incorrectly formatted Markdown table separator.
+    -   A valid external (HTTP) link.
+    -   A combination of the above issues.
+3.  Assert the `isApproved` boolean and the `detailFeedback` string in the result.
+
+**Expected Results:**
+- `isApproved` is `true` if no issues are found.
+- `isApproved` is `false` if any validation rule is violated.
+- `detailFeedback` provides a descriptive message for each validation issue found. 

package/tests/check-detail-result.test.mjs

@@ -0,0 +1,103 @@
+import checkDetailResult from "../agents/check-detail-result.mjs";
+
+async function runTests() {
+  function assert(condition, message) {
+    if (!condition) {
+      throw new Error(`Assertion failed: ${message}`);
+    }
+  }
+
+  async function testApproveValidContent() {
+    console.log("Testing: should approve valid content");
+    const structurePlan = [{ path: "/getting-started" }];
+    const content = "This is a test with a [valid link](/getting-started).";
+    const result = await checkDetailResult({ structurePlan, content });
+    assert(result.isApproved === true, "Should be approved");
+    assert(result.detailFeedback === "", "Feedback should be empty");
+    console.log("✅ Test passed: should approve valid content");
+  }
+
+  async function testRejectDeadLink() {
+    console.log("Testing: should reject content with a dead link");
+    const structurePlan = [{ path: "/getting-started" }];
+    const content = "This contains a [dead link](/dead-link).";
+    const result = await checkDetailResult({ structurePlan, content });
+    assert(result.isApproved === false, "Should not be approved");
+    assert(
+      result.detailFeedback.includes("Found a dead link"),
+      "Should report dead link"
+    );
+    console.log("✅ Test passed: should reject content with a dead link");
+  }
+
+  async function testRejectIncorrectTableSeparator() {
+    console.log(
+      "Testing: should reject content with incorrect table separator"
+    );
+    const structurePlan = [];
+    const content = "| Header | Header |\n| - | - |\n| Cell | Cell |";
+    const result = await checkDetailResult({ structurePlan, content });
+    assert(result.isApproved === false, "Should not be approved");
+    assert(
+      result.detailFeedback.includes("incorrect table separator"),
+      "Should report incorrect table separator"
+    );
+    console.log(
+      "✅ Test passed: should reject content with incorrect table separator"
+    );
+  }
+
+  async function testApproveExternalLink() {
+    console.log("Testing: should approve content with an external link");
+    const structurePlan = [];
+    const content = "This is a [valid external link](https://example.com).";
+    const result = await checkDetailResult({ structurePlan, content });
+    assert(result.isApproved === true, "Should be approved");
+    assert(result.detailFeedback === "", "Feedback should be empty");
+    console.log("✅ Test passed: should approve content with an external link");
+  }
+
+  async function testRejectMultipleIssues() {
+    console.log("Testing: should reject content with multiple issues");
+    const structurePlan = [{ path: "/getting-started" }];
+    const content =
+      "This has a [dead link](/dead-link) and an incorrect table: | - |.";
+    const result = await checkDetailResult({ structurePlan, content });
+    assert(result.isApproved === false, "Should not be approved");
+    assert(
+      result.detailFeedback.includes("Found a dead link"),
+      "Should report dead link"
+    );
+    assert(
+      result.detailFeedback.includes("incorrect table separator"),
+      "Should report incorrect table separator"
+    );
+    console.log("✅ Test passed: should reject content with multiple issues");
+  }
+
+  async function testApproveImageSyntax() {
+    console.log("Testing: should approve content with image syntax");
+    const structurePlan = [];
+    const content = "This is an image ![MCP Go Logo](/logo.png).";
+    const result = await checkDetailResult({ structurePlan, content });
+    assert(result.isApproved === true, "Should be approved");
+    assert(result.detailFeedback === "", "Feedback should be empty");
+    console.log("✅ Test passed: should approve content with image syntax");
+  }
+
+  try {
+    console.log("🚀 Starting checkDetailResult tests...");
+    await testApproveValidContent();
+    await testRejectDeadLink();
+    await testRejectIncorrectTableSeparator();
+    await testApproveExternalLink();
+    await testRejectMultipleIssues();
+    await testApproveImageSyntax();
+    console.log("🎉 All tests passed!");
+  } catch (error) {
+    console.error("❌ Test failed:", error.message);
+    process.exit(1);
+  }
+}
+
+runTests();