@aigne/doc-smith 0.1.4 → 0.2.1

package/agents/input-generator.mjs

@@ -1,5 +1,15 @@
-import { writeFile, mkdir } from "node:fs/promises";
+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 {
+  SUPPORTED_LANGUAGES,
+  DOCUMENT_STYLES,
+  TARGET_AUDIENCES,
+} from "../utils/constants.mjs";
+
+// UI constants
+const PRESS_ENTER_TO_FINISH = "Press Enter to finish";
 
 /**
  * Guide users through multi-turn dialogue to collect information and generate YAML configuration
@@ -9,48 +19,175 @@ import { join, dirname } from "node:path";
  * @returns {Promise<Object>}
  */
 export default async function init(
-  { outputPath = "./doc-smith", fileName = "config.yaml" },
+  {
+    outputPath = "./doc-smith",
+    fileName = "config.yaml",
+    skipIfExists = false,
+  },
   options
 ) {
-  console.log("Welcome to AIGNE Doc Smith!");
-  console.log(
-    "I will help you generate a configuration file through several questions.\n"
-  );
+  if (skipIfExists) {
+    const filePath = join(outputPath, fileName);
+    if (await readFile(filePath, "utf8").catch(() => null)) {
+      return {};
+    }
+  }
+
+  console.log("🚀 Welcome to AIGNE DocSmith!");
+  console.log("Let's create your documentation configuration.\n");
 
   // Collect user information
   const input = {};
 
-  // 1. Document generation rules
-  console.log("=== Document Generation Rules ===");
-  const rulesInput = await options.prompts.input({
-    message: "Please describe the document generation rules and requirements:",
+  // 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:",
+    choices: Object.entries(DOCUMENT_STYLES).map(([key, style]) => ({
+      name: `${style.name} - ${style.rules}`,
+      value: key,
+    })),
   });
-  input.rules = rulesInput.trim();
 
-  // 2. Target audience
-  console.log("\n=== Target Audience ===");
-  const targetAudienceInput = await options.prompts.input({
-    message:
-      "What is the target audience? (e.g., developers, users, press Enter for default 'developers'):",
+  let rules;
+  if (styleChoice === "custom") {
+    // User wants to input custom rules
+    rules = await options.prompts.input({
+      message: "Enter your custom documentation rules:",
+    });
+  } else {
+    // Use predefined style directly
+    rules = DOCUMENT_STYLES[styleChoice].rules;
+  }
+
+  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?",
+    choices: Object.entries(TARGET_AUDIENCES).map(([key, audience]) => ({
+      name: audience,
+      value: key,
+    })),
   });
-  input.targetAudience = targetAudienceInput.trim() || "developers";
+
+  let targetAudience;
+  if (audienceChoice === "custom") {
+    // User wants to input custom audience
+    targetAudience = await options.prompts.input({
+      message: "Enter your custom target audience:",
+    });
+  } else {
+    // Use predefined audience directly
+    targetAudience = TARGET_AUDIENCES[audienceChoice];
+  }
+
+  input.targetAudience = targetAudience.trim();
 
   // 3. Language settings
-  console.log("\n=== Language Settings ===");
-  const localeInput = await options.prompts.input({
-    message: "Primary language (e.g., en, zh, press Enter for default 'en'):",
+  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:",
+    choices: SUPPORTED_LANGUAGES.map((lang) => ({
+      name: `${lang.label} - ${lang.sample}`,
+      value: lang.code,
+    })),
   });
-  input.locale = localeInput.trim() || "en";
+
+  input.locale = primaryLanguageChoice;
 
   // 4. Translation languages
-  console.log("\n=== Translation Settings ===");
-  const translateInput = await options.prompts.input({
-    message:
-      "Translation language list (comma-separated, e.g., zh,en, press Enter to skip):",
+  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:",
+    choices: availableTranslationLanguages.map((lang) => ({
+      name: `${lang.label} - ${lang.sample}`,
+      value: lang.code,
+    })),
+  });
+
+  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:`,
+    default: `${outputPath}/docs`,
   });
-  input.translateLanguages = translateInput.trim()
-    ? translateInput.split(",").map((lang) => lang.trim())
-    : [];
+  input.docsDir = docsDirInput.trim() || `${outputPath}/docs`;
+
+  // 6. Source code paths
+  console.log("\n🔍 Step 6/6: Source Code Paths");
+  console.log("Enter paths to analyze for documentation (e.g., ./src, ./lib)");
+  console.log("💡 If no paths are configured, './' will be used as default");
+
+  const sourcePaths = [];
+  while (true) {
+    const selectedPath = await options.prompts.search({
+      message: "Path:",
+      source: async (input, { signal }) => {
+        if (!input || input.trim() === "") {
+          return [
+            {
+              name: "Press Enter to finish",
+              value: "",
+              description: "",
+            },
+          ];
+        }
+
+        const searchTerm = input.trim();
+
+        // Search for matching files and folders in current directory
+        const availablePaths = getAvailablePaths(searchTerm);
+
+        return [...availablePaths];
+      },
+    });
+
+    // Check if user chose to exit
+    if (
+      !selectedPath ||
+      selectedPath.trim() === "" ||
+      selectedPath === "Press Enter to finish"
+    ) {
+      break;
+    }
+
+    const trimmedPath = selectedPath.trim();
+
+    // Use validatePath to check if path is valid
+    const validation = validatePath(trimmedPath);
+
+    if (!validation.isValid) {
+      console.log(`⚠️ ${validation.error}`);
+      continue;
+    }
+
+    // Avoid duplicate paths
+    if (sourcePaths.includes(trimmedPath)) {
+      console.log(`⚠️ Path already exists: ${trimmedPath}`);
+      continue;
+    }
+
+    sourcePaths.push(trimmedPath);
+  }
+
+  // If no paths entered, use default
+  input.sourcesPath = sourcePaths.length > 0 ? sourcePaths : ["./"];
 
   // Generate YAML content
   const yamlContent = generateYAML(input, outputPath);
@@ -64,13 +201,17 @@ export default async function init(
     await mkdir(dirPath, { recursive: true });
 
     await writeFile(filePath, yamlContent, "utf8");
-    console.log(`\n✅ Configuration file saved to: ${filePath}`);
+    console.log(`\n🎉 Configuration saved to: ${chalk.cyan(filePath)}`);
+    console.log(
+      "💡 You can edit the configuration file anytime to modify settings."
+    );
+    console.log(
+      `🚀 Run ${chalk.cyan(
+        "'aigne doc generate'"
+      )} to start documentation generation!`
+    );
 
-    return {
-      inputGeneratorStatus: true,
-      inputGeneratorPath: filePath,
-      inputGeneratorContent: yamlContent,
-    };
+    return {};
   } catch (error) {
     console.error(`❌ Failed to save configuration file: ${error.message}`);
     return {
@@ -121,11 +262,13 @@ function generateYAML(input, outputPath) {
     yaml += `#   - en  # Example: English translation\n`;
   }
 
