@aigne/doc-smith 0.2.5 → 0.2.8

package/agents/language-selector.mjs

@@ -0,0 +1,89 @@
+import { SUPPORTED_LANGUAGES } from "../utils/constants.mjs";
+
+/**
+ * Interactive language selector for translation from configured languages
+ * @param {Object} params
+ * @param {Array<string>} [params.languages] - Pre-selected languages
+ * @param {Array<string>} params.translateLanguages - Available languages from config
+ * @param {Object} options - Options object with prompts
+ * @returns {Promise<Object>} Selected languages
+ */
+export default async function languageSelector({ languages, translateLanguages }, options) {
+  let selectedLanguages = [];
+
+  // Check if translateLanguages is available from config
+  if (
+    !translateLanguages ||
+    !Array.isArray(translateLanguages) ||
+    translateLanguages.length === 0
+  ) {
+    throw new Error(
+      "No translation languages configured in config.yaml. Please add translateLanguages to your configuration.",
+    );
+  }
+
+  // If languages are provided as parameter, validate against configured languages
+  if (languages && Array.isArray(languages) && languages.length > 0) {
+    const validLanguages = languages.filter((lang) => translateLanguages.includes(lang));
+
+    if (validLanguages.length > 0) {
+      selectedLanguages = validLanguages;
+    } else {
+      console.log(`⚠️  Invalid languages provided: ${languages.join(", ")}`);
+      console.log("Available configured languages:", translateLanguages.join(", "));
+    }
+  }
+
+  // If no valid languages were provided, let user select from configured languages
+  if (selectedLanguages.length === 0) {
+    // Create choices from configured languages with labels
+    const choices = translateLanguages.map((langCode) => {
+      const supportedLang = SUPPORTED_LANGUAGES.find((l) => l.code === langCode);
+      return {
+        name: supportedLang ? `${supportedLang.label} (${supportedLang.sample})` : langCode,
+        value: langCode,
+        short: langCode,
+      };
+    });
+
+    selectedLanguages = await options.prompts.checkbox({
+      message: "Select languages to translate:",
+      choices: choices,
+      validate: (answer) => {
+        if (answer.length === 0) {
+          return "Please select at least one language";
+        }
+        return true;
+      },
+    });
+  }
+
+  if (selectedLanguages.length === 0) {
+    throw new Error("No languages selected for re-translation");
+  }
+
+  return {
+    selectedLanguages,
+  };
+}
+
+languageSelector.input_schema = {
+  type: "object",
+  properties: {
+    languages: {
+      type: "array",
+      items: {
+        type: "string",
+      },
+      description: "Pre-selected languages for translation",
+    },
+    translateLanguages: {
+      type: "array",
+      items: {
+        type: "string",
+      },
+      description: "Available translation languages from config",
+    },
+  },
+  required: ["translateLanguages"],
+};

package/agents/load-config.mjs

@@ -1,5 +1,5 @@
-import path from "node:path";
 import fs from "node:fs/promises";
