@aigne/doc-smith 0.2.4 → 0.2.6

package/agents/input-generator.mjs

@@ -1,13 +1,16 @@
 import { writeFile, mkdir, readFile } from "node:fs/promises";
 import { join, dirname } from "node:path";
 import chalk from "chalk";
-import { validatePath, getAvailablePaths } from "../utils/utils.mjs";
+import {
+  validatePath,
+  getAvailablePaths,
+  getProjectInfo,
+} from "../utils/utils.mjs";
 import {
   SUPPORTED_LANGUAGES,
   DOCUMENT_STYLES,
   TARGET_AUDIENCES,
 } from "../utils/constants.mjs";
-
 // UI constants
 const PRESS_ENTER_TO_FINISH = "Press Enter to finish";
 
@@ -20,7 +23,7 @@ const PRESS_ENTER_TO_FINISH = "Press Enter to finish";
  */
 export default async function init(
   {
-    outputPath = "./doc-smith",
+    outputPath = ".aigne/doc-smith",
     fileName = "config.yaml",
     skipIfExists = false,
   },
@@ -40,11 +43,9 @@ export default async function init(
   const input = {};
 
   // 1. Document generation rules with style selection
-  console.log("📝 Step 1/6: Document Generation Rules");
-
   // Let user select a document style
   const styleChoice = await options.prompts.select({
-    message: "Choose your documentation style:",
+    message: "📝 Step 1/6: Choose your documentation style:",
     choices: Object.entries(DOCUMENT_STYLES).map(([key, style]) => ({
       name: `${style.name} - ${style.rules}`,
       value: key,
@@ -65,11 +66,9 @@ export default async function init(
   input.rules = rules.trim();
 
   // 2. Target audience selection
-  console.log("\n👥 Step 2/6: Target Audience");
-
   // Let user select target audience
   const audienceChoice = await options.prompts.select({
-    message: "Who is your target audience?",
+    message: "👥 Step 2/6: Who is your target audience?",
     choices: Object.entries(TARGET_AUDIENCES).map(([key, audience]) => ({
       name: audience,
       value: key,
@@ -90,11 +89,9 @@ export default async function init(
   input.targetAudience = targetAudience.trim();
 
   // 3. Language settings
-  console.log("\n🌐 Step 3/6: Primary Language");
-
   // Let user select primary language from supported list
   const primaryLanguageChoice = await options.prompts.select({
-    message: "Choose primary documentation language:",
+    message: "🌐 Step 3/6: Choose primary documentation language:",
     choices: SUPPORTED_LANGUAGES.map((lang) => ({
       name: `${lang.label} - ${lang.sample}`,
       value: lang.code,
@@ -104,15 +101,13 @@ export default async function init(
   input.locale = primaryLanguageChoice;
 
   // 4. Translation languages
-  console.log("\n🔄 Step 4/6: Translation Languages");
-
   // Filter out the primary language from available choices
   const availableTranslationLanguages = SUPPORTED_LANGUAGES.filter(
     (lang) => lang.code !== primaryLanguageChoice
   );
 
   const translateLanguageChoices = await options.prompts.checkbox({
-    message: "Select translation languages:",
+    message: "🔄 Step 4/6: Select translation languages:",
     choices: availableTranslationLanguages.map((lang) => ({
       name: `${lang.label} - ${lang.sample}`,
       value: lang.code,
@@ -122,9 +117,8 @@ export default async function init(
   input.translateLanguages = translateLanguageChoices;
 
   // 5. Documentation directory
-  console.log("\n📁 Step 5/6: Output Directory");
   const docsDirInput = await options.prompts.input({
-    message: `Where to save generated docs:`,
+    message: `📁 Step 5/6: Where to save generated docs:`,
     default: `${outputPath}/docs`,
   });
   input.docsDir = docsDirInput.trim() || `${outputPath}/docs`;
@@ -189,6 +183,12 @@ export default async function init(
   // If no paths entered, use default
   input.sourcesPath = sourcePaths.length > 0 ? sourcePaths : ["./"];
 
+  // Save project info to config
+  const projectInfo = await getProjectInfo();
+  input.projectName = projectInfo.name;
+  input.projectDesc = projectInfo.description;
+  input.projectLogo = projectInfo.icon;
+
   // Generate YAML content
   const yamlContent = generateYAML(input, outputPath);
 
@@ -202,13 +202,17 @@ export default async function init(
 
     await writeFile(filePath, yamlContent, "utf8");
     console.log(`\n🎉 Configuration saved to: ${chalk.cyan(filePath)}`);
+    // Print YAML content for user review
+    console.log(chalk.cyan("---"));
+    console.log(chalk.cyan(yamlContent));
+    console.log(chalk.cyan("---"));
     console.log(
-      "💡 You can edit the configuration file anytime to modify settings."
+      "💡 You can edit the configuration file anytime to modify settings.\n"
     );
     console.log(
       `🚀 Run ${chalk.cyan(
         "'aigne doc generate'"
-      )} to start documentation generation!`
+      )} to start documentation generation!\n`
     );
 
     return {};
@@ -224,12 +228,18 @@ export default async function init(
 /**
  * Generate YAML configuration content
  * @param {Object} input - Input object
- * @param {string} outputPath - Output path for directory configuration
  * @returns {string} YAML string
  */
-function generateYAML(input, outputPath) {
+function generateYAML(input) {
   let yaml = "";
 
+  // Add project information at the beginning
+  yaml += `# Project information for documentation publishing\n`;
+  yaml += `projectName: ${input.projectName || ""}\n`;
+  yaml += `projectDesc: ${input.projectDesc || ""}\n`;
+  yaml += `projectLogo: ${input.projectLogo || ""}\n`;
+  yaml += `\n`;
+
   // Add rules (required field)
   yaml += `rules: |\n`;
   if (input.rules && input.rules.trim()) {

package/agents/language-selector.mjs

@@ -0,0 +1,101 @@
+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

@@ -22,8 +22,8 @@ export default async function loadConfig({ config }) {
       nodeName: "Section",
       locale: "en",
       sourcesPath: ["./"],
-      docDir: "./doc-smith/docs",
-      outputDir: "./doc-smith/output",
+      docsDir: "./.aigne/doc-smith/docs",
+      outputDir: "./.aigne/doc-smith/output",
       lastGitHead: parsedConfig.lastGitHead || "",
       ...parsedConfig,
     };
@@ -38,7 +38,7 @@ loadConfig.input_schema = {
   properties: {
     config: {
       type: "string",
-      default: "./doc-smith/config.yaml",
+      default: "./.aigne/doc-smith/config.yaml",
     },
   },
 };

package/agents/load-sources.mjs

@@ -1,4 +1,4 @@
-import { access, readFile } from "node:fs/promises";
+import { access, readFile, stat } from "node:fs/promises";
 import path from "node:path";
 import { glob } from "glob";
 import {
@@ -115,50 +115,65 @@ export default async function loadSources({
 
     for (const dir of paths) {
       try {
-        // Load .gitignore for this directory
-        const gitignorePatterns = await loadGitignore(dir);
+        // Check if the path is a file or directory
+        const stats = await stat(dir);
 
-        // Prepare patterns
-        let finalIncludePatterns = null;
-        let finalExcludePatterns = null;
+        if (stats.isFile()) {
+          // If it's a file, add it directly without filtering
+          allFiles.push(dir);
+        } else if (stats.isDirectory()) {
+          // If it's a directory, use the existing glob logic
+          // Load .gitignore for this directory
+          const gitignorePatterns = await loadGitignore(dir);
 
-        if (useDefaultPatterns) {
-          // Merge with default patterns
-          const userInclude = includePatterns
-            ? Array.isArray(includePatterns)
-              ? includePatterns
-              : [includePatterns]
-            : [];
-          const userExclude = excludePatterns
-            ? Array.isArray(excludePatterns)
-              ? excludePatterns
-              : [excludePatterns]
-            : [];
+          // Prepare patterns
+          let finalIncludePatterns = null;
+          let finalExcludePatterns = null;
 
-          finalIncludePatterns = [...DEFAULT_INCLUDE_PATTERNS, ...userInclude];
-          finalExcludePatterns = [...DEFAULT_EXCLUDE_PATTERNS, ...userExclude];
-        } else {
-          // Use only user patterns
-          if (includePatterns) {
-            finalIncludePatterns = Array.isArray(includePatterns)
-              ? includePatterns
-              : [includePatterns];
-          }
-          if (excludePatterns) {
-            finalExcludePatterns = Array.isArray(excludePatterns)
-              ? excludePatterns
-              : [excludePatterns];
+          if (useDefaultPatterns) {
+            // Merge with default patterns
+            const userInclude = includePatterns
+              ? Array.isArray(includePatterns)
+                ? includePatterns
+                : [includePatterns]
+              : [];
+            const userExclude = excludePatterns
+              ? Array.isArray(excludePatterns)
+                ? excludePatterns
+                : [excludePatterns]
+              : [];
+
+            finalIncludePatterns = [
+              ...DEFAULT_INCLUDE_PATTERNS,
+              ...userInclude,
+            ];
+            finalExcludePatterns = [
+              ...DEFAULT_EXCLUDE_PATTERNS,
+              ...userExclude,
+            ];
+          } else {
+            // Use only user patterns
+            if (includePatterns) {
+              finalIncludePatterns = Array.isArray(includePatterns)
+                ? includePatterns
+                : [includePatterns];
+            }
+            if (excludePatterns) {
+              finalExcludePatterns = Array.isArray(excludePatterns)
+                ? excludePatterns
+                : [excludePatterns];
+            }
           }
-        }
 
-        // Get files using glob
-        const filesInDir = await getFilesWithGlob(
-          dir,
-          finalIncludePatterns,
-          finalExcludePatterns,
-          gitignorePatterns
-        );
-        allFiles = allFiles.concat(filesInDir);
+          // Get files using glob
+          const filesInDir = await getFilesWithGlob(
+            dir,
+            finalIncludePatterns,
+            finalExcludePatterns,
+            gitignorePatterns
+          );
+          allFiles = allFiles.concat(filesInDir);
+        }
       } catch (err) {
         if (err.code !== "ENOENT") throw err;
       }

package/agents/publish-docs.mjs

@@ -7,119 +7,12 @@ import { existsSync, mkdirSync } from "node:fs";
 import { readFile, writeFile } from "node:fs/promises";
 import { homedir } from "node:os";
 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
@@ -207,7 +100,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
@@ -260,58 +153,56 @@ 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,
+      docsUrl,
+    } = 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