@aigne/doc-smith 0.9.8-alpha.3 → 0.9.8-alpha.5

package/agents/evaluate/index.yaml

@@ -1,46 +0,0 @@
-type: team
-name: evaluate
-description: Evaluate document quality
-skills:
-  - url: ../init/index.mjs
-    default_input:
-      skipIfExists: true
-      checkOnly: true
-  - url: ../init/check.mjs
-  - ../utils/load-sources.mjs
-  - ../utils/format-document-structure.mjs
-  - type: transform
-    name: transformData
-    task_render_mode: hide
-    jsonata: |
-      $merge([
-        $,
-        {
-          "documentStructure": originalDocumentStructure
-        }
-      ])
-  - ./document-structure.yaml
-  - ../utils/load-all-document-content.mjs
-  - type: team
-    name: batchEvaluateDocument
-    skills:
-      - ../utils/load-document-all-content.mjs
-      - ./document.yaml
-      - ./code-snippet.mjs
-      - type: transform
-        task_render_mode: hide
-        jsonata: |
-          $merge([
-            $
-          ])
-    iterate_on: originalDocumentStructure
-    concurrency: 5
-    mode: sequential
-  - ./generate-report.mjs
-mode: sequential
-input_schema:
-  type: object
-  properties:
-    open:
-      type: boolean
-      description: Auto open generated report

package/agents/history/index.yaml

@@ -1,6 +0,0 @@
-name: "history"
-description: "View and manage document update history"
-tasks:
-  - name: "view"
-    description: "View update history in compact format"
-    agent: "viewHistory"

package/agents/history/view.mjs

@@ -1,78 +0,0 @@
-import { createHash } from "node:crypto";
-import chalk from "chalk";
-import { getHistory } from "../../utils/history-utils.mjs";
-
-export default function viewHistory() {
-  const history = getHistory();
-
-  if (!history.entries || history.entries.length === 0) {
-    console.log(chalk.yellow("\nNo update history found\n"));
-    return {};
-  }
-
-  console.log(chalk.cyan("\n📜 Update History\n"));
-
-  history.entries.forEach((entry) => {
-    // Format: <short-hash> <date> <operation> <feedback>
-    const hash = generateShortHash(entry.timestamp);
-    const date = formatRelativeDate(entry.timestamp);
-    const operation = entry.operation;
-
-    // Handle document path (now a string)
-    const documentInfo = entry.documentPath ? chalk.dim(` (${entry.documentPath})`) : "";
-
-    // Git-style oneline format
-    console.log(
-      `${chalk.yellow(hash)} ${chalk.dim(date)} ${chalk.cyan(operation)}${documentInfo}: ${entry.feedback}`,
-    );
-  });
-
-  console.log(); // Empty line at end
-
-  return {};
-}
-
-/**
- * Generate a short hash from timestamp (git-style)
- */
-function generateShortHash(timestamp) {
-  // Create a deterministic hash from timestamp only
-  // This ensures the same timestamp always produces the same hash
-  const hash = createHash("sha1").update(timestamp).digest("hex");
-  return hash.substring(0, 8); // First 8 chars of SHA1 hash
-}
-
-/**
- * Format date in relative time (git-style)
- */
-function formatRelativeDate(timestamp) {
-  const date = new Date(timestamp);
-  const now = new Date();
-  const diffMs = now - date;
-  const diffSecs = Math.floor(diffMs / 1000);
-  const diffMins = Math.floor(diffSecs / 60);
-  const diffHours = Math.floor(diffMins / 60);
-  const diffDays = Math.floor(diffHours / 24);
-
-  if (diffSecs < 60) {
-    return `${diffSecs} seconds ago`;
-  }
-  if (diffMins < 60) {
-    return `${diffMins} minute${diffMins === 1 ? "" : "s"} ago`;
-  }
-  if (diffHours < 24) {
-    return `${diffHours} hour${diffHours === 1 ? "" : "s"} ago`;
-  }
-  if (diffDays < 7) {
-    return `${diffDays} day${diffDays === 1 ? "" : "s"} ago`;
-  }
-  // Show actual date for older entries
-  return date.toLocaleDateString("en-US", {
-    month: "short",
-    day: "numeric",
-    year: date.getFullYear() !== now.getFullYear() ? "numeric" : undefined,
-  });
-}
-
-viewHistory.description = "View update history in compact format";
-viewHistory.taskTitle = "View update history";

