@aigne/doc-smith 0.2.5 → 0.2.8

package/utils/utils.mjs

@@ -1,20 +1,10 @@
+import { execSync } from "node:child_process";
+import { accessSync, constants, existsSync, mkdirSync, readdirSync, statSync } from "node:fs";
 import fs from "node:fs/promises";
 import path from "node:path";
-import { execSync } from "node:child_process";
-import {
-  existsSync,
-  mkdirSync,
-  readdirSync,
-  accessSync,
-  constants,
-  statSync,
-} from "node:fs";
-import { parse } from "yaml";
 import chalk from "chalk";
-import {
-  DEFAULT_INCLUDE_PATTERNS,
-  DEFAULT_EXCLUDE_PATTERNS,
-} from "./constants.mjs";
+import { parse } from "yaml";
+import { DEFAULT_EXCLUDE_PATTERNS, DEFAULT_INCLUDE_PATTERNS } from "./constants.mjs";
 
 /**
  * Normalize path to absolute path for consistent comparison
@@ -22,9 +12,7 @@ import {
  * @returns {string} - Absolute path
  */
 export function normalizePath(filePath) {
-  return path.isAbsolute(filePath)
-    ? filePath
-    : path.resolve(process.cwd(), filePath);
+  return path.isAbsolute(filePath) ? filePath : path.resolve(process.cwd(), filePath);
 }
 
 /**
@@ -33,36 +21,31 @@ export function normalizePath(filePath) {
  * @returns {string} - Relative path
  */
 export function toRelativePath(filePath) {
-  return path.isAbsolute(filePath)
-    ? path.relative(process.cwd(), filePath)
-    : filePath;
+  return path.isAbsolute(filePath) ? path.relative(process.cwd(), filePath) : filePath;
 }
 
 export function processContent({ content }) {
   // Match markdown regular links [text](link), exclude images ![text](link)
-  return content.replace(
-    /(?<!!)\[([^\]]+)\]\(([^)]+)\)/g,
-    (match, text, link) => {
-      const trimLink = link.trim();
-      // Exclude external links and mailto
-      if (/^(https?:\/\/|mailto:)/.test(trimLink)) return match;
-      // Preserve anchors
-      const [path, hash] = trimLink.split("#");
-      // Skip if already has extension
-      if (/\.[a-zA-Z0-9]+$/.test(path)) return match;
-      // Only process relative paths or paths starting with /
-      if (!path) return match;
-      // Flatten to ./xxx-yyy.md
-      let finalPath = path;
-      if (path.startsWith(".")) {
-        finalPath = path.replace(/^\./, "");
-      }
-      let flatPath = finalPath.replace(/^\//, "").replace(/\//g, "-");
-      flatPath = `./${flatPath}.md`;
-      const newLink = hash ? `${flatPath}#${hash}` : flatPath;
-      return `[${text}](${newLink})`;
+  return content.replace(/(?<!!)\[([^\]]+)\]\(([^)]+)\)/g, (match, text, link) => {
+    const trimLink = link.trim();
+    // Exclude external links and mailto
+    if (/^(https?:\/\/|mailto:)/.test(trimLink)) return match;
+    // Preserve anchors
+    const [path, hash] = trimLink.split("#");
+    // Skip if already has extension
+    if (/\.[a-zA-Z0-9]+$/.test(path)) return match;
+    // Only process relative paths or paths starting with /
+    if (!path) return match;
+    // Flatten to ./xxx-yyy.md
+    let finalPath = path;
+    if (path.startsWith(".")) {
+      finalPath = path.replace(/^\./, "");
     }
-  );
+    let flatPath = finalPath.replace(/^\//, "").replace(/\//g, "-");
+    flatPath = `./${flatPath}.md`;
+    const newLink = hash ? `${flatPath}#${hash}` : flatPath;
+    return `[${text}](${newLink})`;
+  });
 }
 
 /**
@@ -83,6 +66,7 @@ export async function saveDocWithTranslations({
   locale,
   translates = [],
   labels,
+  isTranslate = false,
 }) {
   const results = [];
   try {
@@ -96,20 +80,22 @@ export async function saveDocWithTranslations({
       return isEnglish ? `${flatName}.md` : `${flatName}.${language}.md`;
     };
 
-    // Save main content with appropriate filename based on locale
-    const mainFileName = getFileName(locale);
-    const mainFilePath = path.join(docsDir, mainFileName);
+    // Save main content with appropriate filename based on locale (skip if isTranslate is true)
+    if (!isTranslate) {
+      const mainFileName = getFileName(locale);
+      const mainFilePath = path.join(docsDir, mainFileName);
 
-    // Add labels front matter if labels are provided
-    let finalContent = processContent({ content });
-    if (labels && labels.length > 0) {
-      const frontMatter = `---\nlabels: ${JSON.stringify(labels)}\n---\n\n`;
-      finalContent = frontMatter + finalContent;
-    }
+      // Add labels front matter if labels are provided
+      let finalContent = processContent({ content });
+      if (labels && labels.length > 0) {
+        const frontMatter = `---\nlabels: ${JSON.stringify(labels)}\n---\n\n`;
+        finalContent = frontMatter + finalContent;
+      }
 
-    await fs.writeFile(mainFilePath, finalContent, "utf8");
-    results.push({ path: mainFilePath, success: true });
-    console.log(chalk.green(`Saved: ${chalk.cyan(mainFilePath)}`));
+      await fs.writeFile(mainFilePath, finalContent, "utf8");
+      results.push({ path: mainFilePath, success: true });
+      console.log(chalk.green(`Saved: ${chalk.cyan(mainFilePath)}`));
+    }
 
     // Process all translations
     for (const translate of translates) {
@@ -187,7 +173,7 @@ export async function saveGitHeadToConfig(gitHead) {
       if (fileContent && !fileContent.endsWith("\n")) {
         fileContent += "\n";
       }
-      fileContent += newLastGitHeadLine + "\n";
+      fileContent += `${newLastGitHeadLine}\n`;
     }
 
     await fs.writeFile(inputFilePath, fileContent);
@@ -203,20 +189,13 @@ export async function saveGitHeadToConfig(gitHead) {
  * @param {Array<string>} filePaths - Array of file paths to check
  * @returns {Array<string>} - Array of modified file paths
  */