-  // Add default directory and source path configurations
-  yaml += `docsDir: ${outputPath}/docs  # Directory to save generated documentation\n`;
-  yaml += `outputDir: ${outputPath}/output  # Directory to save output files\n`;
+  // Add directory and source path configurations
+  yaml += `docsDir: ${input.docsDir}  # Directory to save generated documentation\n`;
+  // yaml += `outputDir: ${outputPath}/output  # Directory to save output files\n`;
   yaml += `sourcesPath:  # Source code paths to analyze\n`;
-  yaml += `  - ./  # Current directory\n`;
+  input.sourcesPath.forEach((path) => {
+    yaml += `  - ${path}\n`;
+  });
 
   return yaml;
 }

package/agents/load-config.mjs

@@ -24,6 +24,7 @@ export default async function loadConfig({ config }) {
       sourcesPath: ["./"],
       docDir: "./doc-smith/docs",
       outputDir: "./doc-smith/output",
+      lastGitHead: parsedConfig.lastGitHead || "",
       ...parsedConfig,
     };
   } catch (error) {

package/agents/load-sources.mjs

@@ -1,67 +1,14 @@
 import { access, readFile } from "node:fs/promises";
 import path from "node:path";
 import { glob } from "glob";
-
-// Default file patterns for inclusion and exclusion
-const DEFAULT_INCLUDE_PATTERNS = [
-  "*.py",
-  "*.js",
-  "*.jsx",
-  "*.ts",
-  "*.tsx",
-  "*.go",
-  "*.java",
-  "*.pyi",
-  "*.pyx",
-  "*.c",
-  "*.cc",
-  "*.cpp",
-  "*.h",
-  "*.md",
-  "*.rst",
-  "*.json",
-  "*Dockerfile",
-  "*Makefile",
-  "*.yaml",
-  "*.yml",
-];
-
-const DEFAULT_EXCLUDE_PATTERNS = [
-  "aigne-docs/**",
-  "doc-smith/**",
-  "assets/**",
-  "data/**",
-  "images/**",
-  "public/**",
-  "static/**",
-  "**/vendor/**",
-  "temp/**",
-  "**/*docs/**",
-  "**/*doc/**",
-  "**/*venv/**",
-  "*.venv/**",
-  "*test*",
-  "**/*test/**",
-  "**/*tests/**",
-  "**/*examples/**",
-  "**/playgrounds/**",
-  "v1/**",
-  "**/dist/**",
-  "**/*build/**",
-  "**/*experimental/**",
-  "**/*deprecated/**",
-  "**/*misc/**",
-  "**/*legacy/**",
-  ".git/**",
-  ".github/**",
-  ".next/**",
-  ".vscode/**",
-  "**/*obj/**",
-  "**/*bin/**",
-  "**/*node_modules/**",
-  "*.log",
-  "**/*test.*",
-];
+import {
+  getCurrentGitHead,
+  getModifiedFilesBetweenCommits,
+} from "../utils/utils.mjs";
+import {
+  DEFAULT_INCLUDE_PATTERNS,
+  DEFAULT_EXCLUDE_PATTERNS,
+} from "../utils/constants.mjs";
 
 /**
  * Load .gitignore patterns from a directory
@@ -158,6 +105,7 @@ export default async function loadSources({
   "doc-path": docPath,
   boardId,
   useDefaultPatterns = true,
+  lastGitHead,
 } = {}) {
   let files = Array.isArray(sources) ? [...sources] : [];
 
@@ -224,9 +172,11 @@ export default async function loadSources({
   const sourceFiles = await Promise.all(
     files.map(async (file) => {
       const content = await readFile(file, "utf8");
-      allSources += `// sourceId: ${file}\n${content}\n`;
+      // Convert absolute path to relative path from project root
+      const relativePath = path.relative(process.cwd(), file);
+      allSources += `// sourceId: ${relativePath}\n${content}\n`;
       return {
-        sourceId: file,
+        sourceId: relativePath,
         content,
       };
     })
@@ -280,12 +230,34 @@ export default async function loadSources({
     }
   }
 
+  // Get git change detection data
+  let modifiedFiles = [];
+  let currentGitHead = null;
+
+  if (lastGitHead) {
+    try {
+      currentGitHead = getCurrentGitHead();
+      if (currentGitHead && currentGitHead !== lastGitHead) {
+        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);
+    }
+  }
+
   return {
     datasourcesList: sourceFiles,
     datasources: allSources,
     content,
     originalStructurePlan,
     files,
+    modifiedFiles,
   };
 }
 
@@ -324,6 +296,10 @@ loadSources.input_schema = {
       type: "string",
       description: "The board ID for boardId-flattenedPath format matching",
     },
+    lastGitHead: {
+      type: "string",
+      description: "The git HEAD from last generation for change detection",
+    },
   },
   required: [],
 };
@@ -349,5 +325,10 @@ loadSources.output_schema = {
       items: { type: "string" },
       description: "Array of file paths that were loaded",
     },
+    modifiedFiles: {
+      type: "array",
+      items: { type: "string" },
+      description: "Array of modified files since last generation",
+    },
   },
 };