package/agents/init/check.mjs

@@ -1,16 +0,0 @@
-import chalk from "chalk";
-import { getMainLanguageFiles } from "../../utils/docs-finder-utils.mjs";
-
-export default async function checkNeedGenerate({ docsDir, locale, documentStructure }) {
-  const mainLanguageFiles = await getMainLanguageFiles(docsDir, locale, documentStructure);
-
-  if (mainLanguageFiles.length === 0) {
-    console.log(
-      `No documents found in the docs directory. You can generate them with ${chalk.yellow("`aigne doc create`")}`,
-    );
-    process.exit(0);
-  }
-  return {
-    message: 'Documents found in the docs directory, skipping "create" step',
-  };
-}

package/agents/init/index.mjs

@@ -1,275 +0,0 @@
-import { mkdir, readFile, writeFile } from "node:fs/promises";
-import { dirname, join } from "node:path";
-import chalk from "chalk";
-import { stringify as yamlStringify } from "yaml";
-import {
-  DEFAULT_REASONING_EFFORT_LEVEL,
-  DEFAULT_THINKING_EFFORT_LEVEL,
-  DIAGRAM_STYLES,
-} from "../../utils/constants/index.mjs";
-import loadConfig from "../../utils/load-config.mjs";
-import { detectSystemLanguage, getProjectInfo } from "../../utils/utils.mjs";
-import mapReasoningEffortLevel from "../utils/map-reasoning-effort-level.mjs";
-import { validateDocDir } from "./validate.mjs";
-
-/**
- * Guides the user through a multi-turn dialog to generate a YAML configuration file.
- * @param {Object} params
- * @param {string} params.outputPath - The path to the output file.
- * @param {string} params.fileName - The name of the file.
- * @returns {Promise<Object>}
- */
-export default async function init(input, options) {
-  const config = await _init(input, options);
-
-  // Set thinking effort (lite/standard/pro) and map to reasoningEffort
-  options.context.userContext.thinkingEffort =
-    config.thinking?.effort || DEFAULT_THINKING_EFFORT_LEVEL;
-
-  // Set global reasoningEffort based on thinkingEffort
-  options.context.userContext.reasoningEffort = mapReasoningEffortLevel(
-    { level: DEFAULT_REASONING_EFFORT_LEVEL },
-    options,
-  )?.reasoningEffort;
-
-  // for translation agent
-  if (config.translateLanguages) {
-    config.translates = config.translateLanguages.map((lang) => ({ language: lang }));
-  }
-
-  return {
-    ...config,
-  };
-}
-
-async function _init({
-  outputPath = ".aigne/doc-smith",
-  fileName = "config.yaml",
-  skipIfExists = false,
-  appUrl,
-  checkOnly = false,
-}) {
-  // Check if we're in checkOnly mode
-  if (checkOnly) {
-    const filePath = join(outputPath, fileName);
-    const configContent = await readFile(filePath, "utf8").catch(() => null);
-
-    if (!configContent || configContent.trim() === "") {
-      console.log("⚠️ No configuration file found.");
-      console.log(
-        `🚀 Run ${chalk.cyan("aigne doc init")} to set up your documentation configuration.`,
-      );
-      process.exit(0);
-    }
-
-    // Config exists, load and return it
-    return loadConfig({ config: filePath, appUrl });
-  }
-
-  if (skipIfExists) {
-    const filePath = join(outputPath, fileName);
-    const configContent = await readFile(filePath, "utf8").catch(() => null);
-    // Only skip if file exists AND has non-empty content
-    if (configContent && configContent.trim() !== "") {
-      // load config from file
-      const config = await loadConfig({ config: filePath, appUrl });
-      const isValid = validateDocDir(config.docsDir);
-      if (typeof isValid === "string") {
-        console.log(
-          `${chalk.red("Invalid docsDir")}: ${isValid}\nPlease check your configuration.`,
-        );
-        process.exit(1);
-      }
-      if (!isValid) {
-        console.log(`${chalk.red("Invalid docsDir")}, please check your configuration.`);
-        process.exit(1);
-      }
-      return config;
-    }
-  }
-
-  const input = {};
-
-  // 5. Language settings - use system language detection as default
-  // const systemLanguage = detectSystemLanguage();
-  // FIXME: 临时使用中文，框架优化后需要修改
-  input.locale = "zh";
-
-  // 6. Translation languages - default to empty
-  input.translateLanguages = [];
-
-  // 7. Documentation directory - use default value
-  input.docsDir = `${outputPath}/docs`;
-
-  // 8. Content sources - use "./" as default
-  input.sourcesPath = ["./"];
-
-  // 9. Custom rules - default to empty
-  input.rules = "";
-
-  // Save project info to config
-  const projectInfo = await getProjectInfo();
-  // Remove leading and trailing spaces (middle spaces are preserved and count toward limit)
-  input.projectName = projectInfo.name.trim();
-  input.projectDesc = projectInfo.description.trim();
-  input.projectLogo = projectInfo.icon;
-
-  // Generate YAML content
-  const yamlContent = generateYAML(input, outputPath);
-
-  // Save file
-  try {
-    const filePath = join(outputPath, fileName);
-    const dirPath = dirname(filePath);
-
-    // Create directory if it doesn't exist
-    await mkdir(dirPath, { recursive: true });
-
-    await writeFile(filePath, yamlContent, "utf8");
-    console.log(
-      `\n✅ Setup complete! Your configuration has been saved to: ${chalk.cyan(filePath)}`,
-    );
-    console.log("💡 You can edit this file at any time to change your settings.\n");
-    console.log(`🚀 To generate your documentation, run: ${chalk.cyan("aigne doc create")}\n`);
-
-    if (skipIfExists) {
-      return loadConfig({ config: filePath, appUrl });
-    }
-
-    return {};
-  } catch (error) {
-    console.error(
-      `❌ Sorry, I encountered an error while saving your configuration file: ${error.message}`,
-    );
-    return {
-      inputGeneratorStatus: false,
-      inputGeneratorError: error.message,
-    };
-  }
-}
-
-/**
- * Generate YAML configuration content
- * @param {Object} input - Input object
- * @returns {string} YAML string
- */
-export function generateYAML(input) {
-  // Create the main configuration object that will be safely serialized
-  const config = {
-    // Project information (safely handled by yaml library)
-    // Remove leading and trailing spaces (middle spaces are preserved and count toward limit)
-    projectName: (input.projectName || "").trim(),
-    projectDesc: (input.projectDesc || "").trim(),
-    projectLogo: input.projectLogo || "",
-
-    thinking: {
-      effort: input.thinking?.effort || DEFAULT_THINKING_EFFORT_LEVEL,
-    },
-
-    // Custom rules and target audience (empty for user to fill)
-    rules: input.rules || "",
-    targetAudience: "",
-
-    // Language settings
-    locale: input.locale || "en",
-    translateLanguages: input.translateLanguages?.filter((lang) => lang.trim()) || [],
-
-    // Paths
-    docsDir: input.docsDir || "./aigne/doc-smith/docs",
-    sourcesPath: input.sourcesPath || [],
-    media: {
-      // Image filtering settings
-      minImageWidth: input.minImageWidth || 800,
-    },
-  };
-
-  // Generate comments and structure
-  let yaml = "# Project information for documentation publishing\n";
-
-  // Serialize the project info section safely with string quoting
-  const projectSection = yamlStringify({
-    projectName: config.projectName,
-    projectDesc: config.projectDesc,
-    projectLogo: config.projectLogo,
-  }).trim();
-
-  yaml += `${projectSection}\n\n`;
-
-  const modelSection = yamlStringify({
-    thinking: config.thinking,
-  }).trim();
-
-  yaml += `\
-# AI Thinking Configuration
-# thinking.effort: Determines the depth of reasoning and cognitive effort the AI uses when responding, available options:
-#   - lite: Fast responses with basic reasoning
-#   - standard: Balanced speed and reasoning capability
-#   - pro: In-depth reasoning with longer response times
-${modelSection}
-\n`;
-
-  // Custom Documentation Rules and Requirements
-  yaml += "# Custom Rules: Define specific documentation generation rules and requirements\n";
-  const rulesSection = yamlStringify({ rules: config.rules }).trim();
-  // Use literal style for multiline strings
-  yaml += `${rulesSection.replace(/rules: ''/, "rules: |\n  ")}\n\n`;
-
-  // Target Audience Description
-  yaml += "# Target Audience: Describe your specific target audience and their characteristics.\n";
-  const targetAudienceSection = yamlStringify({ targetAudience: config.targetAudience }).trim();
-  // Use literal style for multiline strings
-  yaml += `${targetAudienceSection.replace(/targetAudience: ''/, "targetAudience: |\n  ")}\n\n`;
-
-  // Glossary Configuration
-  yaml += "# Glossary: Define project-specific terms and definitions.\n";
-  yaml +=
-    '# glossary: "@glossary.md"  # Path to a markdown file containing glossary definitions.\n\n';
-
-  // Language settings - safely serialize
-  const localeSection = yamlStringify({ locale: config.locale }).trim();
-  yaml += `${localeSection.replace(/^locale:/, "locale:")}\n`;
-
-  // Translation languages
-  if (config.translateLanguages.length > 0) {
-    const translateLanguagesSection = yamlStringify({
-      translateLanguages: config.translateLanguages,
-    }).trim();
-    yaml += `${translateLanguagesSection.replace(/^translateLanguages:/, "translateLanguages:")}\n`;
-  } else {
-    yaml += "# translateLanguages:  # A list of languages to translate the documentation to.\n";
-    yaml += "#   - zh  # Example: Chinese translation\n";
-    yaml += "#   - en  # Example: English translation\n";
-  }
-
-  // Directory and source path configurations - safely serialize
-  const docsDirSection = yamlStringify({ docsDir: config.docsDir }).trim();
-  yaml += `${docsDirSection}  # The directory where the generated documentation will be saved.\n`;
-
-  const sourcesPathSection = yamlStringify({ sourcesPath: config.sourcesPath }).trim();
-  yaml += `${sourcesPathSection.replace(/^sourcesPath:/, "sourcesPath:  # The source code paths to analyze.")}\n`;
-
-  // Image filtering settings
-  const mediaInfoSection = yamlStringify({
-    media: config.media,
-  }).trim();
-  yaml += `# minImageWidth: Only images wider than this value (in pixels) will be used in the page generation.\n${mediaInfoSection}\n`;
-
-  // Diagramming configuration
-  yaml += "\n# Diagramming Configuration\n";
-  yaml +=
-    "# diagramming.effort: AI effort level for diagramming, 0-10, larger value means fewer diagrams\n";
-  yaml += "diagramming:\n";
-  yaml += "  effort: 5  # AI effort level for diagramming, 0-10, large is less diagram\n";
-  yaml +=
-    "  # Default diagram style: The primary style to use when no style is specified in feedback\n";
-  yaml += "  # This style will be applied if feedback doesn't specify a different style\n";
-  yaml += "  # Available options:\n";
-  Object.entries(DIAGRAM_STYLES).forEach(([key, style]) => {
-    yaml += `  #   ${key.padEnd(16)} - ${style.name}: ${style.description}\n`;
-  });
-  yaml += '  # style: "modern"\n';
-
-  return yaml;
-}
-
-init.description = "Create a configuration file for the documentation generation process.";

