@aigne/doc-smith 0.2.8 → 0.2.10

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.2.10](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.2.9...v0.2.10) (2025-08-14)
+
+
+### Bug Fixes
+
+* fix bug bush feedback ([#41](https://github.com/AIGNE-io/aigne-doc-smith/issues/41)) ([2740d1a](https://github.com/AIGNE-io/aigne-doc-smith/commit/2740d1abef70ea36780b030917a6d54f74df4327))
+
+## [0.2.9](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.2.8...v0.2.9) (2025-08-13)
+
+
+### Bug Fixes
+
+* polish ignore check ([#25](https://github.com/AIGNE-io/aigne-doc-smith/issues/25)) ([90bc866](https://github.com/AIGNE-io/aigne-doc-smith/commit/90bc866513fef7b47047b1016e07bf38881c101c))
+
 ## [0.2.8](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.2.7...v0.2.8) (2025-08-13)
 
 

package/agents/check-detail.mjs

@@ -16,7 +16,6 @@ export default async function checkDetail(
     originalStructurePlan,
     structurePlan,
     modifiedFiles,
-    lastGitHead,
     forceRegenerate,
     ...rest
   },
@@ -80,11 +79,6 @@ export default async function checkDetail(
     }
   }
 
-  // If lastGitHead is not set, regenerate
-  if (!lastGitHead) {
-    sourceFilesChanged = true;
-  }
-
   // If file exists, check content validation
   let contentValidationFailed = false;
   if (detailGenerated && fileContent && structurePlan) {

package/agents/check-structure-plan.mjs

@@ -1,3 +1,5 @@
+import { access } from "node:fs/promises";
+import { join } from "node:path";
 import {
   getCurrentGitHead,
   getProjectInfo,
@@ -7,7 +9,7 @@ import {
 } from "../utils/utils.mjs";
 
 export default async function checkStructurePlan(
-  { originalStructurePlan, feedback, lastGitHead, ...rest },
+  { originalStructurePlan, feedback, lastGitHead, docsDir, forceRegenerate, ...rest },
   options,
 ) {
   // Check if we need to regenerate structure plan
@@ -16,9 +18,18 @@ export default async function checkStructurePlan(
 
   // If no feedback and originalStructurePlan exists, check for git changes
   if (originalStructurePlan) {
-    // If no lastGitHead, regenerate by default
+    // If no lastGitHead, check if _sidebar.md exists to determine if we should regenerate
     if (!lastGitHead) {
-      shouldRegenerate = true;
+      try {
+        // Check if _sidebar.md exists in docsDir
+        const sidebarPath = join(docsDir, "_sidebar.md");
+        await access(sidebarPath);
+        // If _sidebar.md exists, it means last execution was completed, need to regenerate
+        shouldRegenerate = true;
+      } catch {
+        // If _sidebar.md doesn't exist, it means last execution was interrupted, no need to regenerate
+        shouldRegenerate = false;
+      }
     } else {
       // Check if there are relevant file changes since last generation
       const currentGitHead = getCurrentGitHead();
@@ -43,6 +54,16 @@ export default async function checkStructurePlan(
     }
   }
 
+  // user requested regeneration
+  if (forceRegenerate) {
+    shouldRegenerate = true;
+    finalFeedback = `
+    ${finalFeedback || ""}
+
+    用户请求强制重新生成结构规划，请根据最新的 Data Sources 和用户要求重生生成，**允许任何修改**。
+    `;
+  }
+
   // If no regeneration needed, return original structure plan
   if (originalStructurePlan && !feedback && !shouldRegenerate) {
     return {

package/agents/find-item-by-path.mjs

@@ -8,15 +8,8 @@ function getActionText(isTranslate, baseText) {
 }
 
 export default async function findItemByPath(
-  {
-    "doc-path": docPath,
-    structurePlanResult,
-    boardId,
-    docsDir,
-    isTranslate,
-    feedback,
-  },
-  options
+  { "doc-path": docPath, structurePlanResult, boardId, docsDir, isTranslate, feedback },
+  options,
 ) {
   let foundItem = null;
   let selectedFileContent = null;
@@ -30,9 +23,7 @@ export default async function findItemByPath(
       // Filter for main language .md files (exclude _sidebar.md and language-specific files)
       const mainLanguageFiles = files.filter(
         (file) =>
-          file.endsWith(".md") &&
-          file !== "_sidebar.md" &&
-          !file.match(/\.\w+(-\w+)?\.md$/) // Exclude language-specific files like .en.md, .zh-CN.md, etc.
+          file.endsWith(".md") && file !== "_sidebar.md" && !file.match(/\.\w+(-\w+)?\.md$/), // Exclude language-specific files like .en.md, .zh-CN.md, etc.
       );
 
       if (mainLanguageFiles.length === 0) {
@@ -52,7 +43,7 @@ export default async function findItemByPath(
 
           const searchTerm = input.trim().toLowerCase();
           const filteredFiles = mainLanguageFiles.filter((file) =>
-            file.toLowerCase().includes(searchTerm)
+            file.toLowerCase().includes(searchTerm),
           );
 
           return filteredFiles.map((file) => ({
@@ -71,10 +62,7 @@ export default async function findItemByPath(
         const selectedFilePath = join(docsDir, selectedFile);
         selectedFileContent = await readFile(selectedFilePath, "utf-8");
       } catch (readError) {
-        console.warn(
-          `⚠️  Could not read content from ${selectedFile}:`,
-          readError.message
-        );
+        console.warn(`⚠️  Could not read content from ${selectedFile}:`, readError.message);
         selectedFileContent = null;
       }
 
@@ -87,9 +75,7 @@ export default async function findItemByPath(
 
       // First try without boardId prefix
       foundItemByFile = structurePlanResult.find((item) => {
-        const itemFlattenedPath = item.path
-          .replace(/^\//, "")
-          .replace(/\//g, "-");
+        const itemFlattenedPath = item.path.replace(/^\//, "").replace(/\//g, "-");
         return itemFlattenedPath === flatName;
       });
       if (!foundItemByFile) {
@@ -102,8 +88,8 @@ export default async function findItemByPath(
       throw new Error(
         getActionText(
           isTranslate,
-          "Please provide a doc-path parameter to specify which document to {action}"
-        )
+          "Please provide a doc-path parameter to specify which document to {action}",
+        ),
       );
     }
   }
@@ -121,18 +107,14 @@ export default async function findItemByPath(
       // Find item by comparing flattened paths
       foundItem = structurePlanResult.find((item) => {
         // Convert item.path to flattened format (replace / with -)
-        const itemFlattenedPath = item.path
-          .replace(/^\//, "")
-          .replace(/\//g, "-");
+        const itemFlattenedPath = item.path.replace(/^\//, "").replace(/\//g, "-");
         return itemFlattenedPath === flattenedPath;
       });
     }
   }
 
   if (!foundItem) {
-    throw new Error(
-      `Item with path "${docPath}" not found in structurePlanResult`
-    );
+    throw new Error(`Item with path "${docPath}" not found in structurePlanResult`);
   }
 
   // Prompt for feedback if not provided
@@ -140,7 +122,7 @@ export default async function findItemByPath(
   if (!userFeedback) {
     const feedbackMessage = getActionText(
       isTranslate,
-      "Please provide feedback for the {action} (press Enter to skip):"
+      "Please provide feedback for the {action} (press Enter to skip):",
     );
 
     userFeedback = await options.prompts.input({

package/agents/input-generator.mjs

@@ -1,16 +1,8 @@
 import { mkdir, readFile, writeFile } from "node:fs/promises";
 import { dirname, join } from "node:path";
 import chalk from "chalk";
-import {
-  DOCUMENT_STYLES,
-  SUPPORTED_LANGUAGES,
-  TARGET_AUDIENCES,
-} from "../utils/constants.mjs";
-import {
-  getAvailablePaths,
-  getProjectInfo,
-  validatePath,
-} from "../utils/utils.mjs";
+import { DOCUMENT_STYLES, SUPPORTED_LANGUAGES, TARGET_AUDIENCES } from "../utils/constants.mjs";
+import { getAvailablePaths, getProjectInfo, validatePath } from "../utils/utils.mjs";
 
 // UI constants
 const _PRESS_ENTER_TO_FINISH = "Press Enter to finish";
@@ -23,12 +15,8 @@ const _PRESS_ENTER_TO_FINISH = "Press Enter to finish";
  * @returns {Promise<Object>}
  */
 export default async function init(
-  {
-    outputPath = ".aigne/doc-smith",
-    fileName = "config.yaml",
-    skipIfExists = false,
-  },
-  options
+  { outputPath = ".aigne/doc-smith", fileName = "config.yaml", skipIfExists = false },
+  options,
 ) {
   if (skipIfExists) {
     const filePath = join(outputPath, fileName);
@@ -104,7 +92,7 @@ export default async function init(
   // 4. Translation languages
   // Filter out the primary language from available choices
   const availableTranslationLanguages = SUPPORTED_LANGUAGES.filter(
-    (lang) => lang.code !== primaryLanguageChoice
+    (lang) => lang.code !== primaryLanguageChoice,
   );
 
   const translateLanguageChoices = await options.prompts.checkbox({
@@ -154,11 +142,7 @@ export default async function init(
     });
 
     // Check if user chose to exit
-    if (
-      !selectedPath ||
-      selectedPath.trim() === "" ||
-      selectedPath === "Press Enter to finish"
-    ) {
+    if (!selectedPath || selectedPath.trim() === "" || selectedPath === "Press Enter to finish") {
       break;
     }
 
@@ -207,13 +191,9 @@ export default async function init(
     console.log(chalk.cyan("---"));
     console.log(chalk.cyan(yamlContent));
     console.log(chalk.cyan("---"));
+    console.log("💡 You can edit the configuration file anytime to modify settings.\n");
     console.log(
-      "💡 You can edit the configuration file anytime to modify settings.\n"
-    );
-    console.log(
-      `🚀 Run ${chalk.cyan(
-        "'aigne doc generate'"
-      )} to start documentation generation!\n`
+      `🚀 Run ${chalk.cyan("'aigne doc generate'")} to start documentation generation!\n`,
     );
 
     return {};
@@ -284,5 +264,4 @@ function generateYAML(input) {
   return yaml;
 }
 
-init.description =
-  "Generate a configuration file for the documentation generation process";
+init.description = "Generate a configuration file for the documentation generation process";

package/agents/load-config.mjs

@@ -2,7 +2,7 @@ import fs from "node:fs/promises";
 import path from "node:path";
 import { parse } from "yaml";
 
-export default async function loadConfig({ config }) {
+export default async function loadConfig({ config, appUrl }) {
   const configPath = path.join(process.cwd(), config);
 
   try {
@@ -18,6 +18,11 @@ export default async function loadConfig({ config }) {
     // Read and parse YAML file
     const configContent = await fs.readFile(configPath, "utf-8");
     const parsedConfig = parse(configContent);
+
+    if (appUrl) {
+      parsedConfig.appUrl = appUrl;
+    }
+
     return {
       nodeName: "Section",
       locale: "en",
@@ -40,5 +45,9 @@ loadConfig.input_schema = {
       type: "string",
       default: "./.aigne/doc-smith/config.yaml",
     },
+    appUrl: {
+      type: "string",
+      description: "Application URL to override config",
+    },
   },
 };

package/agents/load-sources.mjs

@@ -1,87 +1,9 @@
 import { access, readFile, stat } from "node:fs/promises";
 import path from "node:path";
-import { glob } from "glob";
 import { DEFAULT_EXCLUDE_PATTERNS, DEFAULT_INCLUDE_PATTERNS } from "../utils/constants.mjs";
+import { getFilesWithGlob, loadGitignore } from "../utils/file-utils.mjs";
 import { getCurrentGitHead, getModifiedFilesBetweenCommits } from "../utils/utils.mjs";
 
-/**
- * Load .gitignore patterns from a directory
- * @param {string} dir - Directory path
- * @returns {object|null} Ignore instance or null if no .gitignore found
- */
-async function loadGitignore(dir) {
-  const gitignorePath = path.join(dir, ".gitignore");
-  try {
-    await access(gitignorePath);
-    const gitignoreContent = await readFile(gitignorePath, "utf8");
-    // Create ignore patterns from .gitignore content
-    const ignorePatterns = gitignoreContent
-      .split("\n")
-      .map((line) => line.trim())
-      .filter((line) => line && !line.startsWith("#"))
-      .map((line) => line.replace(/^\//, "")); // Remove leading slash
-
-    return ignorePatterns.length > 0 ? ignorePatterns : null;
-  } catch {
-    // .gitignore file doesn't exist
-    return null;
-  }
-}
-
-/**
- * Get files using glob patterns
- * @param {string} dir - Directory to search
- * @param {string[]} includePatterns - Include patterns
- * @param {string[]} excludePatterns - Exclude patterns
- * @param {string[]} gitignorePatterns - .gitignore patterns
- * @returns {Promise<string[]>} Array of file paths
- */
-async function getFilesWithGlob(dir, includePatterns, excludePatterns, gitignorePatterns) {
-  // Prepare all ignore patterns
-  const allIgnorePatterns = [];
-
-  if (excludePatterns) {
-    allIgnorePatterns.push(...excludePatterns);
-  }
-
-  if (gitignorePatterns) {
-    allIgnorePatterns.push(...gitignorePatterns);
-  }
-
-  // Add default exclusions if not already present
-  const defaultExclusions = ["node_modules/**", "test/**", "temp/**"];
-  for (const exclusion of defaultExclusions) {
-    if (!allIgnorePatterns.includes(exclusion)) {
-      allIgnorePatterns.push(exclusion);
-    }
-  }
-
-  // Convert patterns to be relative to the directory
-  const patterns = includePatterns.map((pattern) => {
-    // If pattern doesn't start with / or **, make it relative to dir
-    if (!pattern.startsWith("/") && !pattern.startsWith("**")) {
-      return `**/${pattern}`; // Use ** to search recursively
-    }
-    return pattern;
-  });
-
-  try {
-    const files = await glob(patterns, {
-      cwd: dir,
-      ignore: allIgnorePatterns.length > 0 ? allIgnorePatterns : undefined,
-      absolute: true,
-      nodir: true, // Only return files, not directories
-      dot: false, // Don't include dot files by default
-      gitignore: true, // Enable .gitignore support
-    });
-
-    return files;
-  } catch (error) {
-    console.warn(`Warning: Error during glob search in ${dir}: ${error.message}`);
-    return [];
-  }
-}
-
 export default async function loadSources({
   sources = [],
   sourcesPath = [],
@@ -242,6 +164,21 @@ export default async function loadSources({
     }
   }
 
+  // Count words and lines in allSources
+  let totalWords = 0;
+  let totalLines = 0;
+
+  for (const source of Object.values(allSources)) {
+    if (typeof source === "string") {
+      // Count English words (simple regex for words containing a-zA-Z)
+      const words = source.match(/[a-zA-Z]+/g) || [];
+      totalWords += words.length;
+
+      // Count lines (excluding empty lines)
+      totalLines += source.split("\n").filter((line) => line.trim() !== "").length;
+    }
+  }
+
   return {
     datasourcesList: sourceFiles,
     datasources: allSources,
@@ -249,6 +186,8 @@ export default async function loadSources({
     originalStructurePlan,
     files,
     modifiedFiles,
+    totalWords,
+    totalLines,
   };
 }
 

package/agents/publish-docs.mjs

@@ -1,106 +1,13 @@
-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 { getAccessToken } from "../utils/auth-utils.mjs";
 import { loadConfigFromFile, saveValueToConfig } from "../utils/utils.mjs";
 
-const WELLKNOWN_SERVICE_PATH_PREFIX = "/.well-known/service";
 const DEFAULT_APP_URL = "https://docsmith.aigne.io";
 
-/**
- * Get access token from environment, config file, or prompt user for authorization
- * @param {string} appUrl - The application URL
- * @returns {Promise<string>} - The access token
- */
-async function getAccessToken(appUrl) {
-  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;
-
-  // Check if access token exists in environment or config file
-  if (!accessToken) {
-    try {
-      if (existsSync(DOC_SMITH_ENV_FILE)) {
-        const data = await readFile(DOC_SMITH_ENV_FILE, "utf8");
-        if (data.includes("DOC_DISCUSS_KIT_ACCESS_TOKEN")) {
-          const envs = parse(data);
-          if (envs[hostname]?.DOC_DISCUSS_KIT_ACCESS_TOKEN) {
-            accessToken = envs[hostname].DOC_DISCUSS_KIT_ACCESS_TOKEN;
-          }
-        }
-      }
-    } catch (error) {
-      console.warn("Failed to read config file:", error.message);
-    }
-  }
-
-  // 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
-    );
-
-    try {
-      const result = await createConnect({
-        connectUrl: connectUrl,
-        connectAction: "gen-simple-access-key",
-        source: `AIGNE DocSmith connect to Discuss Kit`,
-        closeOnSuccess: true,
-        appName: "AIGNE DocSmith",
-        appLogo:
-          "https://www.aigne.io/image-bin/uploads/a7910a71364ee15a27e86f869ad59009.svg",
-        openPage: (pageUrl) => open(pageUrl),
-      });
-
-      accessToken = result.accessKeySecret;
-      process.env.DOC_DISCUSS_KIT_ACCESS_TOKEN = accessToken;
-
-      // Save the access token to config file
-      const aigneDir = join(homedir(), ".aigne");
-      if (!existsSync(aigneDir)) {
-        mkdirSync(aigneDir, { recursive: true });
-      }
-
-      const existingConfig = existsSync(DOC_SMITH_ENV_FILE)
-        ? parse(await readFile(DOC_SMITH_ENV_FILE, "utf8"))
-        : {};
-
-      await writeFile(
-        DOC_SMITH_ENV_FILE,
-        stringify({
-          ...existingConfig,
-          [hostname]: {
-            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."
-      );
-    }
-  }
-
-  return accessToken;
-}
-
 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;
@@ -184,7 +91,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/team-publish-docs.yaml

@@ -10,10 +10,9 @@ skills:
       skipIfExists: true
   - load-config.mjs
   - publish-docs.mjs
-# input_schema:
-#   type: object
-#   properties:
-#     config:
-#       type: string
-#       description: Path to the config file
-#       default: ./.aigne/doc-smith/config.yaml
+input_schema:
+  type: object
+  properties:
+    appUrl: 
+      type: string
+      description: target website URL where the documentation will be published

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aigne/doc-smith",
-  "version": "0.2.8",
+  "version": "0.2.10",
   "description": "",
   "publishConfig": {
     "access": "public"

package/utils/auth-utils.mjs

@@ -0,0 +1,105 @@
+import { existsSync, mkdirSync } from "node:fs";
+import { readFile, writeFile } from "node:fs/promises";
+import { homedir } from "node:os";
+import { join } from "node:path";
+import { createConnect } from "@aigne/aigne-hub";
+import open from "open";
+import { joinURL } from "ufo";
+import { parse, stringify } from "yaml";
+import { getComponentMountPoint } from "./blocklet.mjs";
+import { DISCUSS_KIT_DID } from "./constants.mjs";
+
+const WELLKNOWN_SERVICE_PATH_PREFIX = "/.well-known/service";
+
+/**
+ * Get access token from environment, config file, or prompt user for authorization
+ * @param {string} appUrl - The application URL
+ * @returns {Promise<string>} - The access token
+ */
+export async function getAccessToken(appUrl) {
+  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;
+
+  // Check if access token exists in environment or config file
+  if (!accessToken) {
+    try {
+      if (existsSync(DOC_SMITH_ENV_FILE)) {
+        const data = await readFile(DOC_SMITH_ENV_FILE, "utf8");
+        if (data.includes("DOC_DISCUSS_KIT_ACCESS_TOKEN")) {
+          const envs = parse(data);
+          if (envs[hostname]?.DOC_DISCUSS_KIT_ACCESS_TOKEN) {
+            accessToken = envs[hostname].DOC_DISCUSS_KIT_ACCESS_TOKEN;
+          }
+        }
+      }
+    } catch (error) {
+      console.warn("Failed to read config file:", error.message);
+    }
+  }
+
+  // If still no access token, prompt user to authorize
+  if (accessToken) {
+    return accessToken;
+  }
+
+  // Check if Discuss Kit is running at the provided URL
+  try {
+    await getComponentMountPoint(appUrl, DISCUSS_KIT_DID);
+  } catch {
+    throw new Error(
+      `Unable to find Discuss Kit running at the provided URL: ${appUrl}\n\n` +
+        "Please ensure that:\n" +
+        "• The URL is correct and accessible\n" +
+        "• Discuss Kit is properly installed and running\n" +
+        "If you continue to experience issues, please verify your Discuss Kit installation.",
+    );
+  }
+
+  const DISCUSS_KIT_URL = appUrl;
+  const connectUrl = joinURL(new URL(DISCUSS_KIT_URL).origin, WELLKNOWN_SERVICE_PATH_PREFIX);
+
+  try {
+    const result = await createConnect({
+      connectUrl: connectUrl,
+      connectAction: "gen-simple-access-key",
+      source: `AIGNE DocSmith connect to Discuss Kit`,
+      closeOnSuccess: true,
+      appName: "AIGNE DocSmith",
+      appLogo: "https://www.aigne.io/image-bin/uploads/a7910a71364ee15a27e86f869ad59009.svg",
+      openPage: (pageUrl) => open(pageUrl),
+    });
+
+    accessToken = result.accessKeySecret;
+    process.env.DOC_DISCUSS_KIT_ACCESS_TOKEN = accessToken;
+
+    // Save the access token to config file
+    const aigneDir = join(homedir(), ".aigne");
+    if (!existsSync(aigneDir)) {
+      mkdirSync(aigneDir, { recursive: true });
+    }
+
+    const existingConfig = existsSync(DOC_SMITH_ENV_FILE)
+      ? parse(await readFile(DOC_SMITH_ENV_FILE, "utf8"))
+      : {};
+
+    await writeFile(
+      DOC_SMITH_ENV_FILE,
+      stringify({
+        ...existingConfig,
+        [hostname]: {
+          DOC_DISCUSS_KIT_ACCESS_TOKEN: accessToken,
+          DOC_DISCUSS_KIT_URL: DISCUSS_KIT_URL,
+        },
+      }),
+    );
+  } catch (error) {
+    console.debug(error);
+    throw new Error(
+      "Failed to obtain access token. Please check your network connection and try again later.",
+    );
+  }
+
+  return accessToken;
+}

package/utils/blocklet.mjs

@@ -0,0 +1,25 @@
+export async function getComponentMountPoint(appUrl, did) {
+  const url = new URL(appUrl);
+  const blockletJsUrl = `${url.origin}/__blocklet__.js?type=json`;
+
+  const blockletJs = await fetch(blockletJsUrl, {
+    method: "GET",
+    headers: {
+      Accept: "application/json",
+    },
+  });
+
+  if (!blockletJs.ok) {
+    throw new Error(
+      `Failed to fetch blocklet json: ${blockletJs.status} ${blockletJs.statusText}, ${blockletJsUrl}`,
+    );
+  }
+
+  const config = await blockletJs.json();
+  const component = config.componentMountPoints.find((component) => component.did === did);
+  if (!component) {
+    throw new Error(`Component ${did} not found in blocklet: ${appUrl}`);
+  }
+
+  return component.mountPoint;
+}

package/utils/constants.mjs

@@ -1,25 +1,89 @@
 // Default file patterns for inclusion and exclusion
 export const DEFAULT_INCLUDE_PATTERNS = [
+  // Python
   "*.py",
+  "*.pyi",
+  "*.pyx",
+  // JavaScript/TypeScript
   "*.js",
   "*.jsx",
   "*.ts",
   "*.tsx",
-  "*.go",
-  "*.java",
-  "*.pyi",
-  "*.pyx",
+  // C/C++
   "*.c",
   "*.cc",
   "*.cpp",
+  "*.cxx",
+  "*.c++",
   "*.h",
+  "*.hpp",
+  "*.hxx",
+  "*.h++",
+  // JVM Languages
+  "*.java",
+  "*.kt",
+  "*.scala",
+  "*.groovy",
+  "*.gvy",
+  "*.gy",
+  "*.gsh",
+  "*.clj",
+  "*.cljs",
+  "*.cljx",
+  // .NET Languages
+  "*.cs",
+  "*.vb",
+  "*.fs",
+  // Functional Languages
+  "*.f",
+  "*.ml",
+  "*.sml",
+  "*.lisp",
+  "*.lsp",
+  "*.cl",
+  // Systems Programming
+  "*.rs",
+  "*.go",
+  "*.nim",
+  "*.asm",
+  "*.s",
+  // Web Technologies
+  "*.html",
+  "*.htm",
+  "*.css",
+  "*.php",
+  // Scripting Languages
+  "*.rb",
+  "*.pl",
+  "*.ps1",
+  "*.lua",
+  "*.tcl",
+  // Mobile/Modern Languages
+  "*.swift",
+  "*.dart",
+  "*.ex",
+  "*.exs",
+  "*.erl",
+  "*.jl",
+  // Data Science
+  "*.r",
+  "*.R",
+  "*.m",
+  // Other Languages
+  "*.pas",
+  "*.cob",
+  "*.cbl",
+  "*.pro",
+  "*.prolog",
+  "*.sql",
+  // Documentation & Config
   "*.md",
   "*.rst",
   "*.json",
-  "*Dockerfile",
-  "*Makefile",
   "*.yaml",
   "*.yml",
+  "*Dockerfile",
+  "*Makefile",
 ];
 
 export const DEFAULT_EXCLUDE_PATTERNS = [
@@ -78,14 +142,14 @@ export const SUPPORTED_LANGUAGES = [
 
 // Predefined document generation styles
 export const DOCUMENT_STYLES = {
-  developerDocs: {
-    name: "Developer Docs",
-    rules: "Steps-first; copy-paste examples; minimal context; active 'you'.",
-  },
   userGuide: {
     name: "User Guide",
     rules: "Scenario-based; step-by-step; plain language; outcomes & cautions.",
   },
+  developerDocs: {
+    name: "Developer Docs",
+    rules: "Steps-first; copy-paste examples; minimal context; active 'you'.",
+  },
   apiReference: {
     name: "API Reference",
     rules: "Exact & skimmable; schema-first; clear params/errors/examples.",
@@ -98,8 +162,11 @@ export const DOCUMENT_STYLES = {
 
 // Predefined target audiences
 export const TARGET_AUDIENCES = {
+  generalUsers: "General Users",
   actionFirst: "Developers, Implementation Engineers, DevOps",
   conceptFirst: "Architects, Technical Leads, Developers interested in principles",
-  generalUsers: "General Users",
   custom: "Enter your own target audience",
 };
+
+// Component mount point ID for Discuss Kit
+export const DISCUSS_KIT_DID = "z8ia1WEiBZ7hxURf6LwH21Wpg99vophFwSJdu";

package/utils/file-utils.mjs

@@ -0,0 +1,205 @@
+import { execSync } from "node:child_process";
+import { access, readFile } from "node:fs/promises";
+import path from "node:path";
+import { glob } from "glob";
+
+/**
+ * Check if a directory is inside a git repository using git command
+ * @param {string} dir - Directory path to check
+ * @returns {boolean} True if inside a git repository
+ */
+function isInGitRepository(dir) {
+  try {
+    execSync("git rev-parse --is-inside-work-tree", {
+      cwd: dir,
+      stdio: "pipe",
+      encoding: "utf8",
+    });
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+/**
+ * Find git repository root directory using git command
+ * @param {string} startDir - Starting directory path
+ * @returns {string|null} Git repository root path or null if not found
+ */
+function findGitRoot(startDir) {
+  try {
+    const gitRoot = execSync("git rev-parse --show-toplevel", {
+      cwd: startDir,
+      stdio: "pipe",
+      encoding: "utf8",
+    }).trim();
+    return gitRoot;
+  } catch {
+    return null;
+  }
+}
+
+/**
+ * Convert gitignore patterns to glob-compatible patterns
+ * @param {string} pattern - A single gitignore pattern
+ * @returns {string[]} Array of glob patterns that match gitignore behavior
+ */
+function gitignoreToGlobPatterns(pattern) {
+  const patterns = [];
+
+  // Remove leading slash (already handled by gitignore parsing)
+  const cleanPattern = pattern.replace(/^\//, "");
+
+  // If pattern doesn't contain wildcards and doesn't end with /
+  // it could match both files and directories
+  if (!cleanPattern.includes("*") && !cleanPattern.includes("?") && !cleanPattern.endsWith("/")) {
+    // Add patterns to match both file and directory
+    patterns.push(cleanPattern); // Exact match
+    patterns.push(`${cleanPattern}/**`); // Directory contents
+    patterns.push(`**/${cleanPattern}`); // Nested exact match
+    patterns.push(`**/${cleanPattern}/**`); // Nested directory contents
+  } else if (cleanPattern.endsWith("/")) {
+    // Directory-only pattern
+    const dirPattern = cleanPattern.slice(0, -1);
+    patterns.push(`${dirPattern}/**`);
+    patterns.push(`**/${dirPattern}/**`);
+  } else {
+    // Pattern with wildcards or specific file
+    patterns.push(cleanPattern);
+    if (!cleanPattern.startsWith("**/")) {
+      patterns.push(`**/${cleanPattern}`);
+    }
+  }
+
+  return patterns;
+}
+
+/**
+ * Parse .gitignore content into patterns
+ * @param {string} content - .gitignore file content
+ * @returns {string[]} Array of ignore patterns converted to glob format
+ */
+function parseGitignoreContent(content) {
+  const lines = content
+    .split("\n")
+    .map((line) => line.trim())
+    .filter((line) => line && !line.startsWith("#"))
+    .map((line) => line.replace(/^\//, "")); // Remove leading slash
+
+  // Convert each gitignore pattern to glob patterns
+  const allPatterns = [];
+  for (const line of lines) {
+    allPatterns.push(...gitignoreToGlobPatterns(line));
+  }
+
+  return [...new Set(allPatterns)]; // Remove duplicates
+}
+
+/**
+ * Load .gitignore patterns from multiple directories (current + all parent directories up to git root)
+ * @param {string} dir - Directory path (will search up to find all .gitignore files)
+ * @returns {string[]|null} Array of merged ignore patterns or null if no .gitignore found
+ */
+export async function loadGitignore(dir) {
+  // First, check if we're in a git repository
+  const inGitRepo = isInGitRepository(dir);
+  if (!inGitRepo) {
+    // Not in a git repository, just check the current directory
+    const gitignorePath = path.join(dir, ".gitignore");
+    try {
+      await access(gitignorePath);
+      const gitignoreContent = await readFile(gitignorePath, "utf8");
+      const ignorePatterns = parseGitignoreContent(gitignoreContent);
+      return ignorePatterns.length > 0 ? ignorePatterns : null;
+    } catch {
+      return null;
+    }
+  }
+
+  // We're in a git repository, collect all .gitignore files from current dir to git root
+  const gitRoot = findGitRoot(dir);
+  if (!gitRoot) {
+    return null;
+  }
+
+  const allPatterns = [];
+  let currentDir = path.resolve(dir);
+
+  // Collect .gitignore patterns from current directory up to git root
+  while (currentDir.startsWith(gitRoot)) {
+    const gitignorePath = path.join(currentDir, ".gitignore");
+    try {
+      await access(gitignorePath);
+      const gitignoreContent = await readFile(gitignorePath, "utf8");
+      const patterns = parseGitignoreContent(gitignoreContent);
+
+      // Add patterns with context of which directory they came from
+      // Patterns from deeper directories take precedence
+      allPatterns.unshift(...patterns);
+    } catch {
+      // .gitignore doesn't exist in this directory, continue
+    }
+
+    // Move up one directory
+    if (currentDir === gitRoot) {
+      break;
+    }
+    currentDir = path.dirname(currentDir);
+  }
+
+  return allPatterns.length > 0 ? [...new Set(allPatterns)] : null;
+}
+
+/**
+ * Get files using glob patterns
+ * @param {string} dir - Directory to search
+ * @param {string[]} includePatterns - Include patterns
+ * @param {string[]} excludePatterns - Exclude patterns
+ * @param {string[]} gitignorePatterns - .gitignore patterns
+ * @returns {Promise<string[]>} Array of file paths
+ */
+export async function getFilesWithGlob(dir, includePatterns, excludePatterns, gitignorePatterns) {
+  // Prepare all ignore patterns
+  const allIgnorePatterns = [];
+
+  if (excludePatterns) {
+    allIgnorePatterns.push(...excludePatterns);
+  }
+
+  if (gitignorePatterns) {
+    allIgnorePatterns.push(...gitignorePatterns);
+  }
+
+  // Add default exclusions if not already present
+  const defaultExclusions = ["node_modules/**", "test/**", "temp/**"];
+  for (const exclusion of defaultExclusions) {
+    if (!allIgnorePatterns.includes(exclusion)) {
+      allIgnorePatterns.push(exclusion);
+    }
+  }
+
+  // Convert patterns to be relative to the directory
+  const patterns = includePatterns.map((pattern) => {
+    // If pattern doesn't start with / or **, make it relative to dir
+    if (!pattern.startsWith("/") && !pattern.startsWith("**")) {
+      return `**/${pattern}`; // Use ** to search recursively
+    }
+    return pattern;
+  });
+
+  try {
+    const files = await glob(patterns, {
+      cwd: dir,
+      ignore: allIgnorePatterns.length > 0 ? allIgnorePatterns : undefined,
+      absolute: true,
+      nodir: true, // Only return files, not directories
+      dot: false, // Don't include dot files by default
+      gitignore: true, // Enable .gitignore support
+    });
+
+    return files;
+  } catch (error) {
+    console.warn(`Warning: Error during glob search in ${dir}: ${error.message}`);
+    return [];
+  }
+}

package/utils/markdown-checker.mjs

@@ -91,45 +91,34 @@ function checkDeadLinks(markdown, source, allowedLinks, errorMessages) {
 /**
  * Check code block content for indentation consistency issues
  * @param {Array} codeBlockContent - Array of {line, lineNumber} objects from the code block
+ * @param {number} codeBlockIndent - The indentation of the code block start marker (```)
  * @param {string} source - Source description for error reporting
  * @param {Array} errorMessages - Array to push error messages to
  */
-function checkCodeBlockIndentation(codeBlockContent, source, errorMessages) {
+function checkCodeBlockIndentation(codeBlockContent, codeBlockIndent, source, errorMessages) {
   if (codeBlockContent.length === 0) return;
 
-  // Filter out empty lines for base indentation calculation
+  // Filter out empty lines for analysis
   const nonEmptyLines = codeBlockContent.filter((item) => item.line.trim().length > 0);
   if (nonEmptyLines.length === 0) return;
 
-  // Find the base indentation from the first meaningful line
-  let baseCodeIndent = null;
+  // The expected base indentation for code block content should match the code block marker
+  const expectedBaseIndent = codeBlockIndent;
   const problematicLines = [];
 
   for (const item of nonEmptyLines) {
     const { line, lineNumber } = item;
     const match = line.match(/^(\s*)/);
     const currentIndent = match ? match[1].length : 0;
-    const trimmedLine = line.trim();
 
-    // Skip lines that are clearly comments (common pattern: # comment)
-    if (trimmedLine.startsWith("#") && !trimmedLine.includes("=") && !trimmedLine.includes("{")) {
-      continue;
-    }
-
-    // Establish base indentation from the first meaningful line
-    if (baseCodeIndent === null) {
-      baseCodeIndent = currentIndent;
-      continue;
-    }
-
-    // Check if current line has less indentation than the base
+    // Check if current line has less indentation than expected
     // This indicates inconsistent indentation that may cause rendering issues
-    if (currentIndent < baseCodeIndent && baseCodeIndent > 0) {
+    if (currentIndent < expectedBaseIndent && expectedBaseIndent > 0) {
       problematicLines.push({
         lineNumber,
         line: line.trimEnd(),
         currentIndent,
-        baseIndent: baseCodeIndent,
+        expectedIndent: expectedBaseIndent,
       });
     }
   }
@@ -162,7 +151,7 @@ function checkCodeBlockIndentation(codeBlockContent, source, errorMessages) {
           ? `lines ${group[0].lineNumber}-${group[group.length - 1].lineNumber}`
           : `line ${firstIssue.lineNumber}`;
 
-      const issue = `inconsistent indentation: ${firstIssue.currentIndent} spaces (base: ${firstIssue.baseIndent} spaces)`;
+      const issue = `insufficient indentation: ${firstIssue.currentIndent} spaces (expected: ${firstIssue.expectedIndent} spaces)`;
       errorMessages.push(
         `Found code block with inconsistent indentation in ${source} at ${lineNumbers}: ${issue}. This may cause rendering issues`,
       );
@@ -185,6 +174,7 @@ function checkContentStructure(markdown, source, errorMessages) {
   let inAnyCodeBlock = false;
   let anyCodeBlockStartLine = 0;
   let codeBlockContent = [];
+  let codeBlockIndent = 0;
 
   for (let i = 0; i < lines.length; i++) {
     const line = lines[i];
@@ -198,13 +188,17 @@ function checkContentStructure(markdown, source, errorMessages) {
         anyCodeBlockStartLine = lineNumber;
         inCodeBlock = true;
         codeBlockContent = [];
+
+        // Capture the indentation of the code block start marker
+        const match = line.match(/^(\s*)/);
+        codeBlockIndent = match ? match[1].length : 0;
       } else {
         // Ending the code block
         inAnyCodeBlock = false;
 
         if (inCodeBlock) {
           // Check code block content for indentation issues
-          checkCodeBlockIndentation(codeBlockContent, source, errorMessages);
+          checkCodeBlockIndentation(codeBlockContent, codeBlockIndent, source, errorMessages);
           inCodeBlock = false;
         }
       }