@aigne/doc-smith 0.8.12-beta.7 → 0.8.12-beta.9

package/docs/release-notes.zh.md

@@ -1,255 +0,0 @@
-# 发行说明
-
-本文档总结了该工具每个版本的新功能、改进和错误修复。所有变更均按时间倒序排列。
-
-## 版本 0.8.12-beta.3 (2025-10-09)
-
-### 错误修复
-
-- 解决了发布到云端时错误地要求管理员权限的问题。
-
-## 版本 0.8.12-beta.2 (2025-10-09)
-
-### 错误修复
-
-- 修正了更新文档时文件路径的错误。
-- 修复了可能导致文档生成和更新失败的问题。
-
-## 版本 0.8.12-beta.1 (2025-10-08)
-
-### 新功能
-
-- 引入了历史记录跟踪功能，允许您查看文档的过往变更。
-- 在文档更新过程中，翻译现在是一个可选步骤，提供了更大的灵活性。
-
-### 改进
-
-- 优化了文档生成和更新流程，以提高可靠性。
-
-## 版本 0.8.12-beta (2025-10-07)
-
-### 错误修复
-
-- 内部文件读取工具现在可以正确支持相对路径。
-
-## 版本 0.8.11 (2025-10-05)
-
-此版本包含常规维护和稳定性改进。
-
-## 版本 0.8.11-beta.7 (2025-10-03)
-
-### 新功能
-
-- 增强了文档生成器和更新器，以获得更好的性能。
-- 通过使用共享上下文，提高了文档结构分析和内容优化的速度。
-
-### 错误修复
-
-- 更新了内部文档并优化了自定义组件的提示，以提高准确性。
-
-## 版本 0.8.11-beta.5 (2025-10-01)
-
-### 新功能
-
-- 新增了对发布时的用户角色要求和自定义规则配置的支持。
-- 将 D2 图表生成功能分离为一个独立的工具，以实现更专注的功能。
-
-## 版本 0.8.11-beta.4 (2025-09-30)
-
-### 新功能
-
-- 为使用选择输入的 Agent 添加了“仅检查”选项。
-
-### 错误修复
-
-- 改进了文档选择实用程序中的错误处理。
-- 调整了翻译提示；现在代码块内的注释可以被正确翻译。
-
-## 版本 0.8.11-beta.3 (2025-09-29)
-
-### 错误修复
-
-- 为评估 Agent 添加了命令行入口。
-
-## 版本 0.8.11-beta.2 (2025-09-27)
-
-### 错误修复
-
-- 解决了依赖冲突，以确保更平稳的运行。
-
-## 版本 0.8.11-beta.1 (2025-09-27)
-
-### 新功能
-
-- 引入了文档评估功能，以生成质量报告。
-- 通过改进的工具增强了文档和结构的更新流程。
-- 改进了发布过程中的供应商处理和调试能力。
-
-### 错误修复
-
-- 修复了组件描述被当作属性而非文本处理的问题，从而改进了自定义组件的渲染。
-
-## 版本 0.8.10 (2025-09-20)
-
-此版本包含常规维护和稳定性改进。
-
-## 版本 0.8.10-beta.3 (2025-09-19)
-
-### 错误修复
-
-- 添加了与企业部署相关的链接。
-- 优化了文档审查提示的文案。
-
-## 版本 0.8.10-beta.2 (2025-09-18)
-
-### 错误修复
-
-- 改进了文档结构审查的提示和显示。
-- 更新了字段元素的使用规则，以确保正确渲染。
-
-## 版本 0.8.10-beta.1 (2025-09-18)
-
-### 新功能
-
-- 新增了在生成前审查文档结构的工作流。
-
-### 错误修复
-
-- 提高了用户界面中英文文本的一致性和清晰度。
-- 更新了 DocSmith 徽标。
-
-## 版本 0.8.9 (2025-09-15)
-
-### 错误修复
-
-- 更新了 D2 图表的主题颜色，以获得更好的视觉一致性。
-
-## 版本 0.8.8 (2025-09-13)
-
-### 错误修复
-
-- 优化了问询反馈的文案，使其更清晰、更有帮助。
-
-## 版本 0.8.7 (2025-09-12)
-
-### 新功能
-
-- 新增了使用 `<x-field>` 自定义组件定义 API 参数的支持。
-
-## 版本 0.8.6 (2025-09-11)
-
-### 新功能
-
-- 成功发布后，现在默认显示 URL。
-
-### 错误修复
-
-- 确保在部署过程中正确保存日志，以防止数据丢失。
-
-## 版本 0.8.5 (2025-09-10)
-
-### 新功能
-
-- 新增了对将文档发布到企业空间的支持。
-
-## 版本 0.8.4 (2025-09-09)
-
-### 错误修复
-
-- Markdown 代码块现在被解析为自定义的 `<x-code>` 元素，并支持标题和图标等增强属性。
-- 将 D2 图表的背景设置为透明，以便更好地与不同主题集成。
-
-## 版本 0.8.3 (2025-09-05)
-
-### 错误修复
-
-- 为本地图片添加了自动尺寸检测功能，以确保其正确显示。
-
-## 版本 0.8.1 (2025-09-03)
-
-### 新功能
-
-- 通过更全面的示例调整了 D2 图表生成，以提高输出质量。
-
-## 版本 0.8.0 (2025-09-03)
-
-### 新功能
-
-- 更新了自定义组件的指南，增加了新的格式限制。
-
-## 版本 0.7.1 (2025-08-31)
-
-### 错误修复
-
-- 修复了使用 Tab 键进行路径选择时无法正常工作的错误。
-
-## 版本 0.7.0 (2025-08-30)
-
-### 新功能
-
-- 新增了用于生成和管理文档的交互式聊天模式。
-- 在文档生成和发布工作流中引入了对 D2 图表的支持。
-- 启用了对自定义组件和更强大的配置处理的支持。
-
-## 版本 0.6.0 (2025-08-27)
-
-### 新功能
-
-- 实现了在发布文档前对媒体进行处理的完整支持。
-
-## 版本 0.5.0 (2025-08-26)
-
-### 新功能
-
-- 用户反馈现在可以作为持久化偏好保存，供未来会话使用。
-
-### 错误修复
-
-- 优化了初始设置过程中提问的文本。
-
-## 版本 0.4.4 (2025-08-22)
-
-### 错误修复
-
-- 新增了在发布过程中分配看板 ID 的支持。
-
-## 版本 0.4.1 (2025-08-21)
-
-### 错误修复
-
-- 新增了对更新看板信息的支持。
-
-## 版本 0.4.0 (2025-08-20)
-
-### 新功能
-
-- 引入了用于翻译文档的新命令 `translate`。
-
-## 版本 0.3.0 (2025-08-19)
-
-### 新功能
-
-- 优化了在文档生成期间收集上下文的工作流。
-
-### 错误修复
-
-- 优化了为运行自托管 Discuss Kit 实例的用户提供的帮助文本。
-
-## 版本 0.2.11 (2025-08-15)
-
-### 错误修复
-
-- 更换了默认语言模型以提高生成质量。
-
-## 版本 0.2.5 (2025-08-08)
-
-### 错误修复
-
-- 优化了命令行界面流程，以提供更流畅的用户体验。
-
-## 版本 0.2.0 (2025-08-05)
-
-### 新功能
-
-- 现在，当运行命令时，如果配置缺失，工具将自动初始化配置。
-- 新增了 `update` 命令，用于在源文件发生更改时刷新文档。