package/agents/init/validate.mjs

@@ -1,16 +0,0 @@
-import path from "node:path";
-export function validateDocDir(input) {
-  const currentDir = process.cwd();
-  const targetDir = path.resolve(input);
-  const relativePath = path.relative(currentDir, targetDir);
-  if (relativePath.length === 0) {
-    return `Can't use current directory: ${targetDir}`;
-  }
-  if (relativePath.startsWith("..")) {
-    return `Can't use directory outside current directory: ${targetDir}`;
-  }
-  if (path.isAbsolute(relativePath)) {
-    return `Can't use absolute path: ${targetDir}`;
-  }
-  return true;
-}

package/agents/localize/choose-language.mjs

@@ -1,107 +0,0 @@
-import { SUPPORTED_LANGUAGES } from "../../utils/constants/index.mjs";
-import { loadConfigFromFile, saveValueToConfig } from "../../utils/utils.mjs";
-
-/**
- * Interactively selects languages for translation.
- * @param {Object} params
- * @param {Array<string>} [params.langs] - Pre-selected languages.
- * @param {string} params.locale - The primary language code.
- * @param {Object} options - Options object with prompts.
- * @returns {Promise<Object>} The selected languages.
- */
-export default async function chooseLanguage({ langs, locale, selectedDocs }, options) {
-  let selectedLanguages = [];
-
-  // Load existing config to get current translation languages
-  const existingConfig = await loadConfigFromFile();
-  const currentTranslateLanguages = existingConfig?.translateLanguages || [];
-
-  // Get primary language from config or parameter
-  const primaryLanguage = locale || existingConfig?.locale || "en";
-
-  // Filter out the primary language from available choices (like init.mjs)
-  const availableTranslationLanguages = SUPPORTED_LANGUAGES.filter(
-    (lang) => lang.code !== primaryLanguage,
-  );
-
-  // If languages are provided as a parameter, validate them
-  if (langs && Array.isArray(langs) && langs.length > 0) {
-    const validLanguages = langs.filter((lang) =>
-      availableTranslationLanguages.some((availableLang) => availableLang.code === lang),
-    );
-
-    if (validLanguages.length > 0) {
-      selectedLanguages = validLanguages;
-    } else {
-      console.log(`⚠️  Invalid languages provided: ${langs.join(", ")}`);
-      console.log(
-        `Available languages: ${availableTranslationLanguages.map((l) => l.code).join(", ")}`,
-      );
-    }
-  }
-
-  // If no valid languages were provided, let user select from available languages
-  if (selectedLanguages.length === 0) {
-    // Create choices from available translation languages with labels
-    const choices = availableTranslationLanguages.map((lang) => ({
-      name: `${lang.label} - ${lang.sample}`,
-      value: lang.code,
-      checked: currentTranslateLanguages.includes(lang.code), // Default to previously selected languages
-    }));
-
-    selectedLanguages = await options.prompts.checkbox({
-      message: "Please select the languages you'd like to translate to:",
-      choices: choices,
-      validate: (answer) => {
-        if (answer.length === 0) {
-          return "You must select at least one language.";
-        }
-        return true;
-      },
-    });
-  }
-
-  if (selectedLanguages.length === 0) {
-    throw new Error("You must select at least one language to continue.");
-  }
-
-  // Find new languages that need to be added
-  const newLanguages = selectedLanguages.filter(
-    (lang) => !currentTranslateLanguages.includes(lang),
-  );
-
-  if (newLanguages.length > 0) {
-    // Add new languages to existing ones
-    const updatedTranslateLanguages = [...currentTranslateLanguages, ...newLanguages];
-    await saveValueToConfig("translateLanguages", updatedTranslateLanguages);
-  }
-
-  // Convert selectedLanguages to translates format
-  const translates = selectedLanguages.map((lang) => ({ language: lang }));
-
-  return {
-    selectedLanguages,
-    selectedDocs,
-    translates,
-  };
-}
-
-chooseLanguage.input_schema = {
-  type: "object",
-  properties: {
-    langs: {
-      type: "array",
-      items: {
-        type: "string",
-      },
-      description: "A list of pre-selected languages for translation.",
-    },
-
-    locale: {
-      type: "string",
-      description:
-        "The primary language code, which will be excluded from the translation options.",
-    },
-  },
-  required: [],
-};