-export function getModifiedFilesBetweenCommits(
-  fromCommit,
-  toCommit = "HEAD",
-  filePaths = []
-) {
+export function getModifiedFilesBetweenCommits(fromCommit, toCommit = "HEAD", filePaths = []) {
   try {
     // Get all modified files between commits
-    const modifiedFiles = execSync(
-      `git diff --name-only ${fromCommit}..${toCommit}`,
-      {
-        encoding: "utf8",
-        stdio: ["pipe", "pipe", "ignore"],
-      }
-    )
+    const modifiedFiles = execSync(`git diff --name-only ${fromCommit}..${toCommit}`, {
+      encoding: "utf8",
+      stdio: ["pipe", "pipe", "ignore"],
+    })
       .trim()
       .split("\n")
       .filter(Boolean);
@@ -231,12 +210,12 @@ export function getModifiedFilesBetweenCommits(
         const absoluteFile = normalizePath(file);
         const absoluteTarget = normalizePath(targetPath);
         return absoluteFile === absoluteTarget;
-      })
+      }),
     );
   } catch (error) {
     console.warn(
       `Failed to get modified files between ${fromCommit} and ${toCommit}:`,
-      error.message
+      error.message,
     );
     return [];
   }
@@ -258,7 +237,7 @@ export function hasSourceFilesChanged(sourceIds, modifiedFiles) {
       const absoluteModifiedFile = normalizePath(modifiedFile);
       const absoluteSourceId = normalizePath(sourceId);
       return absoluteModifiedFile === absoluteSourceId;
-    })
+    }),
   );
 }
 
