@aigne/doc-smith 0.9.10 → 0.9.11-beta

package/utils/constants/linter.mjs

@@ -1,102 +0,0 @@
-export const LINTER_API_URL = process.env.LINTER_API_URL || "https://linter.abtnet.io";
-
-export const LINTER_SUPPORTED_FILE = {
-  biome: [".js", ".jsx", ".ts", ".tsx", ".json"],
-  eslint: [".js", ".jsx", ".ts", ".tsx", ".vue"],
-  oxlint: [".js", ".jsx", ".ts", ".tsx"],
-  prettier: [".js", ".jsx", ".ts", ".tsx", ".json", ".css"],
-  pylint: [".py"],
-  flake8: [".py"],
-  black: [".py"],
-  isort: [".py"],
-  mypy: [".py"],
-  shellcheck: [".sh", ".bash", ".dash", ".ksh"],
-  "golangci-lint": [".go"],
-  rubocop: [".rb", ".rake", ".gemfile", "Gemfile"],
-  hadolint: ["Dockerfile", ".dockerfile"],
-  yamllint: [".yml", ".yaml"],
-  stylelint: [".css", ".scss", ".sass"],
-};
-export const SUFFIX_TO_CODE_LANGUAGE = {
-  ".js": ["js", "javascript", "node"],
-  ".jsx": ["jsx"],
-  ".ts": ["ts", "typescript"],
-  ".tsx": ["tsx"],
-  ".json": ["json"],
-  ".vue": ["vue"],
-  ".css": ["css"],
-  ".py": ["python", "python3"],
-  ".sh": ["shell", "sh", "shell-script", "bash", "zsh"],
-  ".go": ["go", "golang"],
-  ".rb": ["ruby", "jruby", "macruby", "rake", "rb", "rbx"],
-  ".dockerfile": ["dockerfile"],
-  ".yml": ["yaml", "yml"],
-  ".sass": ["sass"],
-  ".scss": ["scss"],
-};
-
-export const CODE_LANGUAGE_MAP_LINTER = {
-  js: "biome-lint",
-  javascript: "biome-lint",
-  node: "biome-lint",
-  jsx: "biome-lint",
-  ts: "biome-lint",
-  typescript: "biome-lint",
-  tsx: "biome-lint",
-  json: "biome-lint",
-  vue: "eslint",
-  css: "prettier",
-  python: "flake8",
-  python3: "flake8",
-  shell: "shellcheck",
-  sh: "shellcheck",
-  "shell-script": "shellcheck",
-  bash: "shellcheck",
-  zsh: "shellcheck",
-  go: "golangci-lint",
-  golang: "golangci-lint",
-  ruby: "rubocop",
-  jruby: "rubocop",
-  macruby: "rubocop",
-  rake: "rubocop",
-  rb: "rubocop",
-  rbx: "rubocop",
-  dockerfile: "hadolint",
-  yaml: "yamllint",
-  yml: "yamllint",
-  sass: "stylelint",
-  scss: "stylelint",
-};
-
-export const CODE_LANGUAGE_MAP_SUFFIX = {
-  js: ".js",
-  javascript: ".js",
-  node: ".js",
-  jsx: ".jsx",
-  ts: ".ts",
-  typescript: ".ts",
-  tsx: ".tsx",
-  json: ".json",
-  vue: ".vue",
-  css: ".css",
-  python: ".py",
-  python3: ".py",
-  shell: ".sh",
-  sh: ".sh",
-  "shell-script": ".sh",
-  bash: ".sh",
-  zsh: ".sh",
-  go: ".go",
-  golang: ".go",
-  ruby: ".rb",
-  jruby: ".rb",
-  macruby: ".rb",
-  rake: ".rb",
-  rb: ".rb",
-  rbx: ".rb",
-  dockerfile: ".dockerfile",
-  yaml: ".yml",
-  yml: ".yml",
-  sass: ".sass",
-  scss: ".scss",
-};

package/utils/d2-utils.mjs

