create-thally-docs 0.8.1 → 0.10.0

package/dist/chunk-ENQIF6MA.js

@@ -0,0 +1,164 @@
+#!/usr/bin/env node
+import {
+  readStarterReleaseManifest
+} from "./chunk-KXJT2MG5.js";
+import {
+  STABLE_SCAFFOLD_RELEASE
+} from "./chunk-WMHBVXWW.js";
+
+// src/download.ts
+import { Readable, Transform, pipeline } from "stream";
+import { promisify } from "util";
+import {
+  cpSync,
+  lstatSync,
+  mkdtempSync,
+  readdirSync,
+  renameSync,
+  rmdirSync,
+  rmSync
+} from "fs";
+import { tmpdir } from "os";
+import { dirname, join } from "path";
+import { extract } from "tar";
+var pipelineAsync = promisify(pipeline);
+var STARTER_FETCH_TIMEOUT_MS = 15e3;
+var MAX_COMPRESSED_ARCHIVE_BYTES = 64 * 1024 * 1024;
+var MAX_EXTRACTED_ARCHIVE_BYTES = 256 * 1024 * 1024;
+var MAX_ARCHIVE_FILE_BYTES = 32 * 1024 * 1024;
+var MAX_ARCHIVE_ENTRIES = 1e4;
+var STARTER_REPOSITORY = STABLE_SCAFFOLD_RELEASE.source.repository;
+var STARTER_COMMIT_SHA = STABLE_SCAFFOLD_RELEASE.source.commitSha;
+var STARTER_ARCHIVE_ROOT = `${STARTER_REPOSITORY.split("/").at(-1)}-${STARTER_COMMIT_SHA}`;
+function starterArchiveRoot(release) {
+  return `${release.source.repository.split("/").at(-1)}-${release.source.commitSha}`;
+}
+function validateStarterArchiveEntry(archivePath, entry, archiveRoot = STARTER_ARCHIVE_ROOT) {
+  if (!archivePath || archivePath.includes("\0") || archivePath.includes("\\") || archivePath.startsWith("/")) {
+    throw new Error("The stable Thally starter archive contains an unsafe path.");
+  }
+  const pathWithoutTrailingSlash = archivePath.endsWith("/") ? archivePath.slice(0, -1) : archivePath;
+  const parts = pathWithoutTrailingSlash.split("/");
+  const [root, ...relativeParts] = parts;
+  if (root !== archiveRoot || relativeParts.some((part) => !part || part === "." || part === "..")) {
+    throw new Error("The stable Thally starter archive contains an unsafe path.");
+  }
+  if (relativeParts.length === 0 && entry.type !== "Directory") {
+    throw new Error("The stable Thally starter archive has an invalid root entry.");
+  }
+  if (!["File", "OldFile", "Directory"].includes(entry.type)) {
+    throw new Error(
+      `The stable Thally starter archive contains unsupported entry type ${entry.type}.`
+    );
+  }
+  if (!Number.isSafeInteger(entry.size) || entry.size < 0 || entry.size > MAX_ARCHIVE_FILE_BYTES) {
+    throw new Error("The stable Thally starter archive contains an oversized file.");
+  }
+}
+function starterArchiveFilter(archiveRoot) {
+  let entryCount = 0;
+  let extractedBytes = 0;
+  return (path, entry) => {
+    if (!("type" in entry)) {
+      throw new Error("The starter archive filter requires extraction metadata.");
+    }
+    validateStarterArchiveEntry(path, entry, archiveRoot);
+    entryCount += 1;
+    extractedBytes += entry.size;
+    if (entryCount > MAX_ARCHIVE_ENTRIES || extractedBytes > MAX_EXTRACTED_ARCHIVE_BYTES) {
+      throw new Error("The stable Thally starter archive exceeds extraction limits.");
+    }
+    return true;
+  };
+}
+function compressedArchiveLimit() {
+  let compressedBytes = 0;
+  return new Transform({
+    transform(chunk, _encoding, callback) {
+      compressedBytes += chunk.length;
+      if (compressedBytes > MAX_COMPRESSED_ARCHIVE_BYTES) {
+        callback(new Error("The stable Thally starter archive is too large."));
+        return;
+      }
+      callback(null, chunk);
+    }
+  });
+}
+async function downloadStarter(targetDir, siteName, release = STABLE_SCAFFOLD_RELEASE, options = {}) {
+  if (options.announce !== false) {
+    console.log("");
+    console.log(`  \u23F3 Creating ${siteName?.trim() || "your docs site"}...`);
+  }
+  const targetEntry = lstatSync(targetDir);
+  if (!targetEntry.isDirectory() || targetEntry.isSymbolicLink()) {
+    throw new Error("The Thally starter target must be a regular directory.");
+  }
+  if (readdirSync(targetDir).length > 0) {
+    throw new Error("The Thally starter target directory must be empty.");
+  }
+  const response = await fetch(release.source.archiveUrl, {
+    headers: { accept: "application/gzip, application/octet-stream;q=0.9" },
+    cache: "no-store",
+    signal: AbortSignal.timeout(STARTER_FETCH_TIMEOUT_MS)
+  });
+  if (!response.ok) {
+    throw new Error(
+      `Failed to download the stable Thally starter: ${response.status} ${response.statusText}`
+    );
+  }
+  if (!response.body) {
+    throw new Error("The stable Thally starter response body is empty.");
+  }
+  const contentLength = Number(response.headers.get("content-length"));
+  if (Number.isFinite(contentLength) && contentLength > MAX_COMPRESSED_ARCHIVE_BYTES) {
+    throw new Error("The stable Thally starter archive is too large.");
+  }
+  const nodeStream = Readable.fromWeb(
+    response.body
+  );
+  const stagingDir = mkdtempSync(join(tmpdir(), "thally-starter-download-"));
+  try {
+    await pipelineAsync(
+      nodeStream,
+      compressedArchiveLimit(),
+      extract({
+        cwd: stagingDir,
+        strip: 1,
+        filter: starterArchiveFilter(starterArchiveRoot(release)),
+        preservePaths: false,
+        strict: true,
+        unlink: true,
+        maxDecompressionRatio: 100
+      })
+    );
+    readStarterReleaseManifest(stagingDir, release);
+    const deliveryDir = mkdtempSync(
+      join(dirname(targetDir), ".thally-starter-delivery-")
+    );
+    try {
+      for (const entry of readdirSync(stagingDir)) {
+        cpSync(join(stagingDir, entry), join(deliveryDir, entry), {
+          recursive: true,
+          errorOnExist: true
+        });
+      }
+      if (readdirSync(targetDir).length > 0) {
+        throw new Error("The Thally starter target changed during download.");
+      }
+      rmdirSync(targetDir);
+      renameSync(deliveryDir, targetDir);
+    } finally {
+      rmSync(deliveryDir, { recursive: true, force: true });
+    }
+  } finally {
+    rmSync(stagingDir, { recursive: true, force: true });
+  }
+}
+
+export {
+  STARTER_REPOSITORY,
+  STARTER_COMMIT_SHA,
+  STARTER_ARCHIVE_ROOT,
+  validateStarterArchiveEntry,
+  downloadStarter
+};

