@aigne/doc-smith 0.2.6 → 0.2.9

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Changelog
 
+## [0.2.9](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.2.8...v0.2.9) (2025-08-13)
+
+
+### Bug Fixes
+
+* polish ignore check ([#25](https://github.com/AIGNE-io/aigne-doc-smith/issues/25)) ([90bc866](https://github.com/AIGNE-io/aigne-doc-smith/commit/90bc866513fef7b47047b1016e07bf38881c101c))
+
+## [0.2.8](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.2.7...v0.2.8) (2025-08-13)
+
+
+### Miscellaneous Chores
+
+* release 0.2.8 ([da19bc0](https://github.com/AIGNE-io/aigne-doc-smith/commit/da19bc0b2c6c4e5fddaff84b4fa85c9d495b3ba0))
+
+## [0.2.7](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.2.6...v0.2.7) (2025-08-12)
+
+
+### Bug Fixes
+
+* polish detail check ([#21](https://github.com/AIGNE-io/aigne-doc-smith/issues/21)) ([0268732](https://github.com/AIGNE-io/aigne-doc-smith/commit/02687329c3507b73f9cbf1aa2ff1b87921452516))
+
+
+### Miscellaneous Chores
+
+* release 0.2.7 ([3b807fe](https://github.com/AIGNE-io/aigne-doc-smith/commit/3b807fed833a5160931747bce37aac00cf11d9ac))
+
 ## [0.2.6](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.2.5...v0.2.6) (2025-08-12)
 
 

package/agents/check-detail-result.mjs

@@ -1,9 +1,6 @@
 import { checkMarkdown } from "../utils/markdown-checker.mjs";
 
-export default async function checkDetailResult({
-  structurePlan,
-  reviewContent,
-}) {
+export default async function checkDetailResult({ structurePlan, reviewContent }) {
   let isApproved = true;
   const detailFeedback = [];
 
@@ -35,9 +32,7 @@ export default async function checkDetailResult({
     }
   } catch (error) {
     isApproved = false;
-    detailFeedback.push(
-      `Found markdown validation error in result: ${error.message}`
-    );
+    detailFeedback.push(`Found markdown validation error in result: ${error.message}`);
   }
 
   return {

package/agents/check-detail.mjs

@@ -2,8 +2,8 @@ import { access, readFile } from "node:fs/promises";
 import { dirname, join } from "node:path";
 import { fileURLToPath } from "node:url";
 import { TeamAgent } from "@aigne/core";
-import checkDetailResult from "./check-detail-result.mjs";
 import { hasSourceFilesChanged } from "../utils/utils.mjs";
+import checkDetailResult from "./check-detail-result.mjs";
 
 // Get current script directory
 const __dirname = dirname(fileURLToPath(import.meta.url));
@@ -20,7 +20,7 @@ export default async function checkDetail(
     forceRegenerate,
     ...rest
   },
-  options
+  options,
 ) {
   // Check if the detail file already exists
   const flatName = path.replace(/^\//, "").replace(/\//g, "-");
@@ -41,11 +41,9 @@ export default async function checkDetail(
   let sourceIdsChanged = false;
   if (originalStructurePlan && sourceIds) {
     // Find the original node in the structure plan
-    const originalNode = originalStructurePlan.find(
-      (node) => node.path === path
-    );
+    const originalNode = originalStructurePlan.find((node) => node.path === path);
 
-    if (originalNode && originalNode.sourceIds) {
+    if (originalNode?.sourceIds) {
       const originalSourceIds = originalNode.sourceIds;
       const currentSourceIds = sourceIds;
 

package/agents/check-structure-plan.mjs

@@ -1,14 +1,14 @@
 import {
   getCurrentGitHead,
+  getProjectInfo,
   hasFileChangesBetweenCommits,
   loadConfigFromFile,
   saveValueToConfig,
-  getProjectInfo,
 } from "../utils/utils.mjs";
 
 export default async function checkStructurePlan(
   { originalStructurePlan, feedback, lastGitHead, ...rest },
-  options
+  options,
 ) {
   // Check if we need to regenerate structure plan
   let shouldRegenerate = false;
@@ -23,10 +23,7 @@ export default async function checkStructurePlan(
       // Check if there are relevant file changes since last generation
       const currentGitHead = getCurrentGitHead();
       if (currentGitHead && currentGitHead !== lastGitHead) {
-        const hasChanges = hasFileChangesBetweenCommits(
-          lastGitHead,
-          currentGitHead
-        );
+        const hasChanges = hasFileChangesBetweenCommits(lastGitHead, currentGitHead);
         if (hasChanges) {
           shouldRegenerate = true;
         }
@@ -71,11 +68,9 @@ export default async function checkStructurePlan(
 
       // Check if user has modified project information
       const userModifiedProjectName =
-        currentConfig?.projectName &&
-        currentConfig.projectName !== projectInfo.name;
+        currentConfig?.projectName && currentConfig.projectName !== projectInfo.name;
       const userModifiedProjectDesc =
-        currentConfig?.projectDesc &&
-        currentConfig.projectDesc !== projectInfo.description;
+        currentConfig?.projectDesc && currentConfig.projectDesc !== projectInfo.description;
 
       // If user hasn't modified project info and it's not from GitHub, save AI output
       if (!userModifiedProjectName && !userModifiedProjectDesc) {

package/agents/find-item-by-path.mjs

@@ -8,15 +8,8 @@ function getActionText(isTranslate, baseText) {
 }
 
 export default async function findItemByPath(
-  {
-    "doc-path": docPath,
-    structurePlanResult,
-    boardId,
-    docsDir,
-    isTranslate,
-    feedback,
-  },
-  options
+  { "doc-path": docPath, structurePlanResult, boardId, docsDir, isTranslate, feedback },
+  options,
 ) {
   let foundItem = null;
   let selectedFileContent = null;
@@ -30,9 +23,7 @@ export default async function findItemByPath(
       // Filter for main language .md files (exclude _sidebar.md and language-specific files)
       const mainLanguageFiles = files.filter(
         (file) =>
-          file.endsWith(".md") &&
-          file !== "_sidebar.md" &&
-          !file.match(/\.\w+(-\w+)?\.md$/) // Exclude language-specific files like .en.md, .zh-CN.md, etc.
+          file.endsWith(".md") && file !== "_sidebar.md" && !file.match(/\.\w+(-\w+)?\.md$/), // Exclude language-specific files like .en.md, .zh-CN.md, etc.
       );
 
       if (mainLanguageFiles.length === 0) {
@@ -42,7 +33,7 @@ export default async function findItemByPath(
       // Let user select a file
       const selectedFile = await options.prompts.search({
         message: getActionText(isTranslate, "Select a document to {action}:"),
-        source: async (input, { signal }) => {
+        source: async (input) => {
           if (!input || input.trim() === "") {
             return mainLanguageFiles.map((file) => ({
               name: file,
@@ -52,7 +43,7 @@ export default async function findItemByPath(
 
           const searchTerm = input.trim().toLowerCase();
           const filteredFiles = mainLanguageFiles.filter((file) =>
-            file.toLowerCase().includes(searchTerm)
+            file.toLowerCase().includes(searchTerm),
           );
 
           return filteredFiles.map((file) => ({
@@ -71,10 +62,7 @@ export default async function findItemByPath(
         const selectedFilePath = join(docsDir, selectedFile);
         selectedFileContent = await readFile(selectedFilePath, "utf-8");
       } catch (readError) {
-        console.warn(
-          `⚠️  Could not read content from ${selectedFile}:`,
-          readError.message
-        );
+        console.warn(`⚠️  Could not read content from ${selectedFile}:`, readError.message);
         selectedFileContent = null;
       }
 
@@ -87,9 +75,7 @@ export default async function findItemByPath(
 
       // First try without boardId prefix
       foundItemByFile = structurePlanResult.find((item) => {
-        const itemFlattenedPath = item.path
-          .replace(/^\//, "")
-          .replace(/\//g, "-");
+        const itemFlattenedPath = item.path.replace(/^\//, "").replace(/\//g, "-");
         return itemFlattenedPath === flatName;
       });
       if (!foundItemByFile) {
@@ -102,8 +88,8 @@ export default async function findItemByPath(
       throw new Error(
         getActionText(
           isTranslate,
-          "Please provide a doc-path parameter to specify which document to {action}"
-        )
+          "Please provide a doc-path parameter to specify which document to {action}",
+        ),
       );
     }
   }
@@ -121,18 +107,14 @@ export default async function findItemByPath(
       // Find item by comparing flattened paths
       foundItem = structurePlanResult.find((item) => {
         // Convert item.path to flattened format (replace / with -)
-        const itemFlattenedPath = item.path
-          .replace(/^\//, "")
-          .replace(/\//g, "-");
+        const itemFlattenedPath = item.path.replace(/^\//, "").replace(/\//g, "-");
         return itemFlattenedPath === flattenedPath;
       });
     }
   }
 
   if (!foundItem) {
-    throw new Error(
-      `Item with path "${docPath}" not found in structurePlanResult`
-    );
+    throw new Error(`Item with path "${docPath}" not found in structurePlanResult`);
   }
 
   // Prompt for feedback if not provided
@@ -140,7 +122,7 @@ export default async function findItemByPath(
   if (!userFeedback) {
     const feedbackMessage = getActionText(
       isTranslate,
-      "Please provide feedback for the {action} (press Enter to skip):"
+      "Please provide feedback for the {action} (press Enter to skip):",
     );
 
     userFeedback = await options.prompts.input({
@@ -159,7 +141,7 @@ export default async function findItemByPath(
   }
 
   // Add feedback to result if provided
-  if (userFeedback && userFeedback.trim()) {
+  if (userFeedback?.trim()) {
     result.feedback = userFeedback.trim();
   }
 

package/agents/input-generator.mjs

@@ -1,18 +1,11 @@
-import { writeFile, mkdir, readFile } from "node:fs/promises";
-import { join, dirname } from "node:path";
+import { mkdir, readFile, writeFile } from "node:fs/promises";
+import { dirname, join } from "node:path";
 import chalk from "chalk";
-import {
-  validatePath,
-  getAvailablePaths,
-  getProjectInfo,
-} from "../utils/utils.mjs";
-import {
-  SUPPORTED_LANGUAGES,
-  DOCUMENT_STYLES,
-  TARGET_AUDIENCES,
-} from "../utils/constants.mjs";
+import { DOCUMENT_STYLES, SUPPORTED_LANGUAGES, TARGET_AUDIENCES } from "../utils/constants.mjs";
+import { getAvailablePaths, getProjectInfo, validatePath } from "../utils/utils.mjs";
+
 // UI constants
-const PRESS_ENTER_TO_FINISH = "Press Enter to finish";
+const _PRESS_ENTER_TO_FINISH = "Press Enter to finish";
 
 /**
  * Guide users through multi-turn dialogue to collect information and generate YAML configuration
@@ -22,12 +15,8 @@ const PRESS_ENTER_TO_FINISH = "Press Enter to finish";
  * @returns {Promise<Object>}
  */
 export default async function init(
-  {
-    outputPath = ".aigne/doc-smith",
-    fileName = "config.yaml",
-    skipIfExists = false,
-  },
-  options
+  { outputPath = ".aigne/doc-smith", fileName = "config.yaml", skipIfExists = false },
+  options,
 ) {
   if (skipIfExists) {
     const filePath = join(outputPath, fileName);
@@ -103,7 +92,7 @@ export default async function init(
   // 4. Translation languages
   // Filter out the primary language from available choices
   const availableTranslationLanguages = SUPPORTED_LANGUAGES.filter(
-    (lang) => lang.code !== primaryLanguageChoice
+    (lang) => lang.code !== primaryLanguageChoice,
   );
 
   const translateLanguageChoices = await options.prompts.checkbox({
@@ -132,7 +121,7 @@ export default async function init(
   while (true) {
     const selectedPath = await options.prompts.search({
       message: "Path:",
-      source: async (input, { signal }) => {
+      source: async (input) => {
         if (!input || input.trim() === "") {
           return [
             {
@@ -153,11 +142,7 @@ export default async function init(
     });
 
     // Check if user chose to exit
-    if (
-      !selectedPath ||
-      selectedPath.trim() === "" ||
-      selectedPath === "Press Enter to finish"
-    ) {
+    if (!selectedPath || selectedPath.trim() === "" || selectedPath === "Press Enter to finish") {
       break;
     }
 
@@ -206,13 +191,9 @@ export default async function init(
     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.\n");
     console.log(
-      "💡 You can edit the configuration file anytime to modify settings.\n"
-    );
-    console.log(
-      `🚀 Run ${chalk.cyan(
-        "'aigne doc generate'"
-      )} to start documentation generation!\n`
+      `🚀 Run ${chalk.cyan("'aigne doc generate'")} to start documentation generation!\n`,
     );
 
     return {};
@@ -242,7 +223,7 @@ function generateYAML(input) {
 
   // Add rules (required field)
   yaml += `rules: |\n`;
-  if (input.rules && input.rules.trim()) {
+  if (input.rules?.trim()) {
     yaml += `  ${input.rules.split("\n").join("\n  ")}\n\n`;
   } else {
     yaml += `  \n\n`;
@@ -283,5 +264,4 @@ function generateYAML(input) {
   return yaml;
 }
 
-init.description =
-  "Generate a configuration file for the documentation generation process";
+init.description = "Generate a configuration file for the documentation generation process";

package/agents/language-selector.mjs

@@ -8,10 +8,7 @@ import { SUPPORTED_LANGUAGES } from "../utils/constants.mjs";
  * @param {Object} options - Options object with prompts
  * @returns {Promise<Object>} Selected languages
  */
-export default async function languageSelector(
-  { languages, translateLanguages },
-  options
-) {
+export default async function languageSelector({ languages, translateLanguages }, options) {
   let selectedLanguages = [];
 
   // Check if translateLanguages is available from config
@@ -21,24 +18,19 @@ export default async function languageSelector(
     translateLanguages.length === 0
   ) {
     throw new Error(
-      "No translation languages configured in config.yaml. Please add translateLanguages to your configuration."
+      "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)
-    );
+    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(", ")
-      );
+      console.log("Available configured languages:", translateLanguages.join(", "));
     }
   }
 
@@ -46,13 +38,9 @@ export default async function languageSelector(
   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
-      );
+      const supportedLang = SUPPORTED_LANGUAGES.find((l) => l.code === langCode);
       return {
-        name: supportedLang
-          ? `${supportedLang.label} (${supportedLang.sample})`
-          : langCode,
+        name: supportedLang ? `${supportedLang.label} (${supportedLang.sample})` : langCode,
         value: langCode,
         short: langCode,
       };

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,99 +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";
-
-/**
- * Load .gitignore patterns from a directory
- * @param {string} dir - Directory path
- * @returns {object|null} Ignore instance or null if no .gitignore found
- */
-async function loadGitignore(dir) {
-  const gitignorePath = path.join(dir, ".gitignore");
-  try {
-    await access(gitignorePath);
-    const gitignoreContent = await readFile(gitignorePath, "utf8");
-    // Create ignore patterns from .gitignore content
-    const ignorePatterns = gitignoreContent
-      .split("\n")
-      .map((line) => line.trim())
-      .filter((line) => line && !line.startsWith("#"))
-      .map((line) => line.replace(/^\//, "")); // Remove leading slash
-
-    return ignorePatterns.length > 0 ? ignorePatterns : null;
-  } catch {
-    // .gitignore file doesn't exist
-    return null;
-  }
-}
-
-/**
- * Get files using glob patterns
- * @param {string} dir - Directory to search
- * @param {string[]} includePatterns - Include patterns
- * @param {string[]} excludePatterns - Exclude patterns
- * @param {string[]} gitignorePatterns - .gitignore patterns
- * @returns {Promise<string[]>} Array of file paths
- */
-async function getFilesWithGlob(
-  dir,
-  includePatterns,
-  excludePatterns,
-  gitignorePatterns
-) {
-  // Prepare all ignore patterns
-  const allIgnorePatterns = [];
-
-  if (excludePatterns) {
-    allIgnorePatterns.push(...excludePatterns);
-  }
-
-  if (gitignorePatterns) {
-    allIgnorePatterns.push(...gitignorePatterns);
-  }
-
-  // Add default exclusions if not already present
-  const defaultExclusions = ["node_modules/**", "test/**", "temp/**"];
-  for (const exclusion of defaultExclusions) {
-    if (!allIgnorePatterns.includes(exclusion)) {
-      allIgnorePatterns.push(exclusion);
-    }
-  }
-
-  // Convert patterns to be relative to the directory
-  const patterns = includePatterns.map((pattern) => {
-    // If pattern doesn't start with / or **, make it relative to dir
-    if (!pattern.startsWith("/") && !pattern.startsWith("**")) {
-      return `**/${pattern}`; // Use ** to search recursively
-    }
-    return pattern;
-  });
-
-  try {
-    const files = await glob(patterns, {
-      cwd: dir,
-      ignore: allIgnorePatterns.length > 0 ? allIgnorePatterns : undefined,
-      absolute: true,
-      nodir: true, // Only return files, not directories
-      dot: false, // Don't include dot files by default
-      gitignore: true, // Enable .gitignore support
-    });
-
-    return files;
-  } catch (error) {
-    console.warn(
-      `Warning: Error during glob search in ${dir}: ${error.message}`
-    );
-    return [];
-  }
-}
+import { DEFAULT_EXCLUDE_PATTERNS, DEFAULT_INCLUDE_PATTERNS } from "../utils/constants.mjs";
+import { getFilesWithGlob, loadGitignore } from "../utils/file-utils.mjs";
+import { getCurrentGitHead, getModifiedFilesBetweenCommits } from "../utils/utils.mjs";
 
 export default async function loadSources({
   sources = [],
@@ -143,14 +52,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 +73,7 @@ export default async function loadSources({
             dir,
             finalIncludePatterns,
             finalExcludePatterns,
-            gitignorePatterns
+            gitignorePatterns,
           );
           allFiles = allFiles.concat(filesInDir);
         }
@@ -194,7 +97,7 @@ export default async function loadSources({
         sourceId: relativePath,
         content,
       };
-    })
+    }),
   );
 
   // Get the last structure plan result
@@ -253,19 +156,29 @@ 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);
     }
   }
 
+  // Count words and lines in allSources
+  let totalWords = 0;
+  let totalLines = 0;
+
+  for (const source of Object.values(allSources)) {
+    if (typeof source === "string") {
+      // Count English words (simple regex for words containing a-zA-Z)
+      const words = source.match(/[a-zA-Z]+/g) || [];
+      totalWords += words.length;
+
+      // Count lines
+      totalLines += source.split("\n").length;
+    }
+  }
+
   return {
     datasourcesList: sourceFiles,
     datasources: allSources,
@@ -273,6 +186,8 @@ export default async function loadSources({
     originalStructurePlan,
     files,
     modifiedFiles,
+    totalWords,
+    totalLines,
   };
 }
 
@@ -290,18 +205,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",