package/agents/localize/index.yaml

@@ -1,58 +0,0 @@
-type: team
-name: localize
-alias:
-  - translate
-description: Translate documents into other languages
-skills:
-  - url: ../init/index.mjs
-    default_input:
-      skipIfExists: true
-      checkOnly: true
-  - ../utils/load-sources.mjs
-  - url: ../init/check.mjs
-  - type: transform
-    task_render_mode: hide
-    jsonata: |
-      $merge([
-        $,
-        {
-          'documentStructure': originalDocumentStructure
-        }
-      ])
-  - url: ../utils/choose-docs.mjs
-    default_input:
-      isTranslate: true
-  - ../localize/choose-language.mjs
-  - type: team
-    name: batchTranslateDocument
-    skills:
-      - ../localize/translate-multilingual.yaml
-    iterate_on: selectedDocs
-    concurrency: 5
-  - url: ../utils/check-feedback-refiner.mjs
-    default_input:
-      stage: translation_refine
-  - url: ./record-translation-history.mjs
-  - url: ../utils/action-success.mjs
-    default_input:
-      action: '✅ Translation completed'
-input_schema:
-  type: object
-  properties:
-    # glossary:
-    #   type: string
-    #   description: Glossary file for consistent terminology (use @filename.md)
-    docs:
-      type: array
-      items:
-        type: string
-      description: Documents to update, use document path in document structure to specify
-    langs:
-      type: array
-      items:
-        type: string
-      description: 'Target languages (available: en, zh, zh-TW, ja, fr, de, es, it, ru, ko, pt, ar)'
-    feedback:
-      type: string
-      description: Tell us how to improve the translation style
-mode: sequential

