@marlinjai/clearify 1.9.0 → 1.10.0

package/dist/node/{chunk-IF6GI4WU.js → chunk-2RAA6477.js}

@@ -6,7 +6,7 @@ import {
   resolveConfig,
   resolveSections,
   scanHubProjects
-} from "./chunk-PQMKRFBQ.js";
+} from "./chunk-PVTUVUBK.js";
 import {
   buildSectionData
 } from "./chunk-QNC5QRIO.js";
@@ -222,7 +222,7 @@ ${routeEntries.join(",\n")}
       const userConfig = await loadUserConfig(userRoot);
       config = resolveConfig(userConfig, userRoot);
       config = await scanHubProjects(config, userRoot);
-      const allSections = resolveSections(config, userRoot);
+      const allSections = await resolveSections(config, userRoot);
       const isDev = resolvedViteConfig.command === "serve";
       visibleSections = isDev ? allSections : allSections.filter((s) => !s.draft);
       await refreshDocs();

package/dist/node/chunk-AJBCHKBP.js

@@ -0,0 +1,105 @@
+// src/core/remote.ts
+import { execSync } from "child_process";
+import { existsSync, mkdirSync } from "fs";
+import { resolve } from "path";
+function repoSlug(repo, ref) {
+  return repo.replace(/^(https?:\/\/|git@)/, "").replace(/\.git$/, "").replace(/[/:@]/g, "-").replace(/-+/g, "-").replace(/^-|-$/g, "") + "--" + ref;
+}
+function isPinnedRef(ref) {
+  return /^[0-9a-f]{40}$/i.test(ref) || /^v?\d+\.\d+/.test(ref);
+}
+async function resolveRemoteSource(source, cacheDir) {
+  const ref = source.ref ?? "main";
+  const slug = repoSlug(source.repo, ref);
+  const localPath = resolve(cacheDir, slug);
+  const sparse = source.sparse !== false;
+  mkdirSync(cacheDir, { recursive: true });
+  if (existsSync(resolve(localPath, ".git"))) {
+    if (!isPinnedRef(ref)) {
+      try {
+        execSync(`git -C ${JSON.stringify(localPath)} fetch origin ${ref} --depth 1`, {
+          stdio: "pipe",
+          timeout: 3e4
+        });
+        execSync(`git -C ${JSON.stringify(localPath)} checkout FETCH_HEAD`, {
+          stdio: "pipe"
+        });
+      } catch (err) {
+        console.warn(
+          `  \u26A0 Failed to update remote "${source.repo}" (ref: ${ref}), using stale cache.`,
+          err instanceof Error ? err.message : ""
+        );
+      }
+    }
+    const commit2 = getHeadCommit(localPath);
+    return { localPath, resolvedCommit: commit2, cached: true };
+  }
+  try {
+    if (sparse && source.path) {
+      execSync(
+        `git clone --no-checkout --depth 1 --branch ${ref} ${source.repo} ${JSON.stringify(localPath)}`,
+        { stdio: "pipe", timeout: 6e4 }
+      );
+      execSync(`git -C ${JSON.stringify(localPath)} sparse-checkout init --cone`, {
+        stdio: "pipe"
+      });
+      execSync(`git -C ${JSON.stringify(localPath)} sparse-checkout set ${source.path}`, {
+        stdio: "pipe"
+      });
+      execSync(`git -C ${JSON.stringify(localPath)} checkout`, { stdio: "pipe" });
+    } else {
+      execSync(
+        `git clone --depth 1 --branch ${ref} ${source.repo} ${JSON.stringify(localPath)}`,
+        { stdio: "pipe", timeout: 6e4 }
+      );
+    }
+  } catch (err) {
+    const msg = err instanceof Error ? err.message : String(err);
+    throw new Error(
+      `Failed to clone remote repo "${source.repo}" (ref: ${ref}): ${msg}`
+    );
+  }
+  const commit = getHeadCommit(localPath);
+  return { localPath, resolvedCommit: commit, cached: false };
+}
+function getHeadCommit(repoPath) {
+  try {
+    return execSync(`git -C ${JSON.stringify(repoPath)} rev-parse HEAD`, {
+      encoding: "utf-8",
+      stdio: "pipe"
+    }).trim();
+  } catch {
+    return "unknown";
+  }
+}
+async function resolveRemoteSections(sections, cacheDir) {
+  const results = [];
+  for (const section of sections) {
+    if (!section.git) {
+      results.push(section);
+      continue;
+    }
+    const { localPath, cached } = await resolveRemoteSource(section.git, cacheDir);
+    const absoluteDocsDir = resolve(localPath, section.docsDir);
+    if (!existsSync(absoluteDocsDir)) {
+      throw new Error(
+        `Remote section "${section.label}": docs directory "${section.docsDir}" not found in cloned repo "${section.git.repo}".`
+      );
+    }
+    console.log(
+      `  Remote section "${section.label}": ${cached ? "cached" : "cloned"} \u2192 ${absoluteDocsDir}`
+    );
+    results.push({
+      ...section,
+      docsDir: absoluteDocsDir,
+      git: void 0
+      // Already resolved — docsDir is now absolute
+    });
+  }
+  return results;
+}
+
+export {
+  resolveRemoteSource,
+  resolveRemoteSections
+};

