@aigne/doc-smith 0.0.1

package/tests/test-save-docs.mjs

@@ -0,0 +1,132 @@
+import { writeFile, mkdir, readdir } from "node:fs/promises";
+import { join } from "node:path";
+import { fileURLToPath } from "node:url";
+import { dirname } from "node:path";
+import saveDocs from "../agents/save-docs.mjs";
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+async function testSaveDocs() {
+  // Create a temporary test directory
+  const testDir = join(__dirname, "test-docs");
+
+  try {
+    // Create test directory
+    await mkdir(testDir, { recursive: true });
+
+    // Create some test files
+    const testFiles = [
+      "overview.md",
+      "getting-started.md",
+      "getting-started.zh.md",
+      "getting-started.en.md",
+      "old-file.md", // This should be deleted
+      "another-old-file.md", // This should be deleted
+      "old-translation.zh.md", // This should be deleted
+      "_sidebar.md", // This should be preserved
+    ];
+
+    for (const file of testFiles) {
+      await writeFile(join(testDir, file), `# Test content for ${file}`);
+    }
+
+    console.log("Created test files:");
+    const files = await readdir(testDir);
+    console.log(files);
+
+    // Test structure plan
+    const structurePlan = [
+      {
+        path: "/overview",
+        title: "Overview",
+        description: "Overview page",
+      },
+      {
+        path: "/getting-started",
+        title: "Getting Started",
+        description: "Getting started guide",
+      },
+    ];
+
+    // Test with translation languages
+    const translateLanguages = ["zh", "en"];
+
+    console.log("\nRunning saveDocs with cleanup...");
+    const result = await saveDocs({
+      structurePlanResult: structurePlan,
+      docsDir: testDir,
+      translateLanguages,
+    });
+
+    console.log("\nSaveDocs result:");
+    console.log(JSON.stringify(result, null, 2));
+
+    console.log("\nFiles after cleanup:");
+    const remainingFiles = await readdir(testDir);
+    console.log(remainingFiles);
+
+    // Expected files after cleanup:
+    // - overview.md (existing)
+    // - getting-started.md (existing)
+    // - getting-started.zh.md (existing)
+    // - getting-started.en.md (existing)
+    // - _sidebar.md (generated)
+    // Note: overview.zh.md and overview.en.md are not created by saveDocs,
+    // they would be created by saveDocWithTranslations when content is generated
+    const expectedFiles = [
+      "overview.md",
+      "getting-started.md",
+      "getting-started.zh.md",
+      "getting-started.en.md",
+      "_sidebar.md",
+    ];
+
+    const missingFiles = expectedFiles.filter(
+      (file) => !remainingFiles.includes(file)
+    );
+    const extraFiles = remainingFiles.filter(
+      (file) => !expectedFiles.includes(file)
+    );
+
+    if (missingFiles.length === 0 && extraFiles.length === 0) {
+      console.log("\n✅ Test passed! All files are as expected.");
+    } else {
+      console.log("\n❌ Test failed!");
+      if (missingFiles.length > 0) {
+        console.log("Missing files:", missingFiles);
+      }
+      if (extraFiles.length > 0) {
+        console.log("Extra files:", extraFiles);
+      }
+    }
+
+    // Verify that invalid files were deleted
+    const deletedFiles = [
+      "old-file.md",
+      "another-old-file.md",
+      "old-translation.zh.md",
+    ];
+    const stillExist = deletedFiles.filter((file) =>
+      remainingFiles.includes(file)
+    );
+
+    if (stillExist.length === 0) {
+      console.log("✅ All invalid files were successfully deleted.");
+    } else {
+      console.log("❌ Some invalid files still exist:", stillExist);
+    }
+  } catch (error) {
+    console.error("Test failed with error:", error);
+  } finally {
+    // Clean up test directory
+    try {
+      const { rm } = await import("node:fs/promises");
+      await rm(testDir, { recursive: true, force: true });
+      console.log("\nCleaned up test directory");
+    } catch (err) {
+      console.log("Failed to clean up test directory:", err.message);
+    }
+  }
+}
+
+testSaveDocs();

package/utils/utils.mjs

@@ -0,0 +1,86 @@
+import fs from "node:fs/promises";
+import path from "node:path";
+
+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})`;
+    }
+  );
+}
+
+/**
+ * Save a single document and its translations to files
+ * @param {Object} params
+ * @param {string} params.path - Relative path (without extension)
+ * @param {string} params.content - Main document content
+ * @param {string} params.docsDir - Root directory
+ * @param {Array<{language: string, translation: string}>} [params.translates] - Translation content
+ * @param {Array<string>} [params.labels] - Document labels for front matter
+ * @returns {Promise<Array<{ path: string, success: boolean, error?: string }>>}
+ */
+export async function saveDocWithTranslations({
+  path: docPath,
+  content,
+  docsDir,
+  translates = [],
+  labels,
+}) {
+  const results = [];
+  try {
+    // Flatten path: remove leading /, replace all / with -
+    const flatName = docPath.replace(/^\//, "").replace(/\//g, "-");
+    const fileFullName = `${flatName}.md`;
+    const filePath = path.join(docsDir, fileFullName);
+    await fs.mkdir(docsDir, { recursive: true });
+
+    // 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(filePath, finalContent, "utf8");
+    results.push({ path: filePath, success: true });
+
+    for (const translate of translates) {
+      const translateFileName = `${flatName}.${translate.language}.md`;
+      const translatePath = path.join(docsDir, translateFileName);
+
+      // Add labels front matter to translation content if labels are provided
+      let finalTranslationContent = processContent({
+        content: translate.translation,
+      });
+      if (labels && labels.length > 0) {
+        const frontMatter = `---\nlabels: ${JSON.stringify(labels)}\n---\n\n`;
+        finalTranslationContent = frontMatter + finalTranslationContent;
+      }
+
+      await fs.writeFile(translatePath, finalTranslationContent, "utf8");
+      results.push({ path: translatePath, success: true });
+    }
+  } catch (err) {
+    results.push({ path: docPath, success: false, error: err.message });
+  }
+  return results;
+}