@@ -1,205 +0,0 @@
-import path from "node:path";
-
-import fs from "fs-extra";
-
-import { DOC_SMITH_DIR, TMP_DIR } from "./constants/index.mjs";
-
-// Note: .* matches title or other text after ```d2 (e.g., ```d2 Vault 驗證流程)
-// Export regex for reuse across the codebase to avoid duplication
-export const d2CodeBlockRegex = /```d2.*\n([\s\S]*?)```/g;
-
-export const DIAGRAM_PLACEHOLDER = "DIAGRAM_PLACEHOLDER";
-
-// Diagram image regex patterns for reuse across the codebase
-// Pattern 1: Match only the start marker (for checking existence)
-export const diagramImageStartRegex =
-  /<!--\s*DIAGRAM_IMAGE_START:([A-Za-z0-9_-]+):(\d+:\d+)(::?\d+)?\s*-->/g;
-
-// Pattern 2: Match full diagram image block without capturing image path (for finding/replacing)
-// Supports both old format (without aspectRatio) and new format (with aspectRatio)
-export const diagramImageBlockRegex =
-  /<!--\s*DIAGRAM_IMAGE_START:([A-Za-z0-9_-]+)(?::(\d+:\d+))?(::?\d+)?\s*-->\s*[\s\S]*?<!--\s*DIAGRAM_IMAGE_END\s*-->/g;
-
-// Pattern 3: Match full diagram image block with image path capture (for extracting paths)
-// Compatible with old format (without timestamp): <!-- DIAGRAM_IMAGE_START:type:aspectRatio -->
-export const diagramImageWithPathRegex =
-  /<!--\s*DIAGRAM_IMAGE_START:([A-Za-z0-9_-]+):(\d+:\d+)(::?\d+)?\s*-->\s*!\[[^\]]*\]\(([^)]+)\)\s*<!--\s*DIAGRAM_IMAGE_END\s*-->/g;
-
-// Pattern 4: Match full diagram image block with all details (type, aspectRatio, timestamp, path, altText)
-export const diagramImageFullRegex =
-  /<!--\s*DIAGRAM_IMAGE_START:([A-Za-z0-9_-]+):(\d+:\d+)(::?\d+)?\s*-->\s*!\[([^\]]*)\]\(([^)]+)\)\s*<!--\s*DIAGRAM_IMAGE_END\s*-->/g;
-
-export async function ensureTmpDir() {
-  const tmpDir = path.join(DOC_SMITH_DIR, TMP_DIR);
-  if (!(await fs.pathExists(path.join(tmpDir, ".gitignore")))) {
-    await fs.ensureDir(tmpDir);
-    await fs.writeFile(path.join(tmpDir, ".gitignore"), "**/*", { encoding: "utf8" });
-  }
-}
-
-export function isValidCode(lang) {
-  return lang?.toLowerCase() === "d2";
-}
-
-export function wrapCode({ content }) {
-  const matches = Array.from(content.matchAll(d2CodeBlockRegex));
-  if (matches.length > 0) {
-    return content;
-  }
-
-  return `\`\`\`d2\n${content}\n\`\`\``;
-}
-
-/**
- * Replaces D2 code block with DIAGRAM_PLACEHOLDER.
- * @param {string} content - Document content containing D2 code block
- * @returns {Array} - [contentWithPlaceholder, originalCodeBlock]
- */
-export function replaceD2WithPlaceholder({ content }) {
-  const [firstMatch] = Array.from(content.matchAll(d2CodeBlockRegex));
-  if (firstMatch) {
-    const matchContent = firstMatch[0];
-    const cleanContent = content.replace(matchContent, DIAGRAM_PLACEHOLDER);
-    return [cleanContent, matchContent];
-  }
-
-  return [content, ""];
-}
-
-/**
- * Replaces DIAGRAM_PLACEHOLDER with D2 code block, ensuring proper spacing.
- * @param {string} content - Document content containing DIAGRAM_PLACEHOLDER
- * @param {string} diagramSourceCode - D2 diagram source code (without markdown wrapper)
- * @returns {string} - Content with placeholder replaced by code block
- */
-export function replacePlaceholderWithD2({ content, diagramSourceCode }) {
-  if (!content || !diagramSourceCode) {
-    return content;
-  }
-
-  const placeholderIndex = content.indexOf(DIAGRAM_PLACEHOLDER);
-  if (placeholderIndex === -1) {
-    return content;
-  }
-
-  // Check if placeholder has newlines around it
-  const beforePlaceholder = content.substring(0, placeholderIndex);
-  const afterPlaceholder = content.substring(placeholderIndex + DIAGRAM_PLACEHOLDER.length);
-
-  const codeBlock = wrapCode({ content: diagramSourceCode });
-
-  // Add newlines if missing
-  let replacement = codeBlock;
-  if (beforePlaceholder && !beforePlaceholder.endsWith("\n")) {
-    replacement = `\n${replacement}`;
-  }
-  if (afterPlaceholder && !afterPlaceholder.startsWith("\n")) {
-    replacement = `${replacement}\n`;
-  }
-
-  return content.replace(DIAGRAM_PLACEHOLDER, replacement);
-}
-
-/**
- * Replace all diagrams (D2 code blocks and generated images) with DIAGRAM_PLACEHOLDER
- * Used for deletion operations to normalize all diagram types to a single placeholder
- * @param {string} content - Document content containing diagrams
- * @param {number} [diagramIndex] - Optional index of diagram to replace (0-based). If not provided, replaces all diagrams.
- * @returns {string} - Content with diagrams replaced by DIAGRAM_PLACEHOLDER
- */
-export function replaceDiagramsWithPlaceholder({ content, diagramIndex }) {
-  if (!content) {
-    return content;
-  }
-
-  // Use exported regex to find all diagram locations
-  // We'll use a similar approach to findAllDiagramLocations
-  const mermaidCodeBlockRegex = /```mermaid.*\n([\s\S]*?)```/g;
-
-  // Find all diagram locations
-  const locations = [];
-
-  // 1. Find DIAGRAM_PLACEHOLDER (already a placeholder, keep as is)
-  let placeholderIndex = content.indexOf(DIAGRAM_PLACEHOLDER);
-  while (placeholderIndex !== -1) {
-    locations.push({
-      type: "placeholder",
-      start: placeholderIndex,
-      end: placeholderIndex + DIAGRAM_PLACEHOLDER.length,
-    });
-    placeholderIndex = content.indexOf(DIAGRAM_PLACEHOLDER, placeholderIndex + 1);
-  }
-
-  // 2. Find DIAGRAM_IMAGE_START markers (generated images)
-  const imageMatches = Array.from(content.matchAll(diagramImageBlockRegex));
-  for (const match of imageMatches) {
-    locations.push({
-      type: "image",
-      start: match.index,
-      end: match.index + match[0].length,
-    });
-  }
-
-  // 3. Find D2 code blocks
-  const d2Matches = Array.from(content.matchAll(d2CodeBlockRegex));
-  for (const match of d2Matches) {
-    locations.push({
-      type: "d2",
-      start: match.index,
-      end: match.index + match[0].length,
-    });
-  }
-
-  // 4. Find Mermaid code blocks
-  const mermaidMatches = Array.from(content.matchAll(mermaidCodeBlockRegex));
-  for (const match of mermaidMatches) {
-    locations.push({
-      type: "mermaid",
-      start: match.index,
-      end: match.index + match[0].length,
-    });
-  }
-
-  // Sort by position (top to bottom)
-  locations.sort((a, b) => a.start - b.start);
-
-  if (locations.length === 0) {
-    return content;
-  }
-
-  // If diagramIndex is provided, only replace that specific diagram
-  if (diagramIndex !== undefined && diagramIndex >= 0 && diagramIndex < locations.length) {
-    const targetLocation = locations[diagramIndex];
-    const before = content.substring(0, targetLocation.start);
-    const after = content.substring(targetLocation.end);
-    // Add newlines if needed
-    let replacement = DIAGRAM_PLACEHOLDER;
-    if (before && !before.endsWith("\n")) {
-      replacement = `\n${replacement}`;
-    }
-    if (after && !after.startsWith("\n")) {
-      replacement = `${replacement}\n`;
-    }
-    return before + replacement + after;
-  }
-
-  // Replace all diagrams with placeholder (for deletion)
-  // Process from end to start to preserve indices
-  let result = content;
-  for (let i = locations.length - 1; i >= 0; i--) {
-    const location = locations[i];
-    const before = result.substring(0, location.start);
-    const after = result.substring(location.end);
-    // Add newlines if needed
-    let replacement = DIAGRAM_PLACEHOLDER;
-    if (before && !before.endsWith("\n")) {
-      replacement = `\n${replacement}`;
-    }
-    if (after && !after.startsWith("\n")) {
-      replacement = `${replacement}\n`;
-    }
-    result = before + replacement + after;
-  }
-
-  return result;
-}