package/dist/node/{chunk-77VHQV7W.js → chunk-ELRDUSZS.js}

@@ -2,7 +2,7 @@ import {
   loadUserConfig,
   resolveConfig,
   resolveSections
-} from "./chunk-PQMKRFBQ.js";
+} from "./chunk-PVTUVUBK.js";
 import {
   scanDocs
 } from "./chunk-QNC5QRIO.js";
@@ -14,7 +14,7 @@ async function checkLinks() {
   const userRoot = process.cwd();
   const userConfig = await loadUserConfig(userRoot);
   const config = resolveConfig(userConfig, userRoot);
-  const sections = resolveSections(config, userRoot);
+  const sections = await resolveSections(config, userRoot);
   const validRoutes = /* @__PURE__ */ new Set();
   const allDocs = [];
   for (const section of sections) {

package/dist/node/{chunk-PQMKRFBQ.js → chunk-PVTUVUBK.js}

@@ -1,3 +1,7 @@
+import {
+  resolveRemoteSections
+} from "./chunk-AJBCHKBP.js";
+
 // src/core/config.ts
 import { z } from "zod";
 import { resolve, basename, dirname } from "path";
@@ -15,13 +19,20 @@ var NavigationItemSchema = z.lazy(
     children: z.array(NavigationItemSchema).optional()
   })
 );