@@ -274,17 +253,14 @@ export function hasFileChangesBetweenCommits(
   fromCommit,
   toCommit = "HEAD",
   includePatterns = DEFAULT_INCLUDE_PATTERNS,
-  excludePatterns = DEFAULT_EXCLUDE_PATTERNS
+  excludePatterns = DEFAULT_EXCLUDE_PATTERNS,
 ) {
   try {
     // Get file changes with status (A=added, D=deleted, M=modified)
-    const changes = execSync(
-      `git diff --name-status ${fromCommit}..${toCommit}`,
-      {
-        encoding: "utf8",
-        stdio: ["pipe", "pipe", "ignore"],
-      }
-    )
+    const changes = execSync(`git diff --name-status ${fromCommit}..${toCommit}`, {
+      encoding: "utf8",
+      stdio: ["pipe", "pipe", "ignore"],
+    })
       .trim()
       .split("\n")
       .filter(Boolean);
@@ -306,10 +282,7 @@ export function hasFileChangesBetweenCommits(
       // Check if file matches any include pattern
       const matchesInclude = includePatterns.some((pattern) => {
         // Convert glob pattern to regex for matching
-        const regexPattern = pattern
-          .replace(/\./g, "\\.")
-          .replace(/\*/g, ".*")
-          .replace(/\?/g, ".");
+        const regexPattern = pattern.replace(/\./g, "\\.").replace(/\*/g, ".*").replace(/\?/g, ".");
         const regex = new RegExp(regexPattern);
         return regex.test(filePath);
       });
@@ -321,10 +294,7 @@ export function hasFileChangesBetweenCommits(
       // Check if file matches any exclude pattern
       const matchesExclude = excludePatterns.some((pattern) => {
         // Convert glob pattern to regex for matching
-        const regexPattern = pattern
-          .replace(/\./g, "\\.")
-          .replace(/\*/g, ".*")
-          .replace(/\?/g, ".");
+        const regexPattern = pattern.replace(/\./g, "\\.").replace(/\*/g, ".*").replace(/\?/g, ".");
         const regex = new RegExp(regexPattern);
         return regex.test(filePath);
       });
@@ -334,7 +304,7 @@ export function hasFileChangesBetweenCommits(
   } catch (error) {
     console.warn(
       `Failed to check file changes between ${fromCommit} and ${toCommit}:`,
-      error.message
+      error.message,
     );
     return false;
   }
@@ -345,11 +315,7 @@ 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(),
-    "./.aigne/doc-smith",
-    "config.yaml"
-  );
+  const configPath = path.join(process.cwd(), "./.aigne/doc-smith", "config.yaml");
 
   try {
     if (!existsSync(configPath)) {
@@ -368,10 +334,11 @@ export async function loadConfigFromFile() {
  * Save value to config.yaml file
  * @param {string} key - The config key to save
  * @param {string} value - The value to save
+ * @param {string} [comment] - Optional comment to add above the key
  */
-export async function saveValueToConfig(key, value) {
-  if (!value) {
-    return; // Skip if no value provided
+export async function saveValueToConfig(key, value, comment) {
+  if (value === undefined) {
+    return; // Skip if value is undefined
   }
 
   try {
@@ -389,18 +356,35 @@ export async function saveValueToConfig(key, value) {
     }
 
     // Check if key already exists in the file
-    const keyRegex = new RegExp(`^${key}:\\s*.*$`, "m");
-    const newKeyLine = `${key}: ${value}`;
+    const lines = fileContent.split("\n");
+    const keyRegex = new RegExp(`^${key}:\\s*.*$`);
+    const newKeyLine = `${key}: "${value}"`;
 
-    if (keyRegex.test(fileContent)) {
+    const keyIndex = lines.findIndex((line) => keyRegex.test(line));
+
+    if (keyIndex !== -1) {
       // Replace existing key line
-      fileContent = fileContent.replace(keyRegex, newKeyLine);
+      lines[keyIndex] = newKeyLine;
+      fileContent = lines.join("\n");
+
+      // Add comment if provided and not already present
+      if (comment && keyIndex > 0 && !lines[keyIndex - 1].trim().startsWith("# ")) {
+        // Add comment above the key if it doesn't already have one
+        lines.splice(keyIndex, 0, `# ${comment}`);
+        fileContent = lines.join("\n");
+      }
     } else {
       // Add key to the end of file
       if (fileContent && !fileContent.endsWith("\n")) {
         fileContent += "\n";
       }
-      fileContent += newKeyLine + "\n";
+
+      // Add comment if provided
+      if (comment) {
+        fileContent += `# ${comment}\n`;
+      }
+
+      fileContent += `${newKeyLine}\n`;
     }
 
     await fs.writeFile(configPath, fileContent);
@@ -429,7 +413,7 @@ export function validatePath(filePath) {
     // Check if path is accessible (readable)
     try {
       accessSync(absolutePath, constants.R_OK);
-    } catch (accessError) {
+    } catch (_accessError) {
       return {
         isValid: false,
         error: `Path is not accessible: ${filePath}`,
@@ -440,7 +424,7 @@ export function validatePath(filePath) {
       isValid: true,
       error: null,
     };
-  } catch (error) {
+  } catch (_error) {
     return {
       isValid: false,
       error: `Invalid path format: ${filePath}`,
@@ -563,10 +547,7 @@ export function getAvailablePaths(userInput = "") {
 
     return uniqueResults;
   } catch (error) {
-    console.warn(
-      `Failed to get available paths for "${userInput}":`,
-      error.message
-    );
+    console.warn(`Failed to get available paths for "${userInput}":`, error.message);
     return [];
   }
 }
@@ -607,10 +588,7 @@ function getDirectoryContents(dirPath, searchTerm = "") {
       }
 
       // Filter by search term if provided
-      if (
-        searchTerm &&
-        !entryName.toLowerCase().includes(searchTerm.toLowerCase())
-      ) {
+      if (searchTerm && !entryName.toLowerCase().includes(searchTerm.toLowerCase())) {
         continue;
       }
 
@@ -648,10 +626,80 @@ function getDirectoryContents(dirPath, searchTerm = "") {
 
     return items;
   } catch (error) {
-    console.warn(
-      `Failed to get directory contents from ${dirPath}:`,
-      error.message
-    );
+    console.warn(`Failed to get directory contents from ${dirPath}:`, error.message);
     return [];
   }
 }
+
+/**
+ * Get GitHub repository information
+ * @param {string} repoUrl - The repository URL
+ * @returns {Promise<Object>} - Repository information
+ */
+export 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 automatically without user confirmation
+ * @returns {Promise<Object>} - Project information including name, description, icon, and fromGitHub flag
+ */
+export async function getProjectInfo() {
+  let repoInfo = null;
+  let defaultName = path.basename(process.cwd());
+  let defaultDescription = "";
+  let defaultIcon = "";
+  let fromGitHub = false;
+
+  // 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;
+        fromGitHub = true;
+      }
+    }
+  } catch (_error) {
+    // Not in git repository or no origin remote, use current directory name
+    console.warn("No git repository found, using current directory name");
+  }
+
+  return {
+    name: defaultName,
+    description: defaultDescription,
+    icon: defaultIcon,
+    fromGitHub,
+  };
+}