package/dist/{chunk-SDZZYPSN.js → chunk-GAFCLXU4.js}

@@ -3,7 +3,7 @@ import {
   initGit,
   installDeps,
   scaffold
-} from "./chunk-RS6U2GSX.js";
+} from "./chunk-GTGHYJXS.js";
 
 // src/migrate/index.ts
 import { existsSync, mkdirSync, mkdtempSync, readFileSync, rmSync, writeFileSync } from "fs";

package/dist/chunk-GTGHYJXS.js

@@ -0,0 +1,160 @@
+#!/usr/bin/env node
+import {
+  personalizeStarter,
+  updateEnvExample
+} from "./chunk-ORUAMPNF.js";
+import {
+  downloadStarter
+} from "./chunk-ENQIF6MA.js";
+
+// src/scaffold.ts
+import { existsSync, mkdirSync, readdirSync } from "fs";
+import { resolve } from "path";
+
+// src/docs-json.ts
+import { readFileSync, writeFileSync } from "fs";
+import { join } from "path";
+function readDocsJson(projectDir) {
+  const docsPath = join(projectDir, "docs.json");
+  const raw = readFileSync(docsPath, "utf8");
+  return JSON.parse(raw);
+}
+function writeDocsJson(projectDir, config) {
+  const docsPath = join(projectDir, "docs.json");
+  writeFileSync(docsPath, JSON.stringify(config, null, 2) + "\n", "utf8");
+}
+function resetTrackingConfig(projectDir) {
+  const config = readDocsJson(projectDir);
+  if (config.tracking) {
+    delete config.tracking;
+    writeDocsJson(projectDir, config);
+  }
+}
+function writeTrackingConfig(projectDir, repos) {
+  if (repos.length === 0) return;
+  const config = readDocsJson(projectDir);
+  config.tracking = { repos: repos.map((r) => ({ owner: r.owner, repo: r.repo, branch: "main" })) };
+  writeDocsJson(projectDir, config);
+}
+
+// src/utils.ts
+import { execSync } from "child_process";
+import { basename } from "path";
+function slugify(name) {
+  return name.toLowerCase().replace(/[^a-z0-9]+/g, "-").replace(/(^-|-$)/g, "");
+}
+function run(cmd, cwd) {
+  execSync(cmd, { cwd, stdio: "inherit" });
+}
+function initGit(targetDir) {
+  try {
+    run("git init", targetDir);
+    run("git add -A", targetDir);
+    run('git commit -m "Initial commit from create-thally-docs"', targetDir);
+  } catch {
+    console.log("  \u26A0\uFE0F  Could not initialize git (you can do this manually).");
+  }
+}
+function installDeps(targetDir) {
+  console.log("");
+  console.log("  \u{1F4E6} Installing dependencies...");
+  console.log("");
+  run("npm install --prefer-offline --no-audit --no-fund --progress=false", targetDir);
+}
+function logo() {
+  console.log("");
+  console.log("  \u2554\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2557");
+  console.log("  \u2551                                                        \u2551");
+  console.log("  \u2551   \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2557\u2588\u2588\u2557  \u2588\u2588\u2557 \u2588\u2588\u2588\u2588\u2588\u2557 \u2588\u2588\u2557     \u2588\u2588\u2557     \u2588\u2588\u2557   \u2588\u2588\u2557   \u2551");
+  console.log("  \u2551   \u255A\u2550\u2550\u2588\u2588\u2554\u2550\u2550\u255D\u2588\u2588\u2551  \u2588\u2588\u2551\u2588\u2588\u2554\u2550\u2550\u2588\u2588\u2557\u2588\u2588\u2551     \u2588\u2588\u2551     \u255A\u2588\u2588\u2557 \u2588\u2588\u2554\u255D   \u2551");
+  console.log("  \u2551      \u2588\u2588\u2551   \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2551\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2551\u2588\u2588\u2551     \u2588\u2588\u2551      \u255A\u2588\u2588\u2588\u2588\u2554\u255D    \u2551");
+  console.log("  \u2551      \u2588\u2588\u2551   \u2588\u2588\u2554\u2550\u2550\u2588\u2588\u2551\u2588\u2588\u2554\u2550\u2550\u2588\u2588\u2551\u2588\u2588\u2551     \u2588\u2588\u2551       \u255A\u2588\u2588\u2554\u255D     \u2551");
+  console.log("  \u2551      \u2588\u2588\u2551   \u2588\u2588\u2551  \u2588\u2588\u2551\u2588\u2588\u2551  \u2588\u2588\u2551\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2557\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2557   \u2588\u2588\u2551      \u2551");
+  console.log("  \u2551      \u255A\u2550\u255D   \u255A\u2550\u255D  \u255A\u2550\u255D\u255A\u2550\u255D  \u255A\u2550\u255D\u255A\u2550\u2550\u2550\u2550\u2550\u2550\u255D\u255A\u2550\u2550\u2550\u2550\u2550\u2550\u255D   \u255A\u2550\u255D      \u2551");
+  console.log("  \u2551                                                        \u2551");
+  console.log("  \u2551Give your product and docs first-class agent visibility.\u2551");
+  console.log("  \u2551                                                        \u2551");
+  console.log("  \u255A\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u255D");
+  console.log("");
+}
+function success(projectDir, projectName, dependenciesInstalled) {
+  console.log("");
+  console.log("  \u2705 Your Thally project is ready!");
+  console.log("");
+  console.log(`  \u{1F4C2} ${projectDir}`);
+  console.log("");
+  console.log("  Next steps:");
+  console.log("");
+  console.log(`    cd ${basename(projectDir)}`);
+  if (!dependenciesInstalled) {
+    console.log("    npm install");
+  }
+  console.log("    npm run dev");
+  console.log("");
+  console.log(`  Your terminal will print the local URL for your ${projectName} docs.`);
+  console.log("");
+  console.log("  \u{1F4DD} Key files to edit:");
+  console.log("    \u2022 src/data/site.ts        \u2014 name, links, branding");
+  console.log("    \u2022 docs.json               \u2014 navigation structure");
+  console.log("    \u2022 src/content/*.mdx        \u2014 your documentation");
+  console.log("    \u2022 openapi.yaml            \u2014 API spec (optional)");
+  console.log("");
+  console.log("  Happy documenting! \u{1F680}");
+  console.log("");
+}
+
+// src/scaffold.ts
+async function scaffold(options) {
+  const {
+    projectDir,
+    projectName,
+    description,
+    brandPreset,
+    repoUrl,
+    doInstall,
+    enableAiChat = true,
+    i18nLocales,
+    trackRepos
+  } = options;
+  const targetDir = resolve(projectDir);
+  if (existsSync(targetDir) && readdirSync(targetDir).length > 0) {
+    throw new Error(`Directory "${targetDir}" already exists and is not empty.`);
+  }
+  mkdirSync(targetDir, { recursive: true });
+  const slug = slugify(projectName);
+  await downloadStarter(targetDir, projectName);
+  personalizeStarter(targetDir, {
+    projectName,
+    packageName: slug,
+    description,
+    brandPreset,
+    repoUrl,
+    enableAiChat,
+    i18nLocales
+  });
+  resetTrackingConfig(targetDir);
+  if (trackRepos?.length) {
+    writeTrackingConfig(targetDir, trackRepos);
+    const list = trackRepos.map((r) => `${r.owner}/${r.repo}`).join(", ");
+    console.log(`  \u2713 Thally Track enabled \u2014 watching ${list} (branch main, all files; refine in docs.json).`);
+    console.log("    To finish wiring it: `thally track setup` (pick a trigger) + `thally agent init`,");
+    console.log("    then add your ANTHROPIC_API_KEY. See /guides/thally-track.");
+  }
+  updateEnvExample(targetDir);
+  if (doInstall) {
+    installDeps(targetDir);
+  }
+  initGit(targetDir);
+  return { projectDir: targetDir };
+}
+
+export {
+  slugify,
+  initGit,
+  installDeps,
+  logo,
+  success,
+  readDocsJson,
+  writeDocsJson,
+  scaffold
+};