@aigne/doc-smith 0.2.6 → 0.2.9

package/agents/publish-docs.mjs

@@ -1,13 +1,12 @@
-import { join } from "node:path";
-import { joinURL } from "ufo";
-import open from "open";
-import { publishDocs as publishDocsFn } from "@aigne/publish-docs";
-import { createConnect } from "@aigne/cli/utils/load-aigne.js";
 import { existsSync, mkdirSync } from "node:fs";
 import { readFile, writeFile } from "node:fs/promises";
 import { homedir } from "node:os";
+import { basename, join } from "node:path";
+import { createConnect } from "@aigne/aigne-hub";
+import { publishDocs as publishDocsFn } from "@aigne/publish-docs";
+import open from "open";
+import { joinURL } from "ufo";
 import { parse, stringify } from "yaml";
-import { basename } from "node:path";
 import { loadConfigFromFile, saveValueToConfig } from "../utils/utils.mjs";
 
 const WELLKNOWN_SERVICE_PATH_PREFIX = "/.well-known/service";
@@ -19,11 +18,7 @@ const DEFAULT_APP_URL = "https://docsmith.aigne.io";
  * @returns {Promise<string>} - The access token
  */
 async function getAccessToken(appUrl) {
-  const DOC_SMITH_ENV_FILE = join(
-    homedir(),
-    ".aigne",
-    "doc-smith-connected.yaml"
-  );
+  const DOC_SMITH_ENV_FILE = join(homedir(), ".aigne", "doc-smith-connected.yaml");
   const { hostname } = new URL(appUrl);
 
   let accessToken = process.env.DOC_DISCUSS_KIT_ACCESS_TOKEN;
@@ -35,7 +30,7 @@ async function getAccessToken(appUrl) {
         const data = await readFile(DOC_SMITH_ENV_FILE, "utf8");
         if (data.includes("DOC_DISCUSS_KIT_ACCESS_TOKEN")) {
           const envs = parse(data);
-          if (envs[hostname] && envs[hostname].DOC_DISCUSS_KIT_ACCESS_TOKEN) {
+          if (envs[hostname]?.DOC_DISCUSS_KIT_ACCESS_TOKEN) {
             accessToken = envs[hostname].DOC_DISCUSS_KIT_ACCESS_TOKEN;
           }
         }
@@ -48,10 +43,7 @@ async function getAccessToken(appUrl) {
   // If still no access token, prompt user to authorize
   if (!accessToken) {
     const DISCUSS_KIT_URL = appUrl;
-    const connectUrl = joinURL(
-      new URL(DISCUSS_KIT_URL).origin,
-      WELLKNOWN_SERVICE_PATH_PREFIX
-    );
+    const connectUrl = joinURL(new URL(DISCUSS_KIT_URL).origin, WELLKNOWN_SERVICE_PATH_PREFIX);
 
     try {
       const result = await createConnect({
@@ -60,8 +52,7 @@ async function getAccessToken(appUrl) {
         source: `AIGNE DocSmith connect to Discuss Kit`,
         closeOnSuccess: true,
         appName: "AIGNE DocSmith",
-        appLogo:
-          "https://www.aigne.io/image-bin/uploads/a7910a71364ee15a27e86f869ad59009.svg",
+        appLogo: "https://www.aigne.io/image-bin/uploads/a7910a71364ee15a27e86f869ad59009.svg",
         openPage: (pageUrl) => open(pageUrl),
       });
 
@@ -86,12 +77,12 @@ async function getAccessToken(appUrl) {
             DOC_DISCUSS_KIT_ACCESS_TOKEN: accessToken,
             DOC_DISCUSS_KIT_URL: DISCUSS_KIT_URL,
           },
-        })
+        }),
       );
     } catch (error) {
       console.error("Failed to get access token:", error);
       throw new Error(
-        "Failed to obtain access token. Please check your network connection and try again later."
+        "Failed to obtain access token. Please check your network connection and try again later.",
       );
     }
   }
