@aigne/doc-smith 0.8.6 → 0.8.8

package/{agents → utils}/load-config.mjs

@@ -1,10 +1,10 @@
 import fs from "node:fs/promises";
 import path from "node:path";
 import { parse } from "yaml";
-import { processConfigFields, resolveFileReferences } from "../utils/utils.mjs";
+import { processConfigFields, resolveFileReferences } from "./utils.mjs";
 
 export default async function loadConfig({ config, appUrl }) {
-  const configPath = path.join(process.cwd(), config);
+  const configPath = path.isAbsolute(config) ? config : path.join(process.cwd(), config);
 
   try {
     // Check if config file exists
@@ -40,19 +40,3 @@ export default async function loadConfig({ config, appUrl }) {
     throw new Error(`Failed to parse config file: ${error.message}`);
   }
 }
-
-loadConfig.input_schema = {
-  type: "object",
-  properties: {
-    config: {
-      type: "string",
-      default: "./.aigne/doc-smith/config.yaml",
-    },
-    appUrl: {
-      type: "string",
-      description: "Application URL to override config",
-    },
-  },
-};
-
-loadConfig.task_render_mode = "hide";

package/utils/markdown-checker.mjs

@@ -8,7 +8,7 @@ import { unified } from "unified";
 import { visit } from "unist-util-visit";
 import { VFile } from "vfile";
 import { KROKI_CONCURRENCY } from "./constants.mjs";
-import { checkD2Content } from "./kroki-utils.mjs";
+import { checkContent, isValidCode } from "./d2-utils.mjs";
 import { validateMermaidSyntax } from "./mermaid-validator.mjs";
 
 /**
@@ -90,7 +90,7 @@ function checkDeadLinks(markdown, source, allowedLinks, errorMessages) {
     // Check if this link is in the allowed links set
     if (!allowedLinks.has(path)) {
       errorMessages.push(
-        `Found a dead link in ${source}: [${match[1]}](${trimLink}), ensure the link exists in the structure plan path`,
+        `Found a dead link in ${source}: [${match[1]}](${trimLink}), ensure the link exists in the document structure path`,
       );
     }
   }
@@ -300,7 +300,7 @@ function checkContentStructure(markdown, source, errorMessages) {
   }
 
   // Check if content ends with proper punctuation (indicating completeness)
-  const validEndingPunctuation = [".", "。", ")", "|", "*", ">", "`"];
+  const validEndingPunctuation = [".", "。", ")", "|", "*", ">", "`", "!"];
   const trimmedText = markdown.trim();
   const hasValidEnding = validEndingPunctuation.some((punct) => trimmedText.endsWith(punct));
 
@@ -467,7 +467,7 @@ export async function checkMarkdown(markdown, source = "content", options = {})
             specialCharMatch = nodeWithSpecialCharsRegex.exec(mermaidContent);
           }
         }
-        if (node.lang.toLowerCase() === "d2") {
+        if (isValidCode(node.lang)) {
           d2ChecksList.push({
             content: node.value,
             line,
@@ -527,7 +527,7 @@ export async function checkMarkdown(markdown, source = "content", options = {})
     await pMap(
       d2ChecksList,
       async ({ content, line }) =>
-        checkD2Content({ content }).catch((err) => {
+        checkContent({ content }).catch((err) => {
           const errorMessage = err?.message || String(err) || "Unknown d2 syntax error";
           errorMessages.push(`Found D2 syntax error in ${source} at line ${line}: ${errorMessage}`);
         }),

package/agents/batch-docs-detail-generator.yaml

@@ -1,19 +0,0 @@
-type: team
-name: batchDocsDetailGenerate
-description: 批量生成文档详情
-skills:
-  - ./check-detail.mjs
-input_schema:
-  type: object
-  properties:
-    datasources:
-      type: string
-      description: 结构规划的上下文，用于辅助结构规划
-    structurePlanResult: ./schema/structure-plan-result.yaml
-    modifiedFiles:
-      type: array
-      items: { type: string }
-      description: Array of modified files since last generation
-iterate_on: structurePlanResult
-concurrency: 3
-mode: sequential

package/agents/check-structure-planning-result.yaml

@@ -1,30 +0,0 @@
-name: checkStructurePlanResult
-description: 对 structure-planning agent 生成的结果进行检查，确保其符合预期，特别是在有上一轮生成结果和用户反馈的场景下。
-instructions:
-  url: ../prompts/check-structure-planning-result.md
-input_schema:
-  type: object
-  properties:
-    structurePlan:
-      $ref: ./schema/structure-plan.yaml
-      description: 新一轮生成的结构规划。
-    originalStructurePlan:
-      $ref: ./schema/structure-plan.yaml
-      description: 上一轮生成的结构规划，用于对比。如果不存在，则检查默认通过。
-    feedback:
-      type: string
-      description: 用户针对上一轮结果提供的反馈。
-  required:
-    - structurePlan
-output_schema:
-  type: object
-  properties:
-    isValid:
-      type: boolean
-      description: 检查是否通过。true 表示通过，false 表示不通过。
-    structureReviewFeedback:
-      type: string
-      description: 检查结果的详细说明。如果不通过，需要明确指出哪里不符合要求。
-  required:
-    - isValid
-    - structureReviewFeedback

package/agents/content-detail-generator.yaml

@@ -1,50 +0,0 @@
-name: contentDetailGenerator
-description: 通用内容详情生成器，支持网站、文档、书籍、演示文稿等多种场景
-instructions:
-  url: ../prompts/content-detail-generator.md
-input_schema:
-  type: object
-  properties:
-    rules:
-      type: string
-      description: 用户的结构规划的要求
-    locale:
-      type: string
-      description: 用户语言，如 zh、en
-    datasources:
-      type: string
-      description: 结构规划的上下文，用于辅助结构规划
-    targetAudience:
-      type: string
-      description: 结构规划的目标受众
-    nodeName:
-      type: string
-      description: 结构规划的节点名称
-    originalStructurePlan: ./schema/structure-plan.yaml
-    title:
-      type: string
-    description:
-      type: string
-    path:
-      type: string
-    parentId:
-      type:
-        - string
-        - "null"
-    glossary:
-      type: string
-      description: 术语表
-    additionalInformation:
-      type: string
-      description: 额外补充信息
-  required:
-    - rules
-    - datasources
-    - originalStructurePlan
-output_schema:
-  type: object
-  properties:
-    content:
-      type: string
-  required:
-    - content

package/agents/format-structure-plan.mjs

@@ -1,25 +0,0 @@
-import { stringify } from "yaml";
-
-export default async function formatStructurePlan({ structurePlan }) {
-  // Extract required fields from each item in structurePlan
-  const formattedData = structurePlan.map((item) => ({
-    title: item.title,
-    path: item.path,
-    parentId: item.parentId,
-    description: item.description,
-  }));
-
-  // Convert to YAML string
-  const yamlString = stringify(formattedData, {
-    indent: 2,
-    lineWidth: 120,
-    minContentWidth: 20,
-  });
-
-  return {
-    structurePlanYaml: yamlString,
-    structurePlan,
-  };
-}
-
-formatStructurePlan.task_render_mode = "hide";

package/agents/reflective-structure-planner.yaml

@@ -1,12 +0,0 @@
-type: team
-name: structurePlanning
-description: A team of agents that plan the structure of the documentation.
-skills:
-  - structure-planning.yaml
-task_title: Plan the structure of the documentation
-task_render_mode: collapse
-reflection:
-  reviewer: check-structure-planning-result.yaml
-  is_approved: isValid
-  max_iterations: 3
-  return_last_on_max_iterations: true

package/agents/schema/structure-plan.yaml

@@ -1,26 +0,0 @@
-type: array
-items:
-  type: object
-  properties:
-    title:
-      type: string
-    description:
-      type: string
-    path:
-      type: string
-      description: 路径，以 RUL 的格式返回，不能为空, 不能包含空格等特殊字符, 必须以 / 开头，不需要包含语言层级，比如 /zh/about 直接返回 /about
-    parentId:
-      type:
-        - string
-        - "null"
-      description: 父节点 path，如果为 null 则表示是顶级节点
-    sourceIds:
-      type: array
-      description: 关联的 dataSources 中的 sourceId，用于后续的翻译和内容生成，必须来自 datasources 中的 sourceId，不能有虚假的 id, **不能为空**
-      items:
-        type: string
-  required:
-    - title
-    - description
-    - path
-    - sourceIds

package/prompts/document/custom-components.md

@@ -1,104 +0,0 @@
-<custom_component>
-When generating document details, you can use the following custom components at appropriate locations based on their descriptions and functionality to enhance document presentation:
-- `<x-card>`
-- `<x-cards>`
-
-
-### 1. <x-card> Single Card Component
-Suitable for displaying individual links with a richer and more visually appealing presentation format.
-
-Example:
-
-```
-<x-card data-title="Required Title" data-image="Image URL" data-icon="Icon identifier (e.g., lucide:rocket or material-symbols:rocket-outline)" data-href="Navigation link URL" data-horizontal="true/false" data-cta="Button text" >
-  Card body content
-</x-card>
-```
-
-Attribute Rules:
-
--	data-title (required): Card title.
--	data-icon / data-image (choose one, at least one must be provided):
-    -	It's recommended to always provide data-icon.
-    -	Icons should prioritize Lucide (lucide:icon-name). If not available in Lucide, use Iconify (collection:icon-name, e.g., material-symbols:rocket-outline).
--	data-image (optional): Image URL, can coexist with icon.
--	data-href (optional): Navigation link for clicking the card or button.
--	data-horizontal (optional): Whether to use horizontal layout.
--	data-cta (optional): Button text (call to action).
--	Body content: 
-  - Must be written within <x-card>...</x-card> children.
-  - **Markdown format rendering is not supported**
-  - **Code block rendering is not supported**
-  - Only supports plain text format without styling
-
-
-### 2. `<x-cards>` Card List Component
-
-Suitable for displaying multiple links using a card list format, providing a richer and more visually appealing presentation.
-
-Syntax:
-
-```
-<x-cards data-columns="Number of columns">
-  <x-card data-title="Title 1" data-icon="lucide:rocket">Content 1</x-card>
-  <x-card data-title="Title 2" data-icon="lucide:bolt">Content 2</x-card>
-  <x-card data-title="Title 3" data-icon="material-symbols:rocket-outline">Content 3</x-card>
-</x-cards>
-```
-
-Attribute Rules:
--	data-columns (optional): Number of columns, integer (e.g., 2, 3). Default is 2.
--	Must contain multiple <x-card> elements internally.
--	Consistency requirement: All <x-card> elements within the same <x-cards> must maintain visual consistency:
-    -	Recommended to always provide data-icon for each card.
-    -	Or all cards should have data-image.
-    -	Avoid mixing (some with icons, some with only images).
-
-<good_example>
-Use plain text without any styling
-<x-card data-title="alarm()" data-icon="lucide:alarm-clock"> SIGALRM: Sent when a real-time timer has expired.  </x-card>
-
-Single card:
-<x-card data-title="Horizontal card" data-icon="lucide:atom" data-horizontal="true">
-  This is an example of a horizontal card.
-</x-card>
-
-Card list (all using icons, recommended approach):
-<x-cards data-columns="3">
-  <x-card data-title="Feature 1" data-icon="lucide:rocket">Description of Feature 1.</x-card>
-  <x-card data-title="Feature 2" data-icon="lucide:bolt">Description of Feature 2.</x-card>
-  <x-card data-title="Feature 3" data-icon="material-symbols:rocket-outline">Description of Feature 3.</x-card>
-</x-cards>
-
-Card list (all using images):
-<x-cards data-columns="2">
-  <x-card data-title="Card A" data-image="https://picsum.photos/id/10/300/300">Content A</x-card>
-  <x-card data-title="Card B" data-image="https://picsum.photos/id/11/300/300">Content B</x-card>
-</x-cards>
-</good_example>
-
-<bad_example>
-
-`x-card` component body does not support markdown formatting inline code block
-<x-card data-title="alarm()" data-icon="lucide:alarm-clock"> `SIGALRM`: Sent when a real-time timer has expired.  </x-card>
-
-
-`x-card` component body does not support code blocks
-<x-card data-title="ctrl_break()" data-icon="lucide:keyboard">
-Creates a listener for "ctrl-break" events.
-```rust,no_run
-use tokio::signal::windows::ctrl_break;
-
-#[tokio::main]
-async fn main() -> std::io::Result<()> {
-let mut stream = ctrl_break()?;
-stream.recv().await;
-println!("got ctrl-break");
-Ok(())
-}
-```
-</x-card>
-
-</bad_example>
-
-</custom_component>

package/tests/README.md

@@ -1,93 +0,0 @@
-# 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.