@aigne/doc-smith 0.1.3 → 0.2.0

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",
+    },
   },
 };

package/agents/publish-docs.mjs

@@ -9,8 +9,10 @@ import { homedir } from "node:os";
 import { parse, stringify } from "yaml";
 import { execSync } from "node:child_process";
 import { basename } from "node:path";
+import { loadConfigFromFile, saveValueToConfig } from "../utils/utils.mjs";
 
 const WELLKNOWN_SERVICE_PATH_PREFIX = "/.well-known/service";
+const DEFAULT_APP_URL = "https://docsmith.aigne.io";
 
 /**
  * Get project name from git repository or current directory
@@ -116,51 +118,50 @@ async function getAccessToken(appUrl) {
   return accessToken;
 }
 
-/**
- * Save boardId to config.yaml file if it was auto-created
- * @param {string} boardId - The original boardId (may be empty)
- * @param {string} newBoardId - The boardId returned from publishDocsFn
- */
-async function saveBoardIdToInput(boardId, newBoardId) {
-  // Only save if boardId was auto-created
-  if (!boardId && newBoardId) {
-    try {
-      const docSmithDir = join(process.cwd(), "doc-smith");
-      if (!existsSync(docSmithDir)) {
-        mkdirSync(docSmithDir, { recursive: true });
-      }
-
-      const inputFilePath = join(docSmithDir, "config.yaml");
-      let fileContent = "";
-
-      // Read existing file content if it exists
-      if (existsSync(inputFilePath)) {
-        fileContent = await readFile(inputFilePath, "utf8");
-      }
-
-      // Check if boardId already exists in the file
-      const boardIdRegex = /^boardId:\s*.*$/m;
-      const newBoardIdLine = `boardId: ${newBoardId}`;
-
-      if (boardIdRegex.test(fileContent)) {
-        // Replace existing boardId line
-        fileContent = fileContent.replace(boardIdRegex, newBoardIdLine);
-      } else {
-        // Add boardId to the end of file
-        if (fileContent && !fileContent.endsWith("\n")) {
-          fileContent += "\n";
-        }
-        fileContent += newBoardIdLine + "\n";
-      }
+export default async function publishDocs(
+  { docsDir, appUrl, boardId },
+  options
+) {
+  // Check if appUrl is default and not saved in config
+  const config = await loadConfigFromFile();
+  const isDefaultAppUrl = appUrl === DEFAULT_APP_URL;
+  const hasAppUrlInConfig = config && config.appUrl;
+
+  if (isDefaultAppUrl && !hasAppUrlInConfig) {
+    console.log("\n=== Document Publishing Platform Selection ===");
+    console.log(
+      "Please select the platform where you want to publish your documents:"
+    );
 
-      await writeFile(inputFilePath, fileContent);
-    } catch (error) {
-      console.warn("Failed to save board ID to config.yaml:", error.message);
+    const choice = await options.prompts.select({
+      message: "Select publishing platform:",
+      choices: [
+        {
+          name: "Use official platform (docsmith.aigne.io) - Documents will be publicly accessible, suitable for open source projects",
+          value: "default",
+        },
+        {
+          name: "Use private platform - Deploy your own Discuss Kit instance, suitable for internal documentation",
+          value: "custom",
+        },
+      ],
+    });
+
+    if (choice === "custom") {
+      appUrl = await options.prompts.input({
+        message: "Please enter your Discuss Kit platform URL:",
+        validate: (input) => {
+          try {
+            new URL(input);
+            return true;
+          } catch {
+            return "Please enter a valid URL";
+          }
+        },
+      });
     }
   }
-}
 
-export default async function publishDocs({ docsDir, appUrl, boardId }) {
   const accessToken = await getAccessToken(appUrl);
 
   process.env.DOC_ROOT_DIR = docsDir;
@@ -179,8 +180,16 @@ export default async function publishDocs({ docsDir, appUrl, boardId }) {
     autoCreateBoard: !boardId,
   });
 
-  // Save boardId to config.yaml if it was auto-created
-  await saveBoardIdToInput(boardId, newBoardId);
+  // Save values to config.yaml if publish was successful
+  if (success) {
+    // Save appUrl to config
+    await saveValueToConfig("appUrl", appUrl);
+
+    // Save boardId to config if it was auto-created
+    if (!boardId && newBoardId) {
+      await saveValueToConfig("boardId", newBoardId);
+    }
+  }
 
   return {
     publishResult: {
@@ -199,9 +208,7 @@ publishDocs.input_schema = {
     appUrl: {
       type: "string",
       description: "The url of the app",
-      default:
-        // "https://bbqawfllzdt3pahkdsrsone6p3wpxcwp62vlabtawfu.did.abtnet.io",
-        "https://www.staging.arcblock.io",
+      default: DEFAULT_APP_URL,
     },
     boardId: {
       type: "string",

package/agents/save-docs.mjs

@@ -1,5 +1,6 @@
 import { writeFile, readdir, unlink } from "node:fs/promises";
 import { join } from "node:path";
+import { getCurrentGitHead, saveGitHeadToConfig } from "../utils/utils.mjs";
 
 /**
  * @param {Object} params
@@ -16,6 +17,14 @@ export default async function saveDocs({
 }) {
   const results = [];
 
+  // Save current git HEAD to config.yaml for change detection
+  try {
+    const gitHead = getCurrentGitHead();
+    await saveGitHeadToConfig(gitHead);
+  } catch (err) {
+    console.warn("Failed to save git HEAD:", err.message);
+  }
+
   // Generate _sidebar.md
   try {
     const sidebar = generateSidebar(structurePlan);

package/agents/team-publish-docs.yaml

@@ -5,6 +5,9 @@ alias:
   - p
 description: Publish the documentation to Discuss Kit
 skills:
+  - url: ./input-generator.mjs
+    default_input:
+      skipIfExists: true
   - load-config.mjs
   - publish-docs.mjs
 input_schema:

package/agents/transform-detail-datasources.mjs

@@ -1,14 +1,28 @@
+import { normalizePath, toRelativePath } from "../utils/utils.mjs";
+
 export default function transformDetailDatasources({
   sourceIds,
   datasourcesList,
 }) {
-  // Build a map for fast lookup
+  // Build a map for fast lookup, with path normalization for compatibility
   const dsMap = Object.fromEntries(
-    (datasourcesList || []).map((ds) => [ds.sourceId, ds.content])
+    (datasourcesList || []).map((ds) => {
+      const normalizedSourceId = normalizePath(ds.sourceId);
+      return [normalizedSourceId, ds.content];
+    })
   );
-  // Collect formatted contents in order
+
+  // Collect formatted contents in order, with path normalization
   const contents = (sourceIds || [])
-    .filter((id) => dsMap[id])
-    .map((id) => `// sourceId: ${id}\n${dsMap[id]}\n`);
+    .filter((id) => {
+      const normalizedId = normalizePath(id);
+      return dsMap[normalizedId];
+    })
+    .map((id) => {
+      const normalizedId = normalizePath(id);
+      const relativeId = toRelativePath(id);
+      return `// sourceId: ${relativeId}\n${dsMap[normalizedId]}\n`;
+    });
+
   return { detailDataSources: contents.join("") };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aigne/doc-smith",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "description": "",
   "publishConfig": {
     "access": "public"
@@ -12,12 +12,12 @@
   "author": "Arcblock <blocklet@arcblock.io> https://github.com/blocklet",
   "license": "MIT",
   "dependencies": {
-    "@aigne/anthropic": "^0.10.4",
-    "@aigne/cli": "^1.29.0",
-    "@aigne/core": "^1.41.0",
-    "@aigne/gemini": "^0.8.8",
-    "@aigne/openai": "^0.10.8",
-    "@aigne/publish-docs": "^0.5.1",
+    "@aigne/anthropic": "^0.10.6",
+    "@aigne/cli": "^1.30.1",
+    "@aigne/core": "^1.43.0",
+    "@aigne/gemini": "^0.8.10",
+    "@aigne/openai": "^0.10.10",
+    "@aigne/publish-docs": "^0.5.2",
     "glob": "^11.0.3",
     "open": "^10.2.0",
     "ufo": "^1.6.1",

package/prompts/check-structure-planning-result.md

@@ -17,7 +17,7 @@
 ```
 {{ feedback }}
 
-根据最新的 Data Sources 按需要更新节点的 sourceIds ,更新至状态。
+根据最新的 Data Sources 按需要更新节点的 sourceIds。
 ```
 </context>
 

package/prompts/structure-planning.md

@@ -30,7 +30,7 @@
 <structure_plan_feedback>
 {{ feedback }}
 
-根据最新的 Data Sources 按需要更新节点的 sourceIds ,更新至状态。
+根据最新的 Data Sources 按需要更新节点的 sourceIds。
 </structure_plan_feedback>
 
 <review_structure_plan>

package/utils/constants.mjs

@@ -0,0 +1,60 @@
+// Default file patterns for inclusion and exclusion
+export const DEFAULT_INCLUDE_PATTERNS = [
+  "*.py",
+  "*.js",
+  "*.jsx",
+  "*.ts",
+  "*.tsx",
+  "*.go",
+  "*.java",
+  "*.pyi",
+  "*.pyx",
+  "*.c",
+  "*.cc",
+  "*.cpp",
+  "*.h",
+  "*.md",
+  "*.rst",
+  "*.json",
+  "*Dockerfile",
+  "*Makefile",
+  "*.yaml",
+  "*.yml",
+];
+
+export 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.*",
+];