copilotkit--copilotkit/showcase/scripts/extract-starter.ts

#!/usr/bin/env npx tsx
/**
 * Extract Starter
 *
 * Extracts a clean standalone starter from any integration directory.
 * Dereferences symlinks (tools/, shared-tools/) so the output is fully
 * self-contained. Strips test/QA/CI artifacts that end-users don't need.
 *
 * Usage:
 *   npx tsx showcase/scripts/extract-starter.ts <slug> [output-dir]
 *
 * Examples:
 *   npx tsx showcase/scripts/extract-starter.ts langgraph-python
 *   npx tsx showcase/scripts/extract-starter.ts mastra /tmp/mastra-starter
 */

import {
  cpSync,
  rmSync,
  existsSync,
  readdirSync,
  readFileSync,
  writeFileSync,
  lstatSync,
  realpathSync,
} from "fs";
import { join, resolve, dirname } from "path";
import { fileURLToPath } from "url";

const __filename = fileURLToPath(import.meta.url);
const __dirname = dirname(__filename);
const SHOWCASE = resolve(__dirname, "..");
const slug = process.argv[2];

if (!slug) {
  console.error("Usage: extract-starter.ts <slug> [output-dir]");
  process.exit(1);
}

const outDir = process.argv[3] || join(SHOWCASE, "dist", "starters", slug);

const src = join(SHOWCASE, "integrations", slug);
if (!existsSync(src)) {
  console.error(`Integration not found: ${src}`);
  process.exit(1);
}

// Before copying, resolve symlink targets from the SOURCE directory so
// relative symlinks (e.g. tools -> ../../shared/python/tools) resolve
// correctly against the repo tree — not the output directory.
const symlinkTargets: Record<string, string> = {};
for (const entry of readdirSync(src)) {
  const entryPath = join(src, entry);
  if (lstatSync(entryPath).isSymbolicLink()) {
    try {
      symlinkTargets[entry] = realpathSync(entryPath);
    } catch {
      /* broken symlink — skip */
    }
  }
}

// Copy integration to output directory.
if (existsSync(outDir)) rmSync(outDir, { recursive: true });
cpSync(src, outDir, { recursive: true });

// Replace preserved symlinks with real copies of their resolved targets.
for (const [name, realTarget] of Object.entries(symlinkTargets)) {
  const outLink = join(outDir, name);
  if (existsSync(outLink)) rmSync(outLink, { recursive: true });
  if (existsSync(realTarget)) {
    cpSync(realTarget, outLink, { recursive: true });
  }
}

// Strip test/QA/CI artifacts that end-users don't need in a starter.
const STRIP = [
  "tests",
  "qa",
  "manifest.yaml",
  "PARITY_NOTES.md",
  "docs-links.json",
  "playwright.config.ts",
  "vitest.config.ts",
  "__tests__",
  "package-lock.json",
  "pnpm-lock.yaml",
];
for (const name of STRIP) {
  const target = join(outDir, name);
  if (existsSync(target)) rmSync(target, { recursive: true });
}

// Remove demo pages entirely — the starter uses its own root page.tsx
// from the template overlay, not integration demo pages.
const demosDir = join(outDir, "src", "app", "demos");
if (existsSync(demosDir)) {
  rmSync(demosDir, { recursive: true });
}

// Trim API routes to just copilotkit and health endpoints.
const apiDir = join(outDir, "src", "app", "api");
if (existsSync(apiDir)) {
  for (const route of readdirSync(apiDir)) {
    if (route !== "copilotkit" && route !== "health") {
      rmSync(join(apiDir, route), { recursive: true });
    }
  }
}

// Overlay starter template files (sales-dashboard frontend, renderers,
// charts, hooks, etc.) so the extracted starter has a complete UI.
const templateDir = join(SHOWCASE, "shared", "starter-template");
if (existsSync(templateDir)) {
  const templateApp = join(templateDir, "app");
  if (existsSync(templateApp)) {
    cpSync(templateApp, join(outDir, "src", "app"), {
      recursive: true,
      force: true,
    });
  }

  const templateComponents = join(templateDir, "components");
  if (existsSync(templateComponents)) {
    cpSync(templateComponents, join(outDir, "src", "components"), {
      recursive: true,
      force: true,
    });
  }

  const templateHooks = join(templateDir, "hooks");
  if (existsSync(templateHooks)) {
    cpSync(templateHooks, join(outDir, "src", "hooks"), {
      recursive: true,
      force: true,
    });
  }

  const templateTypes = join(templateDir, "types.ts");
  if (existsSync(templateTypes)) {
    cpSync(templateTypes, join(outDir, "src", "types.ts"), { force: true });
  }
}

// ---------------------------------------------------------------------------
// Substitute template placeholders (e.g. {{NAME}}, {{SLUG}}).
// ---------------------------------------------------------------------------

function substituteInFile(
  filePath: string,
  replacements: Record<string, string>,
) {
  if (!existsSync(filePath)) return;
  let content = readFileSync(filePath, "utf-8");
  for (const [placeholder, value] of Object.entries(replacements)) {
    content = content.replaceAll(placeholder, value);
  }
  writeFileSync(filePath, content);
}

function ensureGitignoreEntry(filePath: string, entry: string) {
  const content = existsSync(filePath) ? readFileSync(filePath, "utf-8") : "";
  const lines = content.split(/\r?\n/);
  if (lines.includes(entry)) return;

  const separator = content.length > 0 && !content.endsWith("\n") ? "\n" : "";
  writeFileSync(filePath, `${content}${separator}${entry}\n`);
}

// Format slug into a display name: "langgraph-python" -> "Langgraph Python"
const displayName = slug
  .split("-")
  .map((w) => w.charAt(0).toUpperCase() + w.slice(1))
  .join(" ");

const templateReplacements: Record<string, string> = {
  "{{NAME}}": displayName,
  "{{SLUG}}": slug,
};

substituteInFile(
  join(outDir, "src", "app", "layout.tsx"),
  templateReplacements,
);
substituteInFile(
  join(outDir, "src", "app", "api", "health", "route.ts"),
  templateReplacements,
);

// Recursively remove __tests__ and tests directories from the output.
// The top-level STRIP list only catches root-level entries; shared tools
// (e.g. tools/shared-tools/) can contain nested test directories.
function stripTestDirs(dir: string) {
  if (!existsSync(dir)) return;
  for (const entry of readdirSync(dir, { withFileTypes: true })) {
    const fullPath = join(dir, entry.name);
    if (entry.isDirectory()) {
      if (entry.name === "__tests__" || entry.name === "tests") {
        rmSync(fullPath, { recursive: true });
      } else {
        stripTestDirs(fullPath);
      }
    }
  }
}
stripTestDirs(outDir);

ensureGitignoreEntry(join(outDir, ".gitignore"), ".copilotkit/");

console.log(`Extracted starter for ${slug}: ${outDir}`);