package/utils/debug.mjs

@@ -1,3 +0,0 @@
-import Debug from "debug";
-
-export const debug = Debug("doc-smith");

package/utils/delete-diagram-images.mjs

@@ -1,99 +0,0 @@
-import { unlink } from "node:fs/promises";
-import { join, dirname, normalize } from "node:path";
-import fs from "fs-extra";
-import { debug } from "./debug.mjs";
-import { diagramImageWithPathRegex } from "./d2-utils.mjs";
-
-/**
- * Extract image file paths from markdown content
- * Finds all diagram image references and extracts their file paths
- * @param {string} content - Markdown content
- * @param {string} path - Document path (e.g., "guides/getting-started.md")
- * @param {string} docsDir - Documentation directory
- * @returns {Promise<Array<string>>} Array of absolute paths to image files
- */
-export async function extractDiagramImagePaths(content, path, docsDir) {
-  if (!content || !path || !docsDir) {
-    return [];
-  }
-
-  const imagePaths = [];
-
-  // Pattern to match: <!-- DIAGRAM_IMAGE_START:... -->![alt](path)<!-- DIAGRAM_IMAGE_END -->
-  const matches = Array.from((content || "").matchAll(diagramImageWithPathRegex));
-
-  for (const match of matches) {
-    const imagePath = match[4] || ""; // Path is in capture group 4 (groups: 1=type, 2=aspectRatio, 3=timestamp, 4=path)
-
-    // Resolve absolute path
-    // If imagePath is relative, resolve from document location
-    // If imagePath is absolute or starts with http, skip
-    if (imagePath.startsWith("http://") || imagePath.startsWith("https://")) {
-      continue; // Skip remote URLs
-    }
-
-    // Calculate relative path from document to image
-    const docDir = dirname(path);
-    const imageRelativePath = imagePath.startsWith("../")
-      ? imagePath
-      : join(docDir, imagePath).replace(/\\/g, "/");
-
-    // Resolve absolute path
-    const absolutePath = join(process.cwd(), docsDir, imageRelativePath);
-
-    // Normalize path (remove .. and .)
-    const normalizedPath = normalize(absolutePath);
-
-    if (await fs.pathExists(normalizedPath)) {
-      imagePaths.push(normalizedPath);
-    }
-  }
-
-  return imagePaths;
-}
-
-/**
- * Delete diagram image files associated with a document
- * @param {string} content - Markdown content (before deletion)
- * @param {string} path - Document path
- * @param {string} docsDir - Documentation directory
- * @returns {Promise<{deleted: number, failed: number}>}
- */
-export async function deleteDiagramImages(content, path, docsDir) {
-  if (!content || !path || !docsDir) {
-    return { deleted: 0, failed: 0 };
-  }
-
-  try {
-    const imagePaths = await extractDiagramImagePaths(content, path, docsDir);
-
-    if (imagePaths.length === 0) {
-      return { deleted: 0, failed: 0 };
-    }
-
-    let deleted = 0;
-    let failed = 0;
-
-    for (const imagePath of imagePaths) {
-      try {
-        await unlink(imagePath);
-        debug(`Deleted diagram image: ${imagePath}`);
-        deleted++;
-      } catch (error) {
-        if (error.code !== "ENOENT") {
-          // File not found is ok, other errors should be logged
-          console.warn(`Failed to delete diagram image ${imagePath}: ${error.message}`);
-          failed++;
-        } else {
-          // File already doesn't exist, count as deleted
-          deleted++;
-        }
-      }
-    }
-
-    return { deleted, failed };
-  } catch (error) {
-    console.warn(`Error deleting diagram images: ${error.message}`);
-    return { deleted: 0, failed: 0 };
-  }
-}

package/utils/diagram-version-utils.mjs

@@ -1,14 +0,0 @@
-import fs from "fs-extra";
-
-/**
- * Calculate timestamp for diagram image
- * Uses file modification time (mtime) as the version identifier
- * @param {string} imagePath - Absolute path to the image file
- * @returns {Promise<string>} Unix timestamp in seconds (as string)
- */
-export async function calculateImageTimestamp(imagePath) {
-  const stats = await fs.stat(imagePath);
-  // Use modification time, convert to Unix timestamp (seconds)
-  const timestamp = Math.floor(stats.mtimeMs / 1000);
-  return timestamp.toString();
-}