package/agents/localize/record-translation-history.mjs

@@ -1,23 +0,0 @@
-import { recordUpdate } from "../../utils/history-utils.mjs";
-
-export default function recordTranslationHistory({ selectedPaths, feedback }) {
-  // Skip if no feedback provided
-  if (!feedback?.trim()) {
-    return {};
-  }
-
-  if (!Array.isArray(selectedPaths) || selectedPaths.length === 0) {
-    return {};
-  }
-
-  // Record translation history for this document
-  recordUpdate({
-    operation: "translation_update",
-    feedback: feedback.trim(),
-    docPaths: selectedPaths,
-  });
-
-  return {};
-}
-
-recordTranslationHistory.task_render_mode = "hide";

package/agents/localize/translate-document.yaml

@@ -1,24 +0,0 @@
-name: translateDocument
-description: Translate content to another language
-instructions:
-  url: ../../prompts/translate/translate-document.md
-task_render_mode: collapse
-input_schema:
-  type: object
-  properties:
-    language:
-      type: string
-      description: Target language (e.g., 'zh' for Chinese, 'ja' for Japanese)
-    content:
-      type: string
-      description: Text content to translate
-    glossary:
-      type: string
-      description: Glossary for consistent terminology
-    feedback:
-      type: string
-      description: Tell us how to improve the translation style
-  required:
-    - language
-    - content
-output_key: translation