@marlinjai/clearify 1.13.0 → 1.14.0

package/dist/node/{chunk-EKN6DWXT.js → chunk-ZNCC6M7V.js}

@@ -1,6 +1,21 @@
 // src/node/init.ts
-import { resolve } from "path";
-import { existsSync, mkdirSync, writeFileSync } from "fs";
+import { resolve, basename } from "path";
+import { existsSync, mkdirSync, writeFileSync, readFileSync } from "fs";
+function detectProjectName() {
+  const cwd = process.cwd();
+  const pkgPath = resolve(cwd, "package.json");
+  if (existsSync(pkgPath)) {
+    try {
+      const pkg = JSON.parse(readFileSync(pkgPath, "utf-8"));
+      if (pkg.name) {
+        const raw = pkg.name.replace(/^@[^/]+\//, "");
+        return raw.replace(/[-_]/g, " ").replace(/\b\w/g, (c) => c.toUpperCase());
+      }
+    } catch {
+    }
+  }
+  return basename(cwd).replace(/[-_]/g, " ").replace(/\b\w/g, (c) => c.toUpperCase());
+}
 async function init(options = {}) {
   const cwd = process.cwd();
   const publicDir = resolve(cwd, "docs/public");
@@ -265,6 +280,21 @@ ${hasInternal ? `
     npx clearify dev        Start the dev server
     npx clearify build      Build for production
 `);
+  if (options.hub) {
+    const { registerWithHub } = await import("./hub-register-TCVGPF7N.js");
+    await registerWithHub({ projectName: detectProjectName() });
+  } else {
+    const { createInterface } = await import("readline");
+    const rl = createInterface({ input: process.stdin, output: process.stdout });
+    const answer = await new Promise((resolve2) => {
+      rl.question("  Register this project with a documentation hub? [y/N] ", resolve2);
+    });
+    rl.close();
+    if (answer.toLowerCase() === "y") {
+      const { registerWithHub } = await import("./hub-register-TCVGPF7N.js");
+      await registerWithHub({ projectName: detectProjectName() });
+    }
+  }
 }
 
 export {

package/dist/node/cli/index.js

@@ -34,9 +34,9 @@ cli.command("build", "Build static documentation site").action(async () => {
   const { build } = await import("../node/index.js");
   await build();
 });
-cli.command("init", "Scaffold a docs folder").option("--no-internal", "Skip creating the internal docs section").option("--no-claude-rules", "Skip creating .claude/rules/clearify-docs.md").action(async (options) => {
+cli.command("init", "Scaffold a docs folder and optionally register with a hub").option("--no-internal", "Skip creating the internal docs section").option("--no-claude-rules", "Skip creating .claude/rules/clearify-docs.md").option("--hub", "Register this project with a documentation hub").action(async (options) => {
   const { init } = await import("../node/index.js");
-  await init({ noInternal: options.noInternal, noClaudeRules: options.noClaudeRules });
+  await init({ noInternal: options.noInternal, noClaudeRules: options.noClaudeRules, hub: options.hub });
 });
 cli.command("check", "Check for broken internal links and frontmatter issues").option("--frontmatter", "Only run frontmatter validation (skip broken link detection)").action(async (options) => {
   const { checkLinks } = await import("../node/check.js");

package/dist/node/hub-register-TCVGPF7N.js

@@ -0,0 +1,282 @@
+// src/node/hub-register.ts
+import { resolve, basename } from "path";
+import { existsSync, readFileSync, writeFileSync, mkdirSync } from "fs";
+import { execSync } from "child_process";
+function detectProjectName() {
+  const cwd = process.cwd();
+  const pkgPath = resolve(cwd, "package.json");
+  if (existsSync(pkgPath)) {
+    try {
+      const pkg = JSON.parse(readFileSync(pkgPath, "utf-8"));
+      if (pkg.name) {
+        const raw = pkg.name.replace(/^@[^/]+\//, "");
+        return raw.replace(/[-_]/g, " ").replace(/\b\w/g, (c) => c.toUpperCase());
+      }
+    } catch {
+    }
+  }
+  return basename(cwd).replace(/[-_]/g, " ").replace(/\b\w/g, (c) => c.toUpperCase());
+}
+function getGitRemoteInfo() {
+  try {
+    const url = execSync("git remote get-url origin", { encoding: "utf-8" }).trim();
+    const match = url.match(/github\.com[:/]([^/]+)\/([^/.]+)/);
+    if (match) return { owner: match[1], repo: match[2] };
+  } catch {
+  }
+  return null;
+}
+async function ghApiFetch(url, options = {}) {
+  const res = await fetch(url, {
+    method: options.method ?? "GET",
+    headers: {
+      Accept: "application/vnd.github.v3+json",
+      "Content-Type": "application/json",
+      ...options.headers
+    },
+    body: options.body
+  });
+  const data = await res.json().catch(() => null);
+  return { status: res.status, data };
+}
+async function githubDeviceAuth(clientId) {
+  const codeRes = await fetch("https://github.com/login/device/code", {
+    method: "POST",
+    headers: {
+      Accept: "application/json",
+      "Content-Type": "application/json"
+    },
+    body: JSON.stringify({ client_id: clientId, scope: "repo" })
+  });
+  const codeData = await codeRes.json();
+  console.log(`
+  Open this URL in your browser: ${codeData.verification_uri}`);
+  console.log(`  Enter code: ${codeData.user_code}
+`);
+  try {
+    const platform = process.platform;
+    if (platform === "darwin") {
+      execSync(`open "${codeData.verification_uri}"`);
+    } else if (platform === "linux") {
+      execSync(`xdg-open "${codeData.verification_uri}"`);
+    } else if (platform === "win32") {
+      execSync(`start "${codeData.verification_uri}"`);
+    }
+  } catch {
+  }
+  const interval = (codeData.interval || 5) * 1e3;
+  const deadline = Date.now() + codeData.expires_in * 1e3;
+  while (Date.now() < deadline) {
+    await new Promise((r) => setTimeout(r, interval));
+    const tokenRes = await fetch("https://github.com/login/oauth/access_token", {
+      method: "POST",
+      headers: {
+        Accept: "application/json",
+        "Content-Type": "application/json"
+      },
+      body: JSON.stringify({
+        client_id: clientId,
+        device_code: codeData.device_code,
+        grant_type: "urn:ietf:params:oauth:grant-type:device_code"
+      })
+    });
+    const tokenData = await tokenRes.json();
+    if (tokenData.access_token) {
+      console.log("  GitHub authentication successful!\n");
+      return tokenData.access_token;
+    }
+    if (tokenData.error === "authorization_pending") {
+      continue;
+    }
+    if (tokenData.error === "slow_down") {
+      await new Promise((r) => setTimeout(r, 5e3));
+      continue;
+    }
+    if (tokenData.error === "expired_token") {
+      throw new Error("Device code expired. Please try again.");
+    }
+    if (tokenData.error === "access_denied") {
+      throw new Error("Authorization denied by user.");
+    }
+    throw new Error(`OAuth error: ${tokenData.error} \u2014 ${tokenData.error_description}`);
+  }
+  throw new Error("Device code expired. Please try again.");
+}
+async function promptHubRepo() {
+  const { createInterface } = await import("readline");
+  const rl = createInterface({ input: process.stdin, output: process.stdout });
+  const answer = await new Promise((resolve2) => {
+    rl.question("  Hub repository (owner/repo): ", resolve2);
+  });
+  rl.close();
+  const parts = answer.trim().split("/");
+  if (parts.length !== 2 || !parts[0] || !parts[1]) {
+    throw new Error(`Invalid repository format: "${answer}". Expected "owner/repo".`);
+  }
+  return { owner: parts[0], repo: parts[1] };
+}
+async function updateHubRegistry(token, hub, project) {
+  const authHeaders = { Authorization: `token ${token}` };
+  const apiBase = "https://api.github.com";
+  const fileUrl = `${apiBase}/repos/${hub.owner}/${hub.repo}/contents/clearify.data.json`;
+  const getRes = await ghApiFetch(fileUrl, { headers: authHeaders });
+  let currentData = { hub: { projects: [] } };
+  let fileSha;
+  if (getRes.status === 200 && getRes.data?.content) {
+    const decoded = Buffer.from(getRes.data.content, "base64").toString("utf-8");
+    currentData = JSON.parse(decoded);
+    fileSha = getRes.data.sha;
+    if (!currentData.hub) currentData.hub = { projects: [] };
+    if (!currentData.hub.projects) currentData.hub.projects = [];
+  } else if (getRes.status !== 404) {
+    throw new Error(`Failed to read hub registry: ${getRes.status} ${JSON.stringify(getRes.data)}`);
+  }
+  const existingIdx = currentData.hub.projects.findIndex(
+    (p) => p.name === project.name
+  );
+  const entry = {
+    name: project.name,
+    description: project.description,
+    status: "active",
+    mode: "embed",
+    git: {
+      repo: project.gitRepoUrl,
+      ref: project.gitRef,
+      path: project.docsPath
+    }
+  };
+  if (existingIdx >= 0) {
+    currentData.hub.projects[existingIdx] = entry;
+    console.log(`  Updated existing project "${project.name}" in hub registry`);
+  } else {
+    currentData.hub.projects.push(entry);
+    console.log(`  Added project "${project.name}" to hub registry`);
+  }
+  const updatedContent = Buffer.from(
+    JSON.stringify(currentData, null, 2) + "\n"
+  ).toString("base64");
+  const putBody = {
+    message: `docs: register ${project.name} in hub`,
+    content: updatedContent
+  };
+  if (fileSha) putBody.sha = fileSha;
+  const putRes = await ghApiFetch(fileUrl, {
+    method: "PUT",
+    headers: authHeaders,
+    body: JSON.stringify(putBody)
+  });
+  if (putRes.status !== 200 && putRes.status !== 201) {
+    throw new Error(
+      `Failed to update hub registry: ${putRes.status} ${JSON.stringify(putRes.data)}`
+    );
+  }
+  console.log("  Hub registry updated successfully");
+}
+function generateConfig(projectName, hubProject) {
+  const cwd = process.cwd();
+  const configPath = resolve(cwd, "clearify.config.ts");
+  if (existsSync(configPath)) {
+    console.log("  clearify.config.ts already exists \u2014 skipping config generation");
+    console.log("  Add a hubProject block manually if needed");
+    return;
+  }
+  const description = hubProject?.description ?? "Project documentation";
+  const config = `import { defineConfig } from '@marlinjai/clearify';
+
+export default defineConfig({
+  name: '${projectName}',
+  sections: [
+    { label: 'Docs', docsDir: './docs/public' },
+  ],
+  theme: {
+    primaryColor: '#3B82F6',
+    mode: 'auto',
+  },
+  hubProject: {
+    description: '${description}',
+    status: 'active',
+  },
+});
+`;
+  writeFileSync(configPath, config);
+  console.log("  Created clearify.config.ts with hubProject config");
+}
+function generateWorkflow(hub) {
+  const cwd = process.cwd();
+  const workflowDir = resolve(cwd, ".github/workflows");
+  const workflowPath = resolve(workflowDir, "docs-trigger.yml");
+  if (existsSync(workflowPath)) {
+    console.log("  .github/workflows/docs-trigger.yml already exists \u2014 skipping");
+    return;
+  }
+  mkdirSync(workflowDir, { recursive: true });
+  const workflow = `name: Docs Trigger
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - 'docs/**'
+      - 'clearify.config.ts'
+
+jobs:
+  notify-hub:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Trigger hub rebuild
+        run: |
+          curl -X POST \\
+            -H "Authorization: token \${{ secrets.HUB_DISPATCH_TOKEN }}" \\
+            -H "Accept: application/vnd.github.v3+json" \\
+            https://api.github.com/repos/${hub.owner}/${hub.repo}/dispatches \\
+            -d '{"event_type": "docs-update"}'
+`;
+  writeFileSync(workflowPath, workflow);
+  console.log("  Created .github/workflows/docs-trigger.yml");
+}
+async function registerWithHub(options) {
+  const clientId = process.env.CLEARIFY_GITHUB_CLIENT_ID;
+  if (!clientId) {
+    console.error("\n  Error: CLEARIFY_GITHUB_CLIENT_ID environment variable is not set.");
+    console.error("  Set it to your GitHub OAuth App client ID and try again.\n");
+    process.exit(1);
+  }
+  const projectName = options.projectName ?? detectProjectName();
+  const currentRepo = getGitRemoteInfo();
+  if (!currentRepo) {
+    console.error("\n  Error: Could not detect git remote origin.");
+    console.error("  Make sure this is a git repository with a GitHub remote.\n");
+    process.exit(1);
+  }
+  console.log(`
+  Registering "${projectName}" with a documentation hub
+`);
+  const hub = await promptHubRepo();
+  console.log(`  Hub: ${hub.owner}/${hub.repo}
+`);
+  console.log("  Starting GitHub authentication...");
+  const token = await githubDeviceAuth(clientId);
+  console.log("  Updating hub registry...");
+  await updateHubRegistry(token, hub, {
+    name: projectName,
+    description: options.hubProject?.description ?? "Project documentation",
+    gitRepoUrl: `https://github.com/${currentRepo.owner}/${currentRepo.repo}.git`,
+    gitRef: "main",
+    docsPath: "docs/public"
+  });
+  console.log("  Generating local files...");
+  generateConfig(projectName, options.hubProject);
+  generateWorkflow(hub);
+  console.log(`
+  Hub registration complete!
+
+  Next steps:
+    1. Review clearify.config.ts and update the hubProject description
+    2. Add "${currentRepo.repo}" to the repos list in infra/deployments/hub-dispatch/github.tf
+    3. Run: cd infra/deployments/hub-dispatch && ../../scripts/tfrun.sh apply
+    4. Commit the generated files and push to main
+`);
+}
+export {
+  registerWithHub
+};

package/dist/node/node/index.js

@@ -11,7 +11,7 @@ import {
 import "../chunk-B2Q23JW3.js";
 import {
   init
-} from "../chunk-EKN6DWXT.js";
+} from "../chunk-ZNCC6M7V.js";
 import {
   checkFrontmatter,
   checkLinks

package/dist/node/node/init.d.ts

@@ -1,6 +1,7 @@
 interface InitOptions {
     noInternal?: boolean;
     noClaudeRules?: boolean;
+    hub?: boolean;
 }
 declare function init(options?: InitOptions): Promise<void>;
 

package/dist/node/node/init.js

@@ -1,6 +1,6 @@
 import {
   init
-} from "../chunk-EKN6DWXT.js";
+} from "../chunk-ZNCC6M7V.js";
 export {
   init
 };

package/package.json

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