@@ -101,7 +92,7 @@ async function getAccessToken(appUrl) {
 
 export default async function publishDocs(
   { docsDir, appUrl, boardId, projectName, projectDesc, projectLogo },
-  options
+  options,
 ) {
   // Check if DOC_DISCUSS_KIT_URL is set in environment variables
   const envAppUrl = process.env.DOC_DISCUSS_KIT_URL;
@@ -115,7 +106,7 @@ export default async function publishDocs(
   // Check if appUrl is default and not saved in config (only when not using env variable)
   const config = await loadConfigFromFile();
   const isDefaultAppUrl = appUrl === DEFAULT_APP_URL;
-  const hasAppUrlInConfig = config && config.appUrl;
+  const hasAppUrlInConfig = config?.appUrl;
 
   if (!useEnvAppUrl && isDefaultAppUrl && !hasAppUrlInConfig) {
     const choice = await options.prompts.select({
@@ -161,11 +152,7 @@ export default async function publishDocs(
   };
 
   try {
-    const {
-      success,
-      boardId: newBoardId,
-      docsUrl,
-    } = await publishDocsFn({
+    const { success, boardId: newBoardId } = await publishDocsFn({
       sidebarPath,
       accessToken,
       appUrl,
@@ -189,7 +176,7 @@ export default async function publishDocs(
         await saveValueToConfig(
           "boardId",
           newBoardId,
-          "⚠️ Warning: boardId is auto-generated by system, please do not edit manually"
+          "⚠️ Warning: boardId is auto-generated by system, please do not edit manually",
         );
       }
     }

package/agents/save-docs.mjs

@@ -1,7 +1,7 @@
-import { writeFile, readdir, unlink } from "node:fs/promises";
+import { readdir, unlink, writeFile } from "node:fs/promises";
 import { join } from "node:path";
-import { getCurrentGitHead, saveGitHeadToConfig } from "../utils/utils.mjs";
 import { shutdownMermaidWorkerPool } from "../utils/mermaid-worker-pool.mjs";
+import { getCurrentGitHead, saveGitHeadToConfig } from "../utils/utils.mjs";
 
 /**
  * @param {Object} params
@@ -17,7 +17,7 @@ export default async function saveDocs({
   locale,
   projectInfoMessage,
 }) {
-  const results = [];
+  const _results = [];
   // Save current git HEAD to config.yaml for change detection
   try {
     const gitHead = getCurrentGitHead();
@@ -37,12 +37,7 @@ export default async function saveDocs({
 
   // Clean up invalid .md files that are no longer in the structure plan
   try {
-    await cleanupInvalidFiles(
-      structurePlan,
-      docsDir,
-      translateLanguages,
-      locale
-    );
+    await cleanupInvalidFiles(structurePlan, docsDir, translateLanguages, locale);
   } catch (err) {
     console.error("Failed to cleanup invalid .md files:", err.message);
   }
@@ -112,12 +107,7 @@ function generateFileName(flatName, language) {
  * @param {string} locale - Main language locale (e.g., 'en', 'zh', 'fr')
  * @returns {Promise<Array<{ path: string, success: boolean, error?: string }>>}
  */
-async function cleanupInvalidFiles(
-  structurePlan,
-  docsDir,
-  translateLanguages,
-  locale
-) {
+async function cleanupInvalidFiles(structurePlan, docsDir, translateLanguages, locale) {
   const results = [];
 
   try {
@@ -145,7 +135,7 @@ async function cleanupInvalidFiles(
 
     // Find files to delete (files that are not in expectedFiles and not _sidebar.md)
     const filesToDelete = mdFiles.filter(
-      (file) => !expectedFiles.has(file) && file !== "_sidebar.md"
+      (file) => !expectedFiles.has(file) && file !== "_sidebar.md",
     );
 
     // Delete invalid files
@@ -168,9 +158,7 @@ async function cleanupInvalidFiles(
     }
 
     if (filesToDelete.length > 0) {
-      console.log(
-        `Cleaned up ${filesToDelete.length} invalid .md files from ${docsDir}`
-      );
+      console.log(`Cleaned up ${filesToDelete.length} invalid .md files from ${docsDir}`);
     }
   } catch (err) {
     // If docsDir doesn't exist or can't be read, that's okay
@@ -209,7 +197,7 @@ function generateSidebar(structurePlan) {
     for (const key of Object.keys(node)) {
       const item = node[key];
       const fullSegments = [...parentSegments, key];
-      const flatFile = fullSegments.join("-") + ".md";
+      const flatFile = `${fullSegments.join("-")}.md`;
       if (item.__title) {
         const realIndent = item.__parentId === null ? "" : indent;
         out += `${realIndent}* [${item.__title}](/${flatFile})\n`;

package/agents/save-output.mjs

@@ -1,12 +1,7 @@
 import { promises as fs } from "node:fs";
 import { join } from "node:path";
 
-export default async function saveOutput({
-  savePath,
-  fileName,
-  saveKey,
-  ...rest
-}) {
+export default async function saveOutput({ savePath, fileName, saveKey, ...rest }) {
   if (!(saveKey in rest)) {
     console.warn(`saveKey "${saveKey}" not found in input, skip saving.`);
     return {
@@ -17,9 +12,7 @@ export default async function saveOutput({
 
   const value = rest[saveKey];
   const content =
-    typeof value === "object" && value !== null
-      ? JSON.stringify(value, null, 2)
-      : String(value);
+    typeof value === "object" && value !== null ? JSON.stringify(value, null, 2) : String(value);
   await fs.mkdir(savePath, { recursive: true });
   const filePath = join(savePath, fileName);
   await fs.writeFile(filePath, content, "utf8");

package/agents/save-single-doc.mjs

@@ -1,5 +1,5 @@
-import { saveDocWithTranslations } from "../utils/utils.mjs";
 import { shutdownMermaidWorkerPool } from "../utils/mermaid-worker-pool.mjs";
+import { saveDocWithTranslations } from "../utils/utils.mjs";
 
 export default async function saveSingleDoc({
   path,
@@ -11,7 +11,7 @@ export default async function saveSingleDoc({
   isTranslate = false,
   isShowMessage = false,
 }) {
-  const results = await saveDocWithTranslations({
+  const _results = await saveDocWithTranslations({
     path,
     content,
     docsDir,

package/agents/schema/structure-plan.yaml

@@ -8,7 +8,7 @@ items:
       type: string
     path:
       type: string
-      description: 路径，以 RUL 的格式返回，不能为空, 必须以 / 开头，不需要包含语言层级，比如 /zh/about 直接返回 /about
+      description: 路径，以 RUL 的格式返回，不能为空, 不能包含空格等特殊字符, 必须以 / 开头，不需要包含语言层级，比如 /zh/about 直接返回 /about
     parentId:
       type:
         - string

package/agents/transform-detail-datasources.mjs

@@ -1,15 +1,12 @@
 import { normalizePath, toRelativePath } from "../utils/utils.mjs";
 
-export default function transformDetailDatasources({
-  sourceIds,
-  datasourcesList,
-}) {
+export default function transformDetailDatasources({ sourceIds, datasourcesList }) {
   // Build a map for fast lookup, with path normalization for compatibility
   const dsMap = Object.fromEntries(
     (datasourcesList || []).map((ds) => {
       const normalizedSourceId = normalizePath(ds.sourceId);
       return [normalizedSourceId, ds.content];
-    })
+    }),
   );
 
   // Collect formatted contents in order, with path normalization

package/biome.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://biomejs.dev/schemas/2.1.2/schema.json",
+  "$schema": "https://biomejs.dev/schemas/2.1.4/schema.json",
   "vcs": {
     "enabled": true,
     "clientKind": "git",
@@ -23,11 +23,21 @@
         "noUnusedVariables": "error",
         "noUnusedImports": "error",
         "noUnusedFunctionParameters": "error",
-        "noUnusedPrivateClassMembers": "error"
+        "noUnusedPrivateClassMembers": "error",
+        "noUndeclaredVariables": "error",
+        "noUnreachable": "error",
+        "noSelfAssign": "error"
       },
       "suspicious": {
         "noConfusingVoidType": "off",
-        "noExplicitAny": "off"
+        "noExplicitAny": "off",
+        "noDoubleEquals": "error",
+        "noGlobalAssign": "error",
+        "noAssignInExpressions": "warn"
+      },
+      "style": {
+        "useNodejsImportProtocol": "error",
+        "useTemplate": "error"
       },
       "complexity": {
         "noForEach": "off",

package/docs-mcp/get-docs-structure.mjs

@@ -5,7 +5,7 @@ const structureDir = path.join(
   process.cwd(),
   "./.aigne/doc-smith",
   "output",
-  "structure-plan.json"
+  "structure-plan.json",
 );
 
 export default async function getDocsStructure() {

package/docs-mcp/read-doc-content.mjs

@@ -3,10 +3,7 @@ import path from "node:path";
 
 const docsDir = path.join(process.cwd(), "./.aigne/doc-smith", "docs");
 
-export default async function readDocContent({
-  relevantDocPaths,
-  docsDir: customDocsDir,
-}) {
+export default async function readDocContent({ relevantDocPaths, docsDir: customDocsDir }) {
   const targetDocsDir = customDocsDir || docsDir;
   const docContents = [];
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aigne/doc-smith",
-  "version": "0.2.6",
+  "version": "0.2.9",
   "description": "",
   "publishConfig": {
     "access": "public"
@@ -12,11 +12,12 @@
   "author": "Arcblock <blocklet@arcblock.io> https://github.com/blocklet",
   "license": "MIT",
   "dependencies": {
-    "@aigne/anthropic": "^0.10.13",
-    "@aigne/cli": "^1.33.1",
-    "@aigne/core": "^1.48.0",
-    "@aigne/gemini": "^0.8.17",
-    "@aigne/openai": "^0.10.17",
+    "@aigne/aigne-hub": "^0.4.9",
+    "@aigne/anthropic": "^0.11.0",
+    "@aigne/cli": "^1.34.0",
+    "@aigne/core": "^1.49.0",
+    "@aigne/gemini": "^0.9.0",
+    "@aigne/openai": "^0.11.0",
     "@aigne/publish-docs": "^0.5.4",
     "chalk": "^5.5.0",
     "dompurify": "^3.2.6",
@@ -34,6 +35,9 @@
     "vfile": "^6.0.3",
     "yaml": "^2.8.0"
   },
+  "devDependencies": {
+    "@biomejs/biome": "^2.1.4"
+  },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "lint": "biome check && pnpm -r run lint",

package/tests/check-detail-result.test.mjs

@@ -23,28 +23,21 @@ async function runTests() {
     const content = "This contains a [dead link](/dead-link).";
     const result = await checkDetailResult({ structurePlan, content });
     assert(result.isApproved === false, "Should not be approved");
-    assert(
-      result.detailFeedback.includes("Found a dead link"),
-      "Should report dead link"
-    );
+    assert(result.detailFeedback.includes("Found a dead link"), "Should report dead link");
     console.log("✅ Test passed: should reject content with a dead link");
   }
 
   async function testRejectIncorrectTableSeparator() {
-    console.log(
-      "Testing: should reject content with incorrect table separator"
-    );
+    console.log("Testing: should reject content with incorrect table separator");
     const structurePlan = [];
     const content = "| Header | Header |\n| - | - |\n| Cell | Cell |";
     const result = await checkDetailResult({ structurePlan, content });
     assert(result.isApproved === false, "Should not be approved");
     assert(
       result.detailFeedback.includes("incorrect table separator"),
-      "Should report incorrect table separator"
-    );
-    console.log(
-      "✅ Test passed: should reject content with incorrect table separator"
+      "Should report incorrect table separator",
     );
+    console.log("✅ Test passed: should reject content with incorrect table separator");
   }
 
   async function testApproveExternalLink() {
@@ -60,17 +53,13 @@ async function runTests() {
   async function testRejectMultipleIssues() {
     console.log("Testing: should reject content with multiple issues");
     const structurePlan = [{ path: "/getting-started" }];
-    const content =
-      "This has a [dead link](/dead-link) and an incorrect table: | - |.";
+    const content = "This has a [dead link](/dead-link) and an incorrect table: | - |.";
     const result = await checkDetailResult({ structurePlan, content });
     assert(result.isApproved === false, "Should not be approved");
-    assert(
-      result.detailFeedback.includes("Found a dead link"),
-      "Should report dead link"
-    );
+    assert(result.detailFeedback.includes("Found a dead link"), "Should report dead link");
     assert(
       result.detailFeedback.includes("incorrect table separator"),
-      "Should report incorrect table separator"
+      "Should report incorrect table separator",
     );
     console.log("✅ Test passed: should reject content with multiple issues");
   }
@@ -100,4 +89,4 @@ async function runTests() {
   }
 }
 
-runTests();
+runTests();