+var RemoteGitSourceSchema = z.object({
+  repo: z.string(),
+  ref: z.string().optional(),
+  path: z.string().optional(),
+  sparse: z.boolean().optional()
+});
 var SectionConfigSchema = z.object({
   label: z.string(),
   docsDir: z.string(),
   basePath: z.string().optional(),
   draft: z.boolean().optional(),
   sitemap: z.boolean().optional(),
-  exclude: z.array(z.string()).optional()
+  exclude: z.array(z.string()).optional(),
+  git: RemoteGitSourceSchema.optional()
 });
 var MermaidConfigSchema = z.object({
   strategy: z.enum(["client", "build"]).default("client")
@@ -39,7 +50,14 @@ var HubProjectSchema = z.object({
   status: z.enum(["active", "beta", "planned", "deprecated"]).default("active"),
   icon: z.string().optional(),
   tags: z.array(z.string()).optional(),
-  group: z.string().optional()
+  group: z.string().optional(),
+  mode: z.enum(["link", "embed"]).optional(),
+  git: RemoteGitSourceSchema.optional(),
+  embedSections: z.union([
+    z.literal("all"),
+    z.literal("public"),
+    z.array(z.string())
+  ]).optional()
 });
 var HubProjectPartialSchema = z.object({
   description: z.string(),
@@ -54,7 +72,8 @@ var HubProjectPartialSchema = z.object({
 }).optional();
 var HubConfigSchema = z.object({
   projects: z.array(HubProjectSchema).default([]),
-  scan: z.string().optional()
+  scan: z.string().optional(),
+  cacheDir: z.string().optional()
 }).optional();
 var ClearifyConfigSchema = z.object({
   name: z.string().default("Documentation"),
@@ -182,18 +201,25 @@ function resolveConfig(userConfig = {}, root) {
 function slugify(str) {
   return str.toLowerCase().replace(/[^a-z0-9]+/g, "-").replace(/^-|-$/g, "");
 }
-function resolveSections(config, root) {
+async function resolveSections(config, root) {
   if (config.sections && config.sections.length > 0) {
-    const sections = config.sections.map((s, i) => {
+    const hasRemote = config.sections.some((s) => s.git);
+    let resolvedInputs = config.sections;
+    if (hasRemote) {
+      const cacheDir = resolve(root, "node_modules/.cache/clearify-remote");
+      resolvedInputs = await resolveRemoteSections(config.sections, cacheDir);
+    }
+    const sections = resolvedInputs.map((s, i) => {
       const id = slugify(s.label);
       const draft = s.draft ?? false;
       const basePath = s.basePath ?? (i === 0 ? "/" : "/" + id);
       const sitemap = s.sitemap ?? !draft;
       const exclude = [...config.exclude ?? [], ...s.exclude ?? []];
+      const docsDir = s.docsDir.startsWith("/") ? s.docsDir : resolve(root, s.docsDir);
       return {
         id,
         label: s.label,
-        docsDir: resolve(root, s.docsDir),
+        docsDir,
         basePath,
         draft,
         sitemap,
@@ -222,37 +248,82 @@ function resolveSections(config, root) {
   ];
 }
 async function scanHubProjects(config, root) {
-  if (!config.hub?.scan) return config;
-  const { globbySync } = await import("globby");
-  const pattern = config.hub.scan;
-  const configPaths = globbySync(pattern, { cwd: root, absolute: true });
+  if (!config.hub?.scan && !config.hub?.projects?.some((p) => p.mode === "embed")) {
+    return config;
+  }
   const scannedProjects = [];
-  for (const configPath of configPaths) {
-    try {
-      const childConfig = await loadUserConfig(dirname(configPath));
-      if (!childConfig.hubProject) continue;
-      const name = childConfig.name ?? basename(dirname(configPath));
-      const hp = childConfig.hubProject;
-      scannedProjects.push({
-        name,
-        description: hp.description,
-        href: hp.href ?? childConfig.siteUrl,
-        repo: hp.repo,
-        status: hp.status,
-        icon: hp.icon,
-        tags: hp.tags,
-        group: hp.group
-      });
-    } catch {
+  if (config.hub?.scan) {
+    const { globbySync } = await import("globby");
+    const pattern = config.hub.scan;
+    const configPaths = globbySync(pattern, { cwd: root, absolute: true });
+    for (const configPath of configPaths) {
+      try {
+        const childConfig = await loadUserConfig(dirname(configPath));
+        if (!childConfig.hubProject) continue;
+        const name = childConfig.name ?? basename(dirname(configPath));
+        const hp = childConfig.hubProject;
+        scannedProjects.push({
+          name,
+          description: hp.description,
+          href: hp.href ?? childConfig.siteUrl,
+          repo: hp.repo,
+          status: hp.status,
+          icon: hp.icon,
+          tags: hp.tags,
+          group: hp.group
+        });
+      } catch {
+      }
     }
   }
-  const manualNames = new Set((config.hub.projects ?? []).map((p) => p.name));
+  const manualNames = new Set((config.hub?.projects ?? []).map((p) => p.name));
   const merged = [
     ...scannedProjects.filter((p) => !manualNames.has(p.name)),
-    ...config.hub.projects ?? []
+    ...config.hub?.projects ?? []
   ];
+  const embedSections = [];
+  for (const project of merged) {
+    if (project.mode !== "embed" || !project.git) continue;
+    const cacheDir = config.hub?.cacheDir ? resolve(root, config.hub.cacheDir) : resolve(root, "node_modules/.cache/clearify-remote");
+    try {
+      const { resolveRemoteSource } = await import("./core/remote.js");
+      const { localPath } = await resolveRemoteSource(project.git, cacheDir);
+      const remoteConfig = await loadUserConfig(localPath);
+      const remoteSections = remoteConfig.sections ?? [
+        { label: remoteConfig.name ?? project.name, docsDir: remoteConfig.docsDir ?? "./docs" }
+      ];
+      const filter = project.embedSections ?? "public";
+      const filtered = remoteSections.filter((s) => {
+        if (filter === "all") return true;
+        if (filter === "public") return !s.draft;
+        if (Array.isArray(filter)) return filter.includes(s.label);
+        return true;
+      });
+      for (const s of filtered) {
+        const docsDir = s.docsDir.startsWith("/") ? s.docsDir : resolve(localPath, s.docsDir);
+        const label = s.label === "Documentation" ? project.name : s.label;
+        const id = slugify(label);
+        embedSections.push({
+          label,
+          docsDir,
+          basePath: s.basePath ?? "/" + id,
+          draft: s.draft,
+          sitemap: s.sitemap,
+          exclude: s.exclude
+        });
+      }
+      console.log(`  Hub embed "${project.name}": ${filtered.length} sections pulled`);
+    } catch (err) {
+      console.warn(
+        `  \u26A0 Hub embed "${project.name}" failed:`,
+        err instanceof Error ? err.message : err
+      );
+    }
+  }
+  const finalSections = [...config.sections ?? [], ...embedSections];
   return {
     ...config,
+    ...embedSections.length > 0 ? { sections: finalSections } : {},
     hub: {
       ...config.hub,
       projects: merged

package/dist/node/{chunk-GGUDZD4K.js → chunk-ZNURJXMI.js}

@@ -8,12 +8,12 @@ import {
 } from "./chunk-SCZZB7OE.js";
 import {
   clearifyPlugin
-} from "./chunk-IF6GI4WU.js";
+} from "./chunk-2RAA6477.js";
 import {
   loadUserConfig,
   resolveConfig,
   resolveSections
-} from "./chunk-PQMKRFBQ.js";
+} from "./chunk-PVTUVUBK.js";
 import {
   buildSectionData
 } from "./chunk-QNC5QRIO.js";
@@ -140,7 +140,7 @@ async function buildSite() {
   const config = resolveConfig(userConfig);
   const outDir = resolve(userRoot, config.outDir);
   const ssrOutDir = resolve(outDir, ".ssr");
-  const allSections = resolveSections(config, userRoot);
+  const allSections = await resolveSections(config, userRoot);
   const productionSections = allSections.filter((s) => !s.draft);
   const changelogPath = resolve(userRoot, "CHANGELOG.md");
   const sectionDataList = productionSections.map(

package/dist/node/core/config.d.ts

@@ -4,7 +4,7 @@ export { defineConfig } from '../types/index.js';
 declare const defaultConfig: ClearifyConfig;
 declare function loadUserConfig(root: string): Promise<Partial<ClearifyConfig>>;
 declare function resolveConfig(userConfig?: Partial<ClearifyConfig>, root?: string): ClearifyConfig;
-declare function resolveSections(config: ClearifyConfig, root: string): ResolvedSection[];
+declare function resolveSections(config: ClearifyConfig, root: string): Promise<ResolvedSection[]>;
 declare function scanHubProjects(config: ClearifyConfig, root: string): Promise<ClearifyConfig>;
 
 export { defaultConfig, loadUserConfig, resolveConfig, resolveSections, scanHubProjects };

package/dist/node/core/config.js

@@ -4,7 +4,8 @@ import {
   resolveConfig,
   resolveSections,
   scanHubProjects
-} from "../chunk-PQMKRFBQ.js";
+} from "../chunk-PVTUVUBK.js";
+import "../chunk-AJBCHKBP.js";
 import {
   defineConfig
 } from "../chunk-V7LLYIRO.js";

package/dist/node/core/remote.d.ts

@@ -0,0 +1,18 @@
+import { SectionConfig, RemoteGitSource } from '../types/index.js';
+
+interface ResolvedRemote {
+    localPath: string;
+    resolvedCommit: string;
+    cached: boolean;
+}
+/**
+ * Clone or update a git repo into the cache directory.
+ */
+declare function resolveRemoteSource(source: RemoteGitSource, cacheDir: string): Promise<ResolvedRemote>;
+/**
+ * For each section with a `git` source, clone/update the repo and rewrite
+ * `docsDir` to the absolute path inside the cached clone.
+ */
+declare function resolveRemoteSections(sections: SectionConfig[], cacheDir: string): Promise<SectionConfig[]>;
+
+export { resolveRemoteSections, resolveRemoteSource };

package/dist/node/core/remote.js

@@ -0,0 +1,8 @@
+import {
+  resolveRemoteSections,
+  resolveRemoteSource
+} from "../chunk-AJBCHKBP.js";
+export {
+  resolveRemoteSections,
+  resolveRemoteSource
+};

package/dist/node/node/build.js

@@ -1,11 +1,12 @@
 import {
   buildSite
-} from "../chunk-GGUDZD4K.js";
+} from "../chunk-ZNURJXMI.js";
 import "../chunk-PRTER35L.js";
 import "../chunk-SCZZB7OE.js";
-import "../chunk-IF6GI4WU.js";
+import "../chunk-2RAA6477.js";
 import "../chunk-B2Q23JW3.js";
-import "../chunk-PQMKRFBQ.js";
+import "../chunk-PVTUVUBK.js";
+import "../chunk-AJBCHKBP.js";
 import "../chunk-V7LLYIRO.js";
 import "../chunk-QNC5QRIO.js";
 import "../chunk-5TD7NQIW.js";

package/dist/node/node/check.js

@@ -1,7 +1,8 @@
 import {
   checkLinks
-} from "../chunk-77VHQV7W.js";
-import "../chunk-PQMKRFBQ.js";
+} from "../chunk-ELRDUSZS.js";
+import "../chunk-PVTUVUBK.js";
+import "../chunk-AJBCHKBP.js";
 import "../chunk-V7LLYIRO.js";
 import "../chunk-QNC5QRIO.js";
 import "../chunk-5TD7NQIW.js";

package/dist/node/node/index.js

@@ -1,24 +1,25 @@
 import {
   buildSite
-} from "../chunk-GGUDZD4K.js";
+} from "../chunk-ZNURJXMI.js";
 import {
   remarkMermaidToComponent
 } from "../chunk-PRTER35L.js";
 import "../chunk-SCZZB7OE.js";
 import {
   clearifyPlugin
-} from "../chunk-IF6GI4WU.js";
+} from "../chunk-2RAA6477.js";
 import "../chunk-B2Q23JW3.js";
 import {
   init
 } from "../chunk-QIAMD2Q6.js";
 import {
   checkLinks
-} from "../chunk-77VHQV7W.js";
+} from "../chunk-ELRDUSZS.js";
 import {
   loadUserConfig,
   resolveConfig
-} from "../chunk-PQMKRFBQ.js";
+} from "../chunk-PVTUVUBK.js";
+import "../chunk-AJBCHKBP.js";
 import "../chunk-V7LLYIRO.js";
 import "../chunk-QNC5QRIO.js";
 import "../chunk-5TD7NQIW.js";

package/dist/node/types/index.d.ts

@@ -1,3 +1,9 @@
+interface RemoteGitSource {
+    repo: string;
+    ref?: string;
+    path?: string;
+    sparse?: boolean;
+}
 interface SectionConfig {
     label: string;
     docsDir: string;
@@ -5,6 +11,7 @@ interface SectionConfig {
     draft?: boolean;
     sitemap?: boolean;
     exclude?: string[];
+    git?: RemoteGitSource;
 }
 interface ResolvedSection {
     id: string;
@@ -88,11 +95,15 @@ interface HubProject {
     group?: string;
     hubUrl?: string;
     hubName?: string;
+    mode?: 'link' | 'embed';
+    git?: RemoteGitSource;
+    embedSections?: 'all' | 'public' | string[];
 }
 interface HubConfig {
     projects: HubProject[];
     scan?: string;
+    cacheDir?: string;
 }
 declare function defineConfig(config: Partial<ClearifyConfig>): Partial<ClearifyConfig>;
 
-export { type ClearifyConfig, type HubConfig, type HubProject, type NavigationItem, type PageFrontmatter, type ResolvedSection, type RouteEntry, type SectionConfig, type SectionNavigation, defineConfig };
+export { type ClearifyConfig, type HubConfig, type HubProject, type NavigationItem, type PageFrontmatter, type RemoteGitSource, type ResolvedSection, type RouteEntry, type SectionConfig, type SectionNavigation, defineConfig };

package/dist/node/vite-plugin/index.js

@@ -1,8 +1,9 @@
 import {
   clearifyPlugin
-} from "../chunk-IF6GI4WU.js";
+} from "../chunk-2RAA6477.js";
 import "../chunk-B2Q23JW3.js";
-import "../chunk-PQMKRFBQ.js";
+import "../chunk-PVTUVUBK.js";
+import "../chunk-AJBCHKBP.js";
 import "../chunk-V7LLYIRO.js";
 import "../chunk-QNC5QRIO.js";
 import "../chunk-5TD7NQIW.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@marlinjai/clearify",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "description": "An open-source documentation site generator. Turn markdown into beautiful docs.",
   "type": "module",
   "bin": {