+import path from "node:path";
 import { parse } from "yaml";
 
 export default async function loadConfig({ config }) {
@@ -8,7 +8,7 @@ export default async function loadConfig({ config }) {
   try {
     // Check if config file exists
     await fs.access(configPath);
-  } catch (error) {
+  } catch (_error) {
     console.log(`Config file not found: ${configPath}`);
     console.log("Please run 'aigne doc init' to create the config file.");
     throw new Error(`Config file not found: ${configPath}`);

package/agents/load-sources.mjs

@@ -1,14 +1,8 @@
 import { access, readFile, stat } from "node:fs/promises";
 import path from "node:path";
 import { glob } from "glob";
-import {
-  getCurrentGitHead,
-  getModifiedFilesBetweenCommits,
-} from "../utils/utils.mjs";
-import {
-  DEFAULT_INCLUDE_PATTERNS,
-  DEFAULT_EXCLUDE_PATTERNS,
-} from "../utils/constants.mjs";
+import { DEFAULT_EXCLUDE_PATTERNS, DEFAULT_INCLUDE_PATTERNS } from "../utils/constants.mjs";
+import { getCurrentGitHead, getModifiedFilesBetweenCommits } from "../utils/utils.mjs";
 
 /**
  * Load .gitignore patterns from a directory
@@ -42,12 +36,7 @@ async function loadGitignore(dir) {
  * @param {string[]} gitignorePatterns - .gitignore patterns
  * @returns {Promise<string[]>} Array of file paths
  */
-async function getFilesWithGlob(
-  dir,
-  includePatterns,
-  excludePatterns,
-  gitignorePatterns
-) {
+async function getFilesWithGlob(dir, includePatterns, excludePatterns, gitignorePatterns) {
   // Prepare all ignore patterns
   const allIgnorePatterns = [];
 
@@ -88,9 +77,7 @@ async function getFilesWithGlob(
 
     return files;
   } catch (error) {
-    console.warn(
-      `Warning: Error during glob search in ${dir}: ${error.message}`
-    );
+    console.warn(`Warning: Error during glob search in ${dir}: ${error.message}`);
     return [];
   }
 }
@@ -143,14 +130,8 @@ export default async function loadSources({
                 : [excludePatterns]
               : [];
 
-            finalIncludePatterns = [
-              ...DEFAULT_INCLUDE_PATTERNS,
-              ...userInclude,
-            ];
-            finalExcludePatterns = [
-              ...DEFAULT_EXCLUDE_PATTERNS,
-              ...userExclude,
-            ];
+            finalIncludePatterns = [...DEFAULT_INCLUDE_PATTERNS, ...userInclude];
+            finalExcludePatterns = [...DEFAULT_EXCLUDE_PATTERNS, ...userExclude];
           } else {
             // Use only user patterns
             if (includePatterns) {
@@ -170,7 +151,7 @@ export default async function loadSources({
             dir,
             finalIncludePatterns,
             finalExcludePatterns,
-            gitignorePatterns
+            gitignorePatterns,
           );
           allFiles = allFiles.concat(filesInDir);
         }
@@ -194,7 +175,7 @@ export default async function loadSources({
         sourceId: relativePath,
         content,
       };
-    })
+    }),
   );
 
   // Get the last structure plan result
@@ -253,13 +234,8 @@ export default async function loadSources({
     try {
       currentGitHead = getCurrentGitHead();
       if (currentGitHead && currentGitHead !== lastGitHead) {
-        modifiedFiles = getModifiedFilesBetweenCommits(
-          lastGitHead,
-          currentGitHead
-        );
-        console.log(
-          `Detected ${modifiedFiles.length} modified files since last generation`
-        );
+        modifiedFiles = getModifiedFilesBetweenCommits(lastGitHead, currentGitHead);
+        console.log(`Detected ${modifiedFiles.length} modified files since last generation`);
       }
     } catch (error) {
       console.warn("Failed to detect git changes:", error.message);
@@ -290,18 +266,15 @@ loadSources.input_schema = {
     },
     includePatterns: {
       anyOf: [{ type: "string" }, { type: "array", items: { type: "string" } }],
-      description:
-        "Glob patterns to filter files by path or filename. If not set, include all.",
+      description: "Glob patterns to filter files by path or filename. If not set, include all.",
     },
     excludePatterns: {
       anyOf: [{ type: "string" }, { type: "array", items: { type: "string" } }],
-      description:
-        "Glob patterns to exclude files by path or filename. If not set, exclude none.",
+      description: "Glob patterns to exclude files by path or filename. If not set, exclude none.",
     },
     useDefaultPatterns: {
       type: "boolean",
-      description:
-        "Whether to use default include/exclude patterns. Defaults to true.",
+      description: "Whether to use default include/exclude patterns. Defaults to true.",
     },
     "doc-path": {
       type: "string",

package/agents/publish-docs.mjs

@@ -1,125 +1,17 @@
-import { join } from "node:path";
-import { joinURL } from "ufo";
-import open from "open";
-import { publishDocs as publishDocsFn } from "@aigne/publish-docs";
-import { createConnect } from "@aigne/cli/utils/load-aigne.js";
 import { existsSync, mkdirSync } from "node:fs";
 import { readFile, writeFile } from "node:fs/promises";
 import { homedir } from "node:os";
+import { basename, join } from "node:path";
+import { createConnect } from "@aigne/aigne-hub";
+import { publishDocs as publishDocsFn } from "@aigne/publish-docs";
+import open from "open";
+import { joinURL } from "ufo";
 import { parse, stringify } from "yaml";
-import { execSync } from "node:child_process";
-import { basename } from "node:path";
 import { loadConfigFromFile, saveValueToConfig } from "../utils/utils.mjs";
 
 const WELLKNOWN_SERVICE_PATH_PREFIX = "/.well-known/service";
 const DEFAULT_APP_URL = "https://docsmith.aigne.io";
 
-/**
- * Get GitHub repository information
- * @param {string} repoUrl - The repository URL
- * @returns {Promise<Object>} - Repository information
- */
-async function getGitHubRepoInfo(repoUrl) {
-  try {
-    // Extract owner and repo from GitHub URL
-    const match = repoUrl.match(
-      /github\.com[\/:]([^\/]+)\/([^\/]+?)(?:\.git)?$/
-    );
-    if (!match) return null;
-
-    const [, owner, repo] = match;
-    const apiUrl = `https://api.github.com/repos/${owner}/${repo}`;
-
-    const response = await fetch(apiUrl);
-    if (!response.ok) return null;
-
-    const data = await response.json();
-    return {
-      name: data.name,
-      description: data.description || "",
-      icon: data.owner?.avatar_url || "",
-    };
-  } catch (error) {
-    console.warn("Failed to fetch GitHub repository info:", error.message);
-    return null;
-  }
-}
-
-/**
- * Get project information with user confirmation
- * @param {Object} options - Options object containing prompts
- * @returns {Promise<Object>} - Project information including name, description, and icon
- */
-async function getProjectInfo(options) {
-  let repoInfo = null;
-  let defaultName = basename(process.cwd());
-  let defaultDescription = "";
-  let defaultIcon = "";
-
-  // Check if we're in a git repository
-  try {
-    const gitRemote = execSync("git remote get-url origin", {
-      encoding: "utf8",
-      stdio: ["pipe", "pipe", "ignore"],
-    }).trim();
-
-    // Extract repository name from git remote URL
-    const repoName = gitRemote.split("/").pop().replace(".git", "");
-    defaultName = repoName;
-
-    // If it's a GitHub repository, try to get additional info
-    if (gitRemote.includes("github.com")) {
-      repoInfo = await getGitHubRepoInfo(gitRemote);
-      if (repoInfo) {
-        defaultDescription = repoInfo.description;
-        defaultIcon = repoInfo.icon;
-      }
-    }
-  } catch (error) {
-    // Not in git repository or no origin remote, use current directory name
-    console.warn("No git repository found, using current directory name");
-  }
-
-  // Prompt user for project information
-  console.log("\n📋 Project Information for Documentation Platform");
-
-  const projectName = await options.prompts.input({
-    message: "Project name:",
-    default: defaultName,
-    validate: (input) => {
-      if (!input || input.trim() === "") {
-        return "Project name cannot be empty";
-      }
-      return true;
-    },
-  });
-
-  const projectDescription = await options.prompts.input({
-    message: "Project description (optional):",
-    default: defaultDescription,
-  });
-
-  const projectIcon = await options.prompts.input({
-    message: "Project icon URL (optional):",
-    default: defaultIcon,
-    validate: (input) => {
-      if (!input || input.trim() === "") return true;
-      try {
-        new URL(input);
-        return true;
-      } catch {
-        return "Please enter a valid URL";
-      }
-    },
-  });
-
-  return {
-    name: projectName.trim(),
-    description: projectDescription.trim(),
-    icon: projectIcon.trim(),
-  };
-}
-
 /**
  * Get access token from environment, config file, or prompt user for authorization
  * @param {string} appUrl - The application URL
@@ -142,7 +34,7 @@ async function getAccessToken(appUrl) {
         const data = await readFile(DOC_SMITH_ENV_FILE, "utf8");
         if (data.includes("DOC_DISCUSS_KIT_ACCESS_TOKEN")) {
           const envs = parse(data);
-          if (envs[hostname] && envs[hostname].DOC_DISCUSS_KIT_ACCESS_TOKEN) {
+          if (envs[hostname]?.DOC_DISCUSS_KIT_ACCESS_TOKEN) {
             accessToken = envs[hostname].DOC_DISCUSS_KIT_ACCESS_TOKEN;
           }
         }
@@ -207,7 +99,7 @@ async function getAccessToken(appUrl) {
 }
 
 export default async function publishDocs(
-  { docsDir, appUrl, boardId, boardName, boardDesc, boardCover },
+  { docsDir, appUrl, boardId, projectName, projectDesc, projectLogo },
   options
 ) {
   // Check if DOC_DISCUSS_KIT_URL is set in environment variables
@@ -222,7 +114,7 @@ export default async function publishDocs(
   // Check if appUrl is default and not saved in config (only when not using env variable)
   const config = await loadConfigFromFile();
   const isDefaultAppUrl = appUrl === DEFAULT_APP_URL;
-  const hasAppUrlInConfig = config && config.appUrl;
+  const hasAppUrlInConfig = config?.appUrl;
 
   if (!useEnvAppUrl && isDefaultAppUrl && !hasAppUrlInConfig) {
     const choice = await options.prompts.select({
@@ -260,58 +152,52 @@ export default async function publishDocs(
 
   const sidebarPath = join(docsDir, "_sidebar.md");
 
-  let projectInfo = {
-    name: boardName,
-    description: boardDesc,
-    icon: boardCover,
+  // Get project info from config
+  const projectInfo = {
+    name: projectName || config?.projectName || basename(process.cwd()),
+    description: projectDesc || config?.projectDesc || "",
+    icon: projectLogo || config?.projectLogo || "",
   };
 
-  // Only get project info if we need to create a new board
-  if (!boardName) {
-    projectInfo = await getProjectInfo(options);
-
-    // save project info to config
-    await saveValueToConfig("boardName", projectInfo.name);
-    await saveValueToConfig("boardDesc", projectInfo.description);
-    await saveValueToConfig("boardCover", projectInfo.icon);
-  }
+  try {
+    const { success, boardId: newBoardId } = await publishDocsFn({
+      sidebarPath,
+      accessToken,
+      appUrl,
+      boardId,
+      autoCreateBoard: true,
+      // Pass additional project information if available
+      boardName: projectInfo.name,
+      boardDesc: projectInfo.description,
+      boardCover: projectInfo.icon,
+    });
 
-  const {
-    success,
-    boardId: newBoardId,
-    docsUrl,
-  } = await publishDocsFn({
-    sidebarPath,
-    accessToken,
-    appUrl,
-    boardId,
-    autoCreateBoard: true,
-    // Pass additional project information if available
-    boardName: projectInfo.name,
-    boardDesc: projectInfo.description,
-    boardCover: projectInfo.icon,
-  });
+    // Save values to config.yaml if publish was successful
+    if (success) {
+      // Save appUrl to config only when not using environment variable
+      if (!useEnvAppUrl) {
+        await saveValueToConfig("appUrl", appUrl);
+      }
 
-  // Save values to config.yaml if publish was successful
-  if (success) {
-    // Save appUrl to config only when not using environment variable
-    if (!useEnvAppUrl) {
-      await saveValueToConfig("appUrl", appUrl);
+      // Save boardId to config if it was auto-created
+      if (boardId !== newBoardId) {
+        await saveValueToConfig(
+          "boardId",
+          newBoardId,
+          "⚠️ Warning: boardId is auto-generated by system, please do not edit manually"
+        );
+      }
     }
 
-    // Save boardId to config if it was auto-created
-    if (boardId !== newBoardId) {
-      await saveValueToConfig("boardId", newBoardId);
-    }
+    const message = `✅ Documentation Published Successfully!`;
+    return {
+      message,
+    };
+  } catch (error) {
+    return {
+      message: `❌ Failed to publish docs: ${error.message}`,
+    };
   }
-
-  //   const message = `## ✅ Documentation Published Successfully!
-
-  // Documentation is now available at: \`${docsUrl}\`
-  //   `;
-  return {
-    // message,
-  };
 }
 
 publishDocs.input_schema = {

package/agents/retranslate.yaml

@@ -0,0 +1,74 @@
+type: team
+name: retranslate
+alias:
+  - rt
+  - translate-again
+description: Re-translate individual document content to selected languages
+skills:
+  - url: ./input-generator.mjs
+    default_input:
+      skipIfExists: true
+  - ./load-config.mjs
+  - ./load-sources.mjs
+  - type: transform
+    jsonata: |
+      $merge([
+        $,
+        {
+          'structurePlan': originalStructurePlan,
+          'structurePlanResult': $map(originalStructurePlan, function($item) {
+            $merge([
+              $item,
+              {
+                'translates': [$map(translateLanguages, function($lang) { {"language": $lang} })]
+              }
+            ])
+          })
+        }
+      ])
+  - url: ./find-item-by-path.mjs
+    default_input:
+      isTranslate: true
+  - ./language-selector.mjs
+  - type: transform
+    jsonata: |
+      $merge([
+        $,
+        {
+          'translates': [$map(selectedLanguages, function($lang) { {"language": $lang} })]
+        }
+      ])
+  - ./batch-translate.yaml
+  - url: ./save-single-doc.mjs
+    default_input:
+      isTranslate: true
+      isShowMessage: true
+input_schema:
+  type: object
+  properties:
+    glossary:
+      type: string
+      description: Glossary of terms for consistent terminology
+    doc-path:
+      type: string
+      description: Document path to retranslate
+    # languages:
+    #   type: array
+    #   items:
+    #     type: string
+    #   description: Languages to translate to
+    feedback:
+      type: string
+      description: Feedback for translation improvement
+output_schema:
+  type: object
+  properties:
+    title:
+      type: string
+    description:
+      type: string
+    path:
+      type: string
+    content:
+      type: string
+mode: sequential

package/agents/save-docs.mjs

@@ -1,5 +1,6 @@
-import { writeFile, readdir, unlink } from "node:fs/promises";
+import { readdir, unlink, writeFile } from "node:fs/promises";
 import { join } from "node:path";
+import { shutdownMermaidWorkerPool } from "../utils/mermaid-worker-pool.mjs";
 import { getCurrentGitHead, saveGitHeadToConfig } from "../utils/utils.mjs";
 
 /**
@@ -14,8 +15,9 @@ export default async function saveDocs({
   docsDir,
   translateLanguages = [],
   locale,
+  projectInfoMessage,
 }) {
-  const results = [];
+  const _results = [];
   // Save current git HEAD to config.yaml for change detection
   try {
     const gitHead = getCurrentGitHead();
@@ -35,20 +37,16 @@ export default async function saveDocs({
 
   // Clean up invalid .md files that are no longer in the structure plan
   try {
-    await cleanupInvalidFiles(
-      structurePlan,
-      docsDir,
-      translateLanguages,
-      locale
-    );
+    await cleanupInvalidFiles(structurePlan, docsDir, translateLanguages, locale);
   } catch (err) {
     console.error("Failed to cleanup invalid .md files:", err.message);
   }
 
   const message = `## ✅ Documentation Generated Successfully!
 
-  Successfully generated **${structurePlan.length}** documents and saved to: \`${docsDir}\`
-
+  Successfully generated **${structurePlan.length}** documents and saved to:
+  \`${docsDir}\`
+  ${projectInfoMessage || ""}
   ### 🚀 Next Steps
 
   1. Publish Documentation
@@ -78,6 +76,13 @@ export default async function saveDocs({
   ---
   `;
 
+  // Shutdown mermaid worker pool to ensure clean exit
+  try {
+    await shutdownMermaidWorkerPool();
+  } catch (error) {
+    console.warn("Failed to shutdown mermaid worker pool:", error.message);
+  }
+
   return {
     message,
   };
@@ -102,12 +107,7 @@ function generateFileName(flatName, language) {
  * @param {string} locale - Main language locale (e.g., 'en', 'zh', 'fr')
  * @returns {Promise<Array<{ path: string, success: boolean, error?: string }>>}
  */
-async function cleanupInvalidFiles(
-  structurePlan,
-  docsDir,
-  translateLanguages,
-  locale
-) {
+async function cleanupInvalidFiles(structurePlan, docsDir, translateLanguages, locale) {
   const results = [];
 
   try {
@@ -135,7 +135,7 @@ async function cleanupInvalidFiles(
 
     // Find files to delete (files that are not in expectedFiles and not _sidebar.md)
     const filesToDelete = mdFiles.filter(
-      (file) => !expectedFiles.has(file) && file !== "_sidebar.md"
+      (file) => !expectedFiles.has(file) && file !== "_sidebar.md",
     );
 
     // Delete invalid files
@@ -158,9 +158,7 @@ async function cleanupInvalidFiles(
     }
 
     if (filesToDelete.length > 0) {
-      console.log(
-        `Cleaned up ${filesToDelete.length} invalid .md files from ${docsDir}`
-      );
+      console.log(`Cleaned up ${filesToDelete.length} invalid .md files from ${docsDir}`);
     }
   } catch (err) {
     // If docsDir doesn't exist or can't be read, that's okay
@@ -199,7 +197,7 @@ function generateSidebar(structurePlan) {
     for (const key of Object.keys(node)) {
       const item = node[key];
       const fullSegments = [...parentSegments, key];
-      const flatFile = fullSegments.join("-") + ".md";
+      const flatFile = `${fullSegments.join("-")}.md`;
       if (item.__title) {
         const realIndent = item.__parentId === null ? "" : indent;
         out += `${realIndent}* [${item.__title}](/${flatFile})\n`;

package/agents/save-output.mjs

@@ -1,12 +1,7 @@
 import { promises as fs } from "node:fs";
 import { join } from "node:path";
 
-export default async function saveOutput({
-  savePath,
-  fileName,
-  saveKey,
-  ...rest
-}) {
+export default async function saveOutput({ savePath, fileName, saveKey, ...rest }) {
   if (!(saveKey in rest)) {
     console.warn(`saveKey "${saveKey}" not found in input, skip saving.`);
     return {
@@ -17,9 +12,7 @@ export default async function saveOutput({
 
   const value = rest[saveKey];
   const content =
-    typeof value === "object" && value !== null
-      ? JSON.stringify(value, null, 2)
-      : String(value);
+    typeof value === "object" && value !== null ? JSON.stringify(value, null, 2) : String(value);
   await fs.mkdir(savePath, { recursive: true });
   const filePath = join(savePath, fileName);
   await fs.writeFile(filePath, content, "utf8");