package/media.md

@@ -1,19 +0,0 @@
-# 提供在文档中可使用的媒体素材
-
-![运行 generate 命令，智能执行初始化](./assets/screenshots/doc-generate.png)
-
-![回答问题完成项目设置](./assets/screenshots/doc-complete-setup.png)
-
-![执行结构规划和生成文档](./assets/screenshots/doc-generate-docs.png)
-
-![文档生成成功](./assets/screenshots/doc-generated-successfully.png)
-
-![智能检测，只重新生成需要的文档](./assets/screenshots/doc-regenerate.png)
-
-![交互式选择需要更新文档](./assets/screenshots/doc-update.png)
-
-![发布文档到官方平台或自部署平台](./assets/screenshots/doc-publish.png)
-
-![选择需要翻译的文档](./assets/screenshots/doc-translate.png)
-
-![选择需要翻译的语言](./assets/screenshots/doc-translate-langs.png)

package/prompts/common/afs/afs-tools-usage.md

@@ -1,5 +0,0 @@
-<afs-tool-usage>
-When to use Tools:
-- During document generation, if the given context is missing or lacks referenced content, use afs_list/afs_search/afs_read to obtain more context
-- Code examples in generated documents must use APIs and packages defined in the input data sources. Do not generate non-existent code out of thin air. Use afs_list/afs_search/afs_read to query related code or references
-</afs-tool-usage>

