@aigne/doc-smith 0.2.4 → 0.2.5

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.2.5](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.2.4...v0.2.5) (2025-08-08)
+
+
+### Bug Fixes
+
+* polish cli process ([#17](https://github.com/AIGNE-io/aigne-doc-smith/issues/17)) ([4c94263](https://github.com/AIGNE-io/aigne-doc-smith/commit/4c9426378dff9ca3270bd0e455aa6fb1045f6abb))
+
 ## [0.2.4](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.2.3...v0.2.4) (2025-08-07)
 
 

package/agents/check-detail-result.mjs

@@ -128,6 +128,22 @@ export default async function checkDetailResult({
             `Found backticks in Mermaid node label in ${source} at line ${lineNumber}: "${label}" - backticks in node labels cause rendering issues in Mermaid diagrams`
           );
         }
+
+        // Check for edge descriptions with numbered list format
+        // Pattern: -- "1. description" --> or similar variants
+        const edgeDescriptionRegex = /--\s*"([^"]*)"\s*-->/g;
+        let edgeMatch;
+
+        while ((edgeMatch = edgeDescriptionRegex.exec(line)) !== null) {
+          const description = edgeMatch[1];
+          // Check if description starts with number followed by period
+          if (/^\d+\.\s/.test(description)) {
+            isApproved = false;
+            detailFeedback.push(
+              `Unsupported markdown: list - Found numbered list format in Mermaid edge description in ${source} at line ${lineNumber}: "${description}" - numbered lists in edge descriptions are not supported`
+            );
+          }
+        }
       }
     }
 

package/agents/detail-regenerator.yaml

@@ -31,20 +31,10 @@ skills:
 input_schema:
   type: object
   properties:
-    config:
-      type: string
-      description: Path to the config file
-      default: ./doc-smith/config.yaml
-    # nodeName:
-    #   type: string
-    #   description: Name of the section to generate documentation for
-    #   default: Section
-    # locale:
-    #   type: string
-    #   description: Primary language for documentation (e.g., zh, en)
-    # targetAudience:
+    # config:
     #   type: string
-    #   description: Target audience for the documentation
+    #   description: Path to the config file
+    #   default: ./.aigne/doc-smith/config.yaml
     glossary:
       type: string
       description: Glossary of terms for consistent terminology
@@ -54,49 +44,6 @@ input_schema:
     feedback:
       type: string
       description: Feedback for content improvement
-    # sources:
-    #   type: array
-    #   items:
-    #     type: string
-    #   description: Source code files for documentation generation
-    # sourcesPath:
-    #   type: array
-    #   description: Source code paths
-    #   items:
-    #     type: string
-    #   default:
-    #     - ./
-    # includePatterns:
-    #   type: array
-    #   description: File patterns to include
-    #   items:
-    #     type: string
-    # excludePatterns:
-    #   type: array
-    #   description: File patterns to exclude
-    #   items:
-    #     type: string
-    # outputDir:
-    #   type: string
-    #   description: Output directory for intermediate files
-    #   default: ./doc-smith/output
-    # docsDir:
-    #   type: string
-    #   description: Directory to save generated documentation
-    #   default: ./doc-smith/docs
-    # additionalInformation:
-    #   type: string
-    #   description: Additional context or information for documentation
-    # translateLanguages:
-    #   type: array
-    #   items:
-    #     type: string
-    #     description: Target languages for translation (e.g., zh, en)
-    # labels:
-    #   type: array
-    #   items:
-    #     type: string
-    #     description: Tags or labels for categorization
 output_schema:
   type: object
   properties:

package/agents/docs-generator.yaml

@@ -40,76 +40,19 @@ skills:
 input_schema:
   type: object
   properties:
-    config:
-      type: string
-      description: Path to the config file
-      default: ./doc-smith/config.yaml
-    # nodeName:
-    #   type: string
-    #   description: Name of the section to generate documentation for
-    #   default: Section
-    # rules:
-    #   type: string
-    #   description: Documentation generation requirements and rules
-    # locale:
-    #   type: string
-    #   description: Primary language for documentation (e.g., zh, en)
-    # sources:
-    #   type: array
-    #   items:
-    #     type: string
-    #   description: Source code files for documentation generation
-    # sourcesPath:
-    #   type: array
-    #   description: Source code paths
-    #   items:
-    #     type: string
-    #   default:
-    #     - ./
-    # includePatterns:
-    #   type: array
-    #   description: File patterns to include
-    #   items:
-    #     type: string
-    # excludePatterns:
-    #   type: array
-    #   description: File patterns to exclude
-    #   items:
-    #     type: string
-    # docsDir:
+    # config:
     #   type: string
-    #   description: Directory to save generated documentation
-    #   default: ./doc-smith/docs
-    # outputDir:
-    #   type: string
-    #   description: Output directory for intermediate files
-    #   default: ./doc-smith/output
-    # translateLanguages:
-    #   type: array
-    #   items:
-    #     type: string
-    #     description: Target languages for translation (e.g., zh, en)
+    #   description: Path to the config file
+    #   default: ./.aigne/doc-smith/config.yaml
     glossary:
       type: string
       description: Glossary of terms for consistent terminology
-    # additionalInformation:
-    #   type: string
-    #   description: Additional context or information for documentation
-    # docsType:
-    #   type: string
-    #   description: Type of documentation (general, getting-started, reference, faq)
-    #   default: general
     feedback:
       type: string
       description: Feedback for structure planning adjustments
     forceRegenerate:
       type: boolean
       description: Force regenerate all documentation
-    # labels:
-    #   type: array
-    #   items:
-    #     type: string
-    #     description: Tags or labels for categorization
   required:
     - config
 mode: sequential

package/agents/input-generator.mjs

@@ -20,7 +20,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 +40,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 +63,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 +86,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 +98,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 +114,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`;

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/save-output.mjs

@@ -1,8 +1,12 @@
 import { promises as fs } from "node:fs";
 import { join } from "node:path";
 
-export default async function saveOutput({ savePath, fileName, saveKey, ...rest }) {
-  console.log("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 {
@@ -13,7 +17,9 @@ export default async function saveOutput({ savePath, fileName, saveKey, ...rest
 
   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");

package/agents/team-publish-docs.yaml

@@ -10,10 +10,10 @@ skills:
       skipIfExists: true
   - load-config.mjs
   - publish-docs.mjs
-input_schema:
-  type: object
-  properties:
-    config:
-      type: string
-      description: Path to the config file
-      default: ./doc-smith/config.yaml
+# input_schema:
+#   type: object
+#   properties:
+#     config:
+#       type: string
+#       description: Path to the config file
+#       default: ./.aigne/doc-smith/config.yaml

package/docs-mcp/docs-search.yaml

@@ -18,7 +18,7 @@ input_schema:
     config:
       type: string
       description: Path to the config file
-      default: ./doc-smith/config.yaml
+      default: ./.aigne/doc-smith/config.yaml
 output_schema:
   type: object
   properties:

package/docs-mcp/get-docs-detail.mjs

@@ -1,7 +1,7 @@
 import fs from "node:fs/promises";
 import path from "node:path";
 
-const docsDir = path.join(process.cwd(), "doc-smith", "docs");
+const docsDir = path.join(process.cwd(), "./.aigne/doc-smith", "docs");
 
 export default async function getDocDetail({ path: docPath }) {
   try {

package/docs-mcp/get-docs-structure.mjs

@@ -3,7 +3,7 @@ import path from "node:path";
 
 const structureDir = path.join(
   process.cwd(),
-  "doc-smith",
+  "./.aigne/doc-smith",
   "output",
   "structure-plan.json"
 );

package/docs-mcp/read-doc-content.mjs

@@ -1,7 +1,7 @@
 import fs from "node:fs/promises";
 import path from "node:path";
 
-const docsDir = path.join(process.cwd(), "doc-smith", "docs");
+const docsDir = path.join(process.cwd(), "./.aigne/doc-smith", "docs");
 
 export default async function readDocContent({
   relevantDocPaths,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aigne/doc-smith",
-  "version": "0.2.4",
+  "version": "0.2.5",
   "description": "",
   "publishConfig": {
     "access": "public"

package/utils/constants.mjs

@@ -25,6 +25,7 @@ export const DEFAULT_INCLUDE_PATTERNS = [
 export const DEFAULT_EXCLUDE_PATTERNS = [
   "aigne-docs/**",
   "doc-smith/**",
+  ".aigne/**",
   "assets/**",
   "data/**",
   "images/**",
@@ -62,14 +63,14 @@ export const DEFAULT_EXCLUDE_PATTERNS = [
 // Supported languages for documentation
 export const SUPPORTED_LANGUAGES = [
   { code: "en", label: "English (en)", sample: "Hello" },
-  { code: "zh-CN", label: "简体中文 (zh-CN)", sample: "你好" },
+  { code: "zh", label: "简体中文 (zh)", sample: "你好" },
   { code: "zh-TW", label: "繁體中文 (zh-TW)", sample: "你好" },
   { code: "ja", label: "日本語 (ja)", sample: "こんにちは" },
   { code: "ko", label: "한국어 (ko)", sample: "안녕하세요" },
   { code: "es", label: "Español (es)", sample: "Hola" },
   { code: "fr", label: "Français (fr)", sample: "Bonjour" },
   { code: "de", label: "Deutsch (de)", sample: "Hallo" },
-  { code: "pt-BR", label: "Português (pt-BR)", sample: "Olá" },
+  { code: "pt", label: "Português (pt)", sample: "Olá" },
   { code: "ru", label: "Русский (ru)", sample: "Привет" },
   { code: "it", label: "Italiano (it)", sample: "Ciao" },
   { code: "ar", label: "العربية (ar)", sample: "مرحبا" },

package/utils/utils.mjs

@@ -162,7 +162,7 @@ export async function saveGitHeadToConfig(gitHead) {
   }
 
   try {
-    const docSmithDir = path.join(process.cwd(), "doc-smith");
+    const docSmithDir = path.join(process.cwd(), "./.aigne/doc-smith");
     if (!existsSync(docSmithDir)) {
       mkdirSync(docSmithDir, { recursive: true });
     }
@@ -345,7 +345,11 @@ export function hasFileChangesBetweenCommits(
  * @returns {Promise<Object|null>} - The config object or null if file doesn't exist
  */
 export async function loadConfigFromFile() {
-  const configPath = path.join(process.cwd(), "doc-smith", "config.yaml");
+  const configPath = path.join(
+    process.cwd(),
+    "./.aigne/doc-smith",
+    "config.yaml"
+  );
 
   try {
     if (!existsSync(configPath)) {
@@ -371,7 +375,7 @@ export async function saveValueToConfig(key, value) {
   }
 
   try {
-    const docSmithDir = path.join(process.cwd(), "doc-smith");
+    const docSmithDir = path.join(process.cwd(), "./.aigne/doc-smith");
     if (!existsSync(docSmithDir)) {
       mkdirSync(docSmithDir, { recursive: true });
     }
@@ -472,20 +476,20 @@ export function validatePaths(paths) {
 }
 
 /**
- * Check if input is a valid directory and add it to results if so
+ * Check if input is a valid directory or file and add it to results if so
  * @param {string} searchTerm - The search term to check
  * @param {Array} results - The results array to modify
  */
-function addExactDirectoryMatch(searchTerm, results) {
+function addExactPathMatch(searchTerm, results) {
   const inputValidation = validatePath(searchTerm);
   if (inputValidation.isValid) {
     const stats = statSync(normalizePath(searchTerm));
-    if (stats.isDirectory()) {
-      results.unshift({
-        name: searchTerm,
-        value: searchTerm,
-      });
-    }
+    const isDirectory = stats.isDirectory();
+    results.unshift({
+      name: searchTerm,
+      value: searchTerm,
+      description: isDirectory ? "📁 Directory" : "📄 File",
+    });
   }
 }
 
@@ -510,7 +514,7 @@ export function getAvailablePaths(userInput = "") {
       const dirPath = path.dirname(searchTerm);
       const fileName = path.basename(searchTerm);
       results = getDirectoryContents(dirPath, fileName);
-      addExactDirectoryMatch(searchTerm, results);
+      addExactPathMatch(searchTerm, results);
     }
     // Handle relative paths
     else if (searchTerm.startsWith("./") || searchTerm.startsWith("../")) {
@@ -519,7 +523,7 @@ export function getAvailablePaths(userInput = "") {
       if (lastSlashIndex === -1) {
         // No slash found, treat as current directory search
         results = getDirectoryContents("./", searchTerm);
-        addExactDirectoryMatch(searchTerm, results);
+        addExactPathMatch(searchTerm, results);
       } else {
         const dirPath = searchTerm.substring(0, lastSlashIndex + 1);
         const fileName = searchTerm.substring(lastSlashIndex + 1);
@@ -537,13 +541,13 @@ export function getAvailablePaths(userInput = "") {
         }
 
         results = getDirectoryContents(dirPath, fileName);
-        addExactDirectoryMatch(searchTerm, results);
+        addExactPathMatch(searchTerm, results);
       }
     }
     // Handle simple file/directory names (search in current directory)
     else {
       results = getDirectoryContents("./", searchTerm);
-      addExactDirectoryMatch(searchTerm, results);
+      addExactPathMatch(searchTerm, results);
     }
 
     // Remove duplicates based on value (path)
@@ -571,7 +575,7 @@ export function getAvailablePaths(userInput = "") {
  * Get directory contents for a specific path
  * @param {string} dirPath - Directory path to search in
  * @param {string} searchTerm - Optional search term to filter results
- * @returns {Array<Object>} - Array of path objects
+ * @returns {Array<Object>} - Array of path objects (both files and directories)
  */
 function getDirectoryContents(dirPath, searchTerm = "") {
   try {
@@ -623,17 +627,24 @@ function getDirectoryContents(dirPath, searchTerm = "") {
 
       const isDirectory = entry.isDirectory();
 
-      // Only include directories, skip files
-      if (isDirectory) {
-        items.push({
-          name: relativePath,
-          value: relativePath,
-        });
-      }
+      // Include both directories and files
+      items.push({
+        name: relativePath,
+        value: relativePath,
+        description: isDirectory ? "📁 Directory" : "📄 File",
+      });
     }
 
-    // Sort alphabetically (all items are directories now)
-    items.sort((a, b) => a.name.localeCompare(b.name));
+    // Sort alphabetically (directories first, then files)
+    items.sort((a, b) => {
+      const aIsDir = a.description === "📁 Directory";
+      const bIsDir = b.description === "📁 Directory";
+
+      if (aIsDir && !bIsDir) return -1;
+      if (!aIsDir && bIsDir) return 1;
+
+      return a.name.localeCompare(b.name);
+    });
 
     return items;
   } catch (error) {