package/prompts/common/afs/use-afs-instruction.md

@@ -1 +0,0 @@
-Use AFS tools to list/search/read files to obtain more context or references. Ensure all content is accurate, relevant, and well-structured.

package/release-please-config.json

@@ -1,14 +0,0 @@
-{
-  "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json",
-  "release-type": "node",
-  "prerelease": true,
-  "versioning": "prerelease",
-  "packages": {
-    ".": {
-      "bump-minor-pre-major": true,
-      "bump-patch-for-minor-pre-major": true,
-      "include-component-in-tag": false,
-      "prerelease-type": "beta"
-    }
-  }
-}

package/tests/agents/chat/chat.test.mjs

@@ -1,46 +0,0 @@
-import { afterAll, beforeAll, describe, expect, test } from "bun:test";
-import { join } from "node:path";
-import { AIAgent } from "@aigne/core";
-import { loadAgent } from "@aigne/core/loader/index.js";
-import { loadModel } from "../../utils/mock-chat-model.mjs";
-
-describe("chat Agent", () => {
-  beforeAll(() => {
-    process.env.AIGNE_OBSERVABILITY_DISABLED = "true";
-  });
-
-  afterAll(() => {
-    delete process.env.AIGNE_OBSERVABILITY_DISABLED;
-  });
-  test("should load agent correctly with proper configuration", async () => {
-    const agent = await loadAgent(join(import.meta.dirname, "../../../agents/chat/index.yaml"), {
-      model: loadModel,
-    });
-
-    expect(agent).toBeDefined();
-
-    // Verify agent exists and is correct type
-    expect(agent).toBeDefined();
-    expect(agent).toBeInstanceOf(AIAgent);
-    expect(agent.name).toBe("chat");
-  });
-
-  test("should have instructions loaded correctly", async () => {
-    const agent = await loadAgent(join(import.meta.dirname, "../../../agents/chat/index.yaml"), {
-      model: loadModel,
-    });
-
-    expect(agent).toBeDefined();
-
-    // Verify instructions are loaded
-    expect(agent.instructions).toBeDefined();
-    const instructions = await agent.instructions.build({});
-    expect(instructions.messages).toBeDefined();
-    expect(instructions.messages.length).toBeGreaterThan(0);
-
-    // The instructions should contain content from the inline instructions
-    const systemMessage = instructions.messages.find((m) => m.role === "system");
-    expect(systemMessage).toBeDefined();
-    expect(systemMessage.content).toContain("document generation assistant");
-  });
-});

package/tests/agents/clear/choose-contents.test.mjs

@@ -1,284 +0,0 @@
-import { afterEach, beforeEach, describe, expect, mock, test } from "bun:test";
-import chooseContents from "../../../agents/clear/choose-contents.mjs";
-
-describe("choose-contents", () => {
-  let mockOptions;
-  let mockContext;
-  let mockClearAgents;
-
-  beforeEach(() => {
-    // Create mock clear agents
-    mockClearAgents = {
-      clearGeneratedDocs: mock(async () => ({
-        message: "Generated docs cleared",
-        cleared: true,
-        path: "/test/docs",
-      })),
-      clearDocumentStructure: mock(async () => ({
-        message: "Documentation Structure cleared",
-        cleared: true,
-        path: "/test/structure.json",
-      })),
-      clearDocumentConfig: mock(async () => ({
-        message: "Document config cleared",
-        cleared: true,
-        path: "/test/config.yaml",
-        suggestions: ["Run `aigne doc init` to generate a fresh configuration file."],
-      })),
-      clearAuthTokens: mock(async () => ({
-        message: "Auth tokens cleared",
-        clearedCount: 2,
-        clearedSites: ["example.com", "test.com"],
-      })),
-    };
-
-    mockContext = {
-      agents: mockClearAgents,
-      invoke: mock(async (agent, input) => {
-        return await agent(input);
-      }),
-    };
-
-    mockOptions = {
-      prompts: {
-        checkbox: mock(async () => ["generatedDocs", "documentConfig"]),
-      },
-      context: mockContext,
-    };
-
-    // Clear mock call history
-    mockOptions.prompts.checkbox.mockClear();
-    mockContext.invoke.mockClear();
-    Object.values(mockClearAgents).forEach((agent) => {
-      agent.mockClear();
-    });
-  });
-
-  afterEach(() => {
-    // Note: Not using mock.restore() to avoid affecting other tests
-  });
-
-  test("should process provided targets correctly", async () => {
-    const result = await chooseContents(
-      { targets: ["generatedDocs", "documentConfig"] },
-      mockOptions,
-    );
-
-    expect(mockContext.invoke).toHaveBeenCalledTimes(2);
-    expect(mockClearAgents.clearGeneratedDocs).toHaveBeenCalled();
-    expect(mockClearAgents.clearDocumentConfig).toHaveBeenCalled();
-    expect(result.message).toContain("Cleanup completed successfully!");
-  });
-
-  test("should normalize target names case-insensitively", async () => {
-    const result = await chooseContents(
-      { targets: ["GeneratedDocs", "DOCUMENTCONFIG"] },
-      mockOptions,
-    );
-
-    expect(mockContext.invoke).toHaveBeenCalledTimes(2);
-    expect(mockClearAgents.clearGeneratedDocs).toHaveBeenCalled();
-    expect(mockClearAgents.clearDocumentConfig).toHaveBeenCalled();
-    expect(result.message).toContain("Cleanup completed successfully!");
-  });
-
-  test("should prompt user when no targets provided", async () => {
-    mockOptions.prompts.checkbox.mockResolvedValue(["generatedDocs"]);
-
-    await chooseContents({ docsDir: "/test/docs", workDir: "/test" }, mockOptions);
-
-    expect(mockOptions.prompts.checkbox).toHaveBeenCalledWith({
-      message: "Select items to clear:",
-      choices: expect.arrayContaining([
-        expect.objectContaining({
-          name: "generated documents",
-          value: "generatedDocs",
-        }),
-      ]),
-      validate: expect.any(Function),
-    });
-    expect(mockClearAgents.clearGeneratedDocs).toHaveBeenCalled();
-  });
-
-  test("should handle empty selection from prompts", async () => {
-    mockOptions.prompts.checkbox.mockResolvedValue([]);
-
-    const result = await chooseContents({ docsDir: "/test/docs", workDir: "/test" }, mockOptions);
-
-    expect(result.message).toBe("No items selected to clear.");
-    expect(mockContext.invoke).not.toHaveBeenCalled();
-  });
-
-  test("should return available options when no prompts available", async () => {
-    const optionsWithoutPrompts = { context: mockContext };
-
-    const result = await chooseContents(
-      { docsDir: "/test/docs", workDir: "/test" },
-      optionsWithoutPrompts,
-    );
-
-    expect(result.message).toBe(
-      "Available options to clear: generatedDocs, documentStructure, documentConfig, authTokens, deploymentConfig",
-    );
-    expect(result.availableTargets).toEqual([
-      "generatedDocs",
-      "documentStructure",
-      "documentConfig",
-      "authTokens",
-      "deploymentConfig",
-    ]);
-  });
-
-  test("should handle agent errors gracefully", async () => {
-    mockClearAgents.clearGeneratedDocs.mockResolvedValue({
-      error: true,
-      message: "Failed to clear docs",
-    });
-
-    const result = await chooseContents({ targets: ["generatedDocs"] }, mockOptions);
-
-    expect(result.message).toContain("Cleanup finished with some issues.");
-    expect(result.message).toContain("Failed to clear docs");
-  });
-
-  test("should collect suggestions from agents", async () => {
-    const result = await chooseContents({ targets: ["documentConfig"] }, mockOptions);
-
-    expect(result.message).toContain(
-      "Run `aigne doc init` to generate a fresh configuration file.",
-    );
-  });
-
-  test("should handle all valid targets", async () => {
-    const result = await chooseContents(
-      { targets: ["generatedDocs", "documentStructure", "documentConfig", "authTokens"] },
-      mockOptions,
-    );
-
-    expect(mockContext.invoke).toHaveBeenCalledTimes(4);
-    expect(result.message).toContain("Cleanup completed successfully!");
-  });
-
-  test("should have correct input schema", () => {
-    expect(chooseContents.input_schema).toBeDefined();
-    expect(chooseContents.input_schema.type).toBe("object");
-    expect(chooseContents.input_schema.properties.targets.type).toBe("array");
-  });
-
-  test("should have correct task metadata", () => {
-    expect(chooseContents.taskTitle).toBe("Choose contents to clear");
-    expect(chooseContents.description).toBe(
-      "Choose contents to clear and execute the appropriate clearing operations",
-    );
-  });
-
-  test("should handle unknown targets by filtering them out", async () => {
-    // Test that unknown targets are filtered out and valid ones are processed
-    // Mix unknown targets with valid ones
-    const result = await chooseContents(
-      { targets: ["unknownTarget1", "generatedDocs", "invalidTarget", "documentConfig"] },
-      mockOptions,
-    );
-
-    // Should process only the valid targets and succeed
-    expect(result.message).toContain("Cleanup completed successfully!");
-    expect(mockContext.invoke).toHaveBeenCalledTimes(2); // Only valid targets processed
-    expect(mockClearAgents.clearGeneratedDocs).toHaveBeenCalled();
-    expect(mockClearAgents.clearDocumentConfig).toHaveBeenCalled();
-  });
-
-  test("should handle missing clear agent in context", async () => {
-    const optionsWithoutAgent = {
-      context: {
-        agents: {},
-        invoke: mockContext.invoke,
-      },
-    };
-
-    const result = await chooseContents({ targets: ["generatedDocs"] }, optionsWithoutAgent);
-
-    expect(result.message).toContain("Cleanup finished with some issues.");
-    expect(result.message).toContain("Clear agent 'clearGeneratedDocs' not found in context");
-  });
-
-  test("should handle agent execution errors", async () => {
-    const errorContext = {
-      agents: mockClearAgents,
-      invoke: mock(async () => {
-        throw new Error("Agent execution failed");
-      }),
-    };
-
-    const optionsWithError = {
-      context: errorContext,
-    };
-
-    const result = await chooseContents({ targets: ["generatedDocs"] }, optionsWithError);
-
-    expect(result.message).toContain("Cleanup finished with some issues.");
-    expect(result.message).toContain("Failed to clear generated documents: Agent execution failed");
-  });
-
-  test("should handle duplicate targets", async () => {
-    await chooseContents(
-      { targets: ["generatedDocs", "generatedDocs", "documentConfig"] },
-      mockOptions,
-    );
-
-    // Should only invoke each agent once due to deduplication
-    expect(mockContext.invoke).toHaveBeenCalledTimes(2);
-    expect(mockClearAgents.clearGeneratedDocs).toHaveBeenCalledTimes(1);
-    expect(mockClearAgents.clearDocumentConfig).toHaveBeenCalledTimes(1);
-  });
-
-  test("should handle empty and whitespace targets", async () => {
-    await chooseContents({ targets: ["", "  ", "generatedDocs", null, undefined] }, mockOptions);
-
-    // Should only process the valid target
-    expect(mockContext.invoke).toHaveBeenCalledTimes(1);
-    expect(mockClearAgents.clearGeneratedDocs).toHaveBeenCalled();
-  });
-
-  test("should add default suggestion when config is cleared", async () => {
-    // Mock clearDocumentConfig to return cleared: true but no suggestions
-    mockClearAgents.clearDocumentConfig.mockResolvedValue({
-      message: "Document config cleared",
-      cleared: true,
-      path: "/test/config.yaml",
-    });
-
-    const result = await chooseContents({ targets: ["documentConfig"] }, mockOptions);
-
-    expect(result.message).toContain(
-      "Run `aigne doc init` to generate a fresh configuration file.",
-    );
-  });
-
-  test("should not duplicate default suggestion when already present", async () => {
-    // Mock clearDocumentConfig to return the default suggestion
-    mockClearAgents.clearDocumentConfig.mockResolvedValue({
-      message: "Document config cleared",
-      cleared: true,
-      path: "/test/config.yaml",
-      suggestions: ["Run `aigne doc init` to generate a fresh configuration file."],
-    });
-
-    const result = await chooseContents({ targets: ["documentConfig"] }, mockOptions);
-
-    // Should only appear once in the message
-    const suggestionCount = (result.message.match(/Run `aigne doc init`/g) || []).length;
-    expect(suggestionCount).toBe(1);
-  });
-
-  test("should handle agents that return no cleared status", async () => {
-    mockClearAgents.clearGeneratedDocs.mockResolvedValue({
-      message: "No docs to clear",
-      // No cleared property
-    });
-
-    const result = await chooseContents({ targets: ["generatedDocs"] }, mockOptions);
-
-    expect(result.message).toContain("Cleanup completed successfully!");
-    expect(result.message).toContain("No docs to clear");
-  });
-});