launchframe 0.3.1 → 0.4.0

package/bin/launchframe.mjs

@@ -1,315 +1,343 @@
-#!/usr/bin/env node
-// @ts-check
-/**
- * launchframe — scaffold an AI-cloner project pointed at any URL + SaaS idea.
- *
- * Usage:
- *   npx launchframe@latest <url> "<saas idea>" [--dir <path>] [--force] [--skip-install]
- *
- * Behavior:
- *   1. Validates the URL and SaaS-idea string.
- *   2. Copies the bundled `template/` payload into the project root (current
- *      directory by default) so dotfolders like `.cursor` and `.claude` live at
- *      the workspace root when you open that folder in your editor. Use
- *      `--dir <name>` for a subdirectory if you prefer.
- *   3. Writes `launchframe.config.json` into the new project so the bundled
- *      `/clone-website` skill knows which URL to clone and how to re-skin it
- *      for your SaaS idea.
- *   4. Runs `npm install` in the new project (so the user does not have to).
- *   5. Prints one line: open the folder in Cursor and tell the AI **Build it**.
- */
-
-import { spawnSync } from "node:child_process";
-import { cpSync, existsSync, mkdirSync, readdirSync, readFileSync, writeFileSync } from "node:fs";
-import { createRequire } from "node:module";
-import { dirname, basename, isAbsolute, join, resolve } from "node:path";
-import { fileURLToPath } from "node:url";
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-const pkgRoot = resolve(__dirname, "..");
-const templateDir = join(pkgRoot, "template");
-const require = createRequire(import.meta.url);
-const pkgJson = require(join(pkgRoot, "package.json"));
-
-const COLORS = {
-  reset: "\x1b[0m",
-  bold: "\x1b[1m",
-  dim: "\x1b[2m",
-  red: "\x1b[31m",
-  green: "\x1b[32m",
-  yellow: "\x1b[33m",
-  cyan: "\x1b[36m",
-};
-const supportsColor = process.stdout.isTTY && !process.env.NO_COLOR;
-const c = (color, s) => (supportsColor ? COLORS[color] + s + COLORS.reset : s);
-
-function printHelp() {
-  console.log(`
-${c("bold", "launchframe")} ${c("dim", `v${pkgJson.version}`)}
-Scaffold an AI-cloner project pointed at any URL + SaaS idea.
-
-${c("bold", "Usage:")}
-  npx launchframe@latest <url> "<saas idea>" [options]
-
-${c("bold", "Arguments:")}
-  <url>          URL of the site you want to clone (e.g. https://linear.app)
-  <saas idea>    One-line description of the SaaS you're building
-                 (used to re-skin copy/branding after the visual clone)
-
-${c("bold", "Options:")}
-  --dir <path>   Output folder (default: .  — current directory / project root)
-  --force        Overwrite merging files into a non-empty directory (use with care)
-  --skip-install Skip npm install after scaffold (faster for CI / debugging)
-  --help, -h     Show this message
-  --version, -v  Show the launchframe version
-
-${c("bold", "Example:")}
-  npx launchframe@latest https://linear.app "AI-powered customer feedback platform"
-  # From an empty folder (or git init only), files land in .  so .cursor/ works at workspace root
-  npx launchframe@latest https://vercel.com "DevOps for ML" --dir launchframe-app
-  npx launchframe@latest https://stripe.com "Billing for AI agents" --skip-install
-`);
-}
-
-function exitErr(msg, code = 1) {
-  console.error(c("red", `\nlaunchframe: ${msg}`));
-  console.error(c("dim", "Run `npx launchframe --help` for usage.\n"));
-  process.exit(code);
-}
-
-function parseArgs(argv) {
-  const positional = [];
-  const opts = {
-    dir: ".",
-    force: false,
-    skipInstall: false,
-    help: false,
-    version: false,
-  };
-  for (let i = 0; i < argv.length; i++) {
-    const a = argv[i];
-    if (a === "--help" || a === "-h") opts.help = true;
-    else if (a === "--version" || a === "-v") opts.version = true;
-    else if (a === "--force" || a === "-f") opts.force = true;
-    else if (a === "--skip-install") opts.skipInstall = true;
-    else if (a === "--dir" || a === "-d") {
-      const next = argv[++i];
-      if (!next || next.startsWith("-")) exitErr("`--dir` requires a value");
-      opts.dir = next;
-    } else if (a.startsWith("--dir=")) {
-      opts.dir = a.slice("--dir=".length);
-    } else if (a.startsWith("-")) {
-      exitErr(`unknown option: ${a}`);
-    } else {
-      positional.push(a);
-    }
-  }
-  return { positional, opts };
-}
-
-function normalizeUrl(raw) {
-  let candidate = raw.trim();
-  if (!/^https?:\/\//i.test(candidate)) candidate = `https://${candidate}`;
-  try {
-    const u = new URL(candidate);
-    if (!u.hostname || !u.hostname.includes(".")) throw new Error("missing hostname");
-    return u.toString();
-  } catch {
-    exitErr(`invalid URL: ${raw}`);
-  }
-}
-
-function isDirEmpty(dir) {
-  try {
-    return readdirSync(dir).length === 0;
-  } catch {
-    return true;
-  }
-}
-
-/** True if the folder is empty or only has git/bootstrap noise (so we can scaffold at project root). */
-function isScaffoldRootUsable(dir) {
-  let names;
-  try {
-    names = readdirSync(dir);
-  } catch {
-    return true;
-  }
-  if (names.length === 0) return true;
-  const allowedOnly = new Set([".git", ".gitignore", ".gitattributes"]);
-  return names.every((n) => allowedOnly.has(n));
-}
-
-function npmPackageSlug(dirName, targetDir) {
-  const raw =
-    dirName === "." || dirName === "./"
-      ? basename(targetDir) || "launchframe-app"
-      : dirName;
-  const slug = raw
-    .toLowerCase()
-    .replace(/[^a-z0-9-_]/g, "-")
-    .replace(/-+/g, "-")
-    .replace(/^-|-$/g, "")
-    .slice(0, 64);
-  return slug || "launchframe-app";
-}
-
-function rewritePackageJson(targetDir, packageSlug, url, idea) {
-  const pkgPath = join(targetDir, "package.json");
-  if (!existsSync(pkgPath)) return;
-  let pkg;
-  try {
-    pkg = JSON.parse(readFileSync(pkgPath, "utf8"));
-  } catch {
-    return;
-  }
-  pkg.name = packageSlug;
-  pkg.version = "0.1.0";
-  pkg.private = true;
-  pkg.description = `Launchframe project — clone of ${url} reframed as: ${idea}`;
-  delete pkg.author;
-  delete pkg.homepage;
-  delete pkg.repository;
-  delete pkg.bugs;
-  writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + "\n", "utf8");
-}
-
-function writeLaunchframeConfig(targetDir, url, idea) {
-  const cfg = {
-    $schema: "https://launchframe.dev/schema/launchframe.config.json",
-    url,
-    idea,
-    createdAt: new Date().toISOString(),
-    launchframeVersion: pkgJson.version,
-    notes: [
-      "The /clone-website skill reads this file at the start of every run.",
-      "After scaffold: open this folder in Cursor (or your AI editor) and say **Build it** — same workflow.",
-      "`url` is the visual source-of-truth (clone its layout, spacing, tokens, motion).",
-      "`idea` is the rebranding directive applied AFTER the pixel-perfect clone.",
-      "Edit either field and re-invoke the skill to re-run.",
-    ],
-  };
-  writeFileSync(
-    join(targetDir, "launchframe.config.json"),
-    JSON.stringify(cfg, null, 2) + "\n",
-    "utf8"
-  );
-}
-
-function runNpmInstall(targetDir) {
-  console.log(c("dim", "\nRunning npm install (this may take a minute)...\n"));
-  const result = spawnSync("npm", ["install", "--no-fund", "--no-audit"], {
-    cwd: targetDir,
-    stdio: "inherit",
-    shell: true,
-    env: process.env,
-  });
-  if (result.status !== 0) {
-    console.error(
-      c("yellow", "\nlaunchframe: npm install exited with an error. ") +
-        c("dim", `Fix the issue and run \`npm install\` inside the project folder, or re-run with \`--force\`.\n`)
-    );
-    process.exit(result.status === null ? 1 : result.status);
-  }
-  console.log(c("green", "\n\u2713 npm install finished.\n"));
-}
-
-function nextSteps(projectDir, dirLabel, openHint, url, idea) {
-  console.log(`
-${c("green", "\u2713")} Done — ${c("bold", dirLabel)} is ready.
-
-  ${c("dim", "Target URL:")}  ${c("cyan", url)}
-  ${c("dim", "SaaS idea:")}   ${c("cyan", idea)}
-  ${c("dim", "Folder:")}      ${projectDir}
-
-${c("bold", "All you do next:")}
-  1. Open ${c("cyan", openHint)} in ${c("bold", "Cursor")} ${c("dim", "(File \u2192 Open Folder)")}
-  2. In chat, say: ${c("bold", "Build it")}
-     ${c("dim", "Your AI reads launchframe.config.json + AGENTS.md and runs the full clone + rebrand workflow.")}
-     ${c("dim", "You can also type ") + c("cyan", "/clone-website") + c("dim", " if you prefer.")}
-
-${c("dim", "Dotfolders (.cursor, .claude, …) are at this project root so rules and skills apply when you open this folder.")}
-${c("dim", "Other editors: same folder — say Build it, or run the /clone-website skill for your tool.")}
-${c("dim", "Edit launchframe.config.json anytime to change URL or SaaS idea.")}
-`);
-}
-
-function main() {
-  const { positional, opts } = parseArgs(process.argv.slice(2));
-  if (opts.help) return printHelp();
-  if (opts.version) return console.log(pkgJson.version);
-
-  if (positional.length < 2) {
-    if (positional.length === 0) {
-      console.error(c("red", "\nlaunchframe: missing <url> and <saas idea>"));
-    } else {
-      console.error(c("red", '\nlaunchframe: missing <saas idea> (wrap it in quotes: "...")'));
-    }
-    printHelp();
-    process.exit(1);
-  }
-  if (positional.length > 2) {
-    exitErr(
-      `too many positional arguments. Wrap your SaaS idea in quotes: ` +
-        `\`npx launchframe ${positional[0]} "${positional.slice(1).join(" ")}"\``
-    );
-  }
-
-  const url = normalizeUrl(positional[0]);
-  const idea = positional[1].trim();
-  if (!idea) exitErr("SaaS idea cannot be empty");
-
-  const dirNameRaw = opts.dir;
-  const targetDir = isAbsolute(dirNameRaw) ? dirNameRaw : resolve(process.cwd(), dirNameRaw);
-
-  const isRootDot = dirNameRaw === "." || dirNameRaw === "./";
-  const usable = isDirEmpty(targetDir) || isScaffoldRootUsable(targetDir);
-  if (existsSync(targetDir) && !usable && !opts.force) {
-    exitErr(
-      `target directory \`${dirNameRaw}\` is not empty.\n` +
-        `Create an empty folder (or \`git init\` only), run again from there, or pass \`--force\` to merge files, ` +
-        `or use \`--dir launchframe-app\` to scaffold into a subdirectory.`
-    );
-  }
-
-  if (!existsSync(templateDir)) {
-    exitErr(
-      `bundled template not found at \`${templateDir}\`.\n` +
-        `This usually means the launchframe package was installed incompletely. ` +
-        `Try: \`npm install -g launchframe@latest\` or re-run \`npx launchframe@latest ...\`.`
-    );
-  }
-
-  mkdirSync(targetDir, { recursive: true });
-
-  console.log(c("dim", `\nCopying template \u2192 ${targetDir} ...`));
-  cpSync(templateDir, targetDir, {
-    recursive: true,
-    force: opts.force,
-    filter: (src) => {
-      const lower = src.toLowerCase();
-      if (lower.endsWith(`${"\\"}node_modules`) || lower.endsWith("/node_modules")) return false;
-      if (lower.endsWith(`${"\\"}.next`) || lower.endsWith("/.next")) return false;
-      if (lower.endsWith("package-lock.json")) return false;
-      return true;
-    },
-  });
-
-  const packageSlug = npmPackageSlug(dirNameRaw, targetDir);
-  rewritePackageJson(targetDir, packageSlug, url, idea);
-  writeLaunchframeConfig(targetDir, url, idea);
-
-  if (!opts.skipInstall) runNpmInstall(targetDir);
-
-  const dirLabel = isRootDot ? "this folder (project root)" : dirNameRaw;
-  const openHint = isRootDot ? "this folder" : `./${dirNameRaw}`;
-  nextSteps(targetDir, dirLabel, openHint, url, idea);
-}
-
-try {
-  main();
-} catch (err) {
-  console.error(c("red", `\nlaunchframe: ${err?.message || err}\n`));
-  process.exit(1);
-}
+#!/usr/bin/env node
+/**
+ * Scaffold a Launchframe project: clone reference URL via AI workflow + SaaS landing copy.
+ * Usage: npx launchframe@latest <url> "<saas-idea>" [--dir=name] [--skip-install]
+ */
+
+import { cp, mkdir, readdir, readFile, writeFile } from "fs/promises";
+import { spawn } from "node:child_process";
+import { dirname, isAbsolute, join, relative, resolve } from "node:path";
+import { fileURLToPath } from "node:url";
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const PKG_ROOT = resolve(__dirname, "..");
+
+const SKIP_DIR_NAMES = new Set(["bin", "node_modules", ".git", ".next", "dist", "out"]);
+
+/** Root dot-directories we ship for agent tooling */
+const ALLOW_DOT_DIRS = new Set([
+  ".cursor",
+  ".claude",
+  ".codex",
+  ".continue",
+  ".gemini",
+  ".opencode",
+  ".windsurf",
+  ".github",
+]);
+
+const SKIP_ROOT_FILES = new Set(["package-lock.json"]);
+
+function printHelp() {
+  console.log(`
+launchframe — scaffold a Next.js app for cloning a reference site + your SaaS idea
+
+Usage:
+  npx launchframe@latest <url> "<saas-idea>" [options]
+
+Arguments:
+  <url>           HTTPS URL of the site to reverse-engineer (visual reference)
+  "<saas-idea>"   Short pitch / positioning that should appear on the landing page
+
+Options:
+  --dir, -o       Output folder (default: first label of hostname + "-launchframe")
+  --skip-install  Do not run npm install after scaffolding
+  -h, --help      Show this message
+
+Note:
+  The output folder must not live inside the Launchframe package directory (the folder that contains this CLI).
+
+Example:
+  npx launchframe@latest https://stripe.com "AI invoicing for freelancers"
+`);
+}
+
+function parseArgs(argv) {
+  const out = {
+    url: null,
+    idea: null,
+    dir: null,
+    skipInstall: false,
+    help: false,
+  };
+
+  const positional = [];
+  for (let i = 0; i < argv.length; i++) {
+    const a = argv[i];
+    if (a === "-h" || a === "--help") {
+      out.help = true;
+      continue;
+    }
+    if (a === "--skip-install") {
+      out.skipInstall = true;
+      continue;
+    }
+    if (a === "--dir" || a === "-o") {
+      out.dir = argv[++i];
+      continue;
+    }
+    if (a.startsWith("--dir=")) {
+      out.dir = a.slice("--dir=".length);
+      continue;
+    }
+    if (a.startsWith("-o=")) {
+      out.dir = a.slice("-o=".length);
+      continue;
+    }
+    positional.push(a);
+  }
+
+  if (positional[0]) out.url = positional[0];
+  if (positional[1]) out.idea = positional[1];
+
+  return out;
+}
+
+function validateUrl(raw) {
+  let u;
+  try {
+    u = new URL(raw);
+  } catch {
+    throw new Error(`Invalid URL: ${raw}`);
+  }
+  if (u.protocol !== "http:" && u.protocol !== "https:") {
+    throw new Error("URL must start with http:// or https://");
+  }
+  return u.href;
+}
+
+function defaultDirName(urlStr) {
+  try {
+    const host = new URL(urlStr).hostname.replace(/^www\./i, "");
+    const label = host.split(".")[0] || "site";
+    const safe = label.replace(/[^a-zA-Z0-9-_]/g, "-").toLowerCase();
+    return `${safe || "site"}-launchframe`;
+  } catch {
+    return "launchframe-app";
+  }
+
+}
+
+function slugFromDir(dir) {
+  const base = dir.replace(/\\/g, "/").split("/").filter(Boolean).pop() ?? "launchframe-app";
+  return base
+    .toLowerCase()
+    .replace(/[^a-z0-9-_]/g, "-")
+    .replace(/-+/g, "-")
+    .replace(/^-|-$/g, "") || "launchframe-app";
+}
+
+function tsStringLiteral(value) {
+  return JSON.stringify(value);
+}
+
+function shouldCopyRootEntry(baseName, isDirectory) {
+  if (SKIP_DIR_NAMES.has(baseName)) return false;
+  if (isDirectory && baseName.startsWith(".")) {
+    if (!ALLOW_DOT_DIRS.has(baseName)) return false;
+  }
+  if (!isDirectory && SKIP_ROOT_FILES.has(baseName)) return false;
+  return true;
+}
+
+/** Output cannot be inside the template package tree (would recurse while copying). */
+function isForbiddenOutput(packageRootAbs, destRootAbs) {
+  const pkg = resolve(packageRootAbs);
+  const dest = resolve(destRootAbs);
+  if (dest === pkg) return true;
+  const rel = relative(pkg, dest);
+  return Boolean(rel) && !rel.startsWith("..") && !isAbsolute(rel);
+}
+
+async function copyTemplateTree(sourceRoot, destRootAbs) {
+  await mkdir(destRootAbs, { recursive: true });
+  const entries = await readdir(sourceRoot, { withFileTypes: true });
+  const destResolved = resolve(destRootAbs);
+  for (const ent of entries) {
+    const from = join(sourceRoot, ent.name);
+    if (resolve(from) === destResolved) continue;
+    if (!shouldCopyRootEntry(ent.name, ent.isDirectory())) continue;
+    const to = join(destRootAbs, ent.name);
+    await cp(from, to, { recursive: true });
+  }
+}
+
+async function writeGeneratedPackageJson(destRoot, npmPackageName) {
+  const raw = await readFile(join(PKG_ROOT, "package.json"), "utf8");
+  const pkg = JSON.parse(raw);
+
+  const nextPkg = {
+    name: npmPackageName,
+    version: "0.1.0",
+    private: true,
+    description: pkg.description,
+    license: pkg.license,
+    engines: pkg.engines,
+    scripts: pkg.scripts,
+    dependencies: pkg.dependencies,
+    devDependencies: pkg.devDependencies,
+    keywords: pkg.keywords,
+  };
+
+  await writeFile(
+    join(destRoot, "package.json"),
+    `${JSON.stringify(nextPkg, null, 2)}\n`,
+    "utf8",
+  );
+}
+
+async function writeLaunchframeArtifacts(destRoot, url, idea) {
+  const configTs = `/**
+ * Written by Launchframe CLI — edit freely after scaffolding.
+ */
+export const LAUNCHFRAME_SOURCE_URL = ${tsStringLiteral(url)} as const;
+
+export const LAUNCHFRAME_SAAS_IDEA = ${tsStringLiteral(idea)} as const;
+`;
+
+  await writeFile(join(destRoot, "src", "lib", "launchframe-config.ts"), configTs, "utf8");
+
+  const ctx = {
+    sourceUrl: url,
+    saasIdea: idea,
+    notes:
+      "Use /clone-website with sourceUrl for pixel-perfect extraction. Align landing copy with saasIdea.",
+  };
+  await writeFile(
+    join(destRoot, "launchframe.context.json"),
+    `${JSON.stringify(ctx, null, 2)}\n`,
+    "utf8",
+  );
+
+  const md = `# Launchframe context
+
+## Reference URL (clone target)
+
+${url}
+
+## SaaS idea (landing copy)
+
+${idea}
+
+When running \`/clone-website\`, pass the reference URL above. After structural cloning, rewrite headings and hero copy so they clearly communicate the SaaS idea while respecting attribution and copyright for third-party brands.
+`;
+
+  await mkdir(join(destRoot, "docs", "research"), { recursive: true });
+  await writeFile(join(destRoot, "docs", "research", "LAUNCHFRAME.md"), md, "utf8");
+}
+
+async function writeReadme(destRoot, npmPackageName, url, idea) {
+  const body = `# ${npmPackageName}
+
+Created with [\`launchframe\`](https://www.npmjs.com/package/launchframe).
+
+## Inputs
+
+- **Reference site:** ${url}
+- **SaaS idea:** ${idea}
+
+## Quick start
+
+\`\`\`bash
+npm install
+npm run dev
+\`\`\`
+
+Open your AI agent (Cursor, Claude Code, etc.) and run:
+
+\`\`\`
+/clone-website ${url}
+\`\`\`
+
+Keep the SaaS positioning from \`launchframe.context.json\` / \`src/lib/launchframe-config.ts\` when adapting cloned sections.
+
+See \`AGENTS.md\` for full agent instructions.
+`;
+
+  await writeFile(join(destRoot, "README.md"), body, "utf8");
+}
+
+function runNpmInstall(cwd) {
+  return new Promise((resolvePromise, reject) => {
+    const child = spawn("npm", ["install"], {
+      cwd,
+      stdio: "inherit",
+      shell: process.platform === "win32",
+    });
+    child.on("exit", (code) => {
+      if (code === 0) resolvePromise();
+      else reject(new Error(`npm install exited with code ${code}`));
+    });
+    child.on("error", reject);
+  });
+}
+
+async function main() {
+  const args = parseArgs(process.argv.slice(2));
+  if (args.help) {
+    printHelp();
+    process.exit(0);
+  }
+
+  if (!args.url || !args.idea) {
+    console.error("Error: missing URL or SaaS idea.\n");
+    printHelp();
+    process.exit(1);
+  }
+
+  let url;
+  try {
+    url = validateUrl(args.url);
+  } catch (e) {
+    console.error(String(e.message));
+    process.exit(1);
+  }
+
+  const idea = args.idea.trim();
+  if (!idea) {
+    console.error("Error: SaaS idea cannot be empty.");
+    process.exit(1);
+  }
+
+  const dirName = args.dir?.trim() || defaultDirName(url);
+  const destRoot = resolve(process.cwd(), dirName);
+  const npmPackageName = slugFromDir(dirName);
+
+  if (isForbiddenOutput(PKG_ROOT, destRoot)) {
+    console.error(
+      "Output folder cannot be inside the Launchframe package directory. Run from a parent folder or choose another path.",
+    );
+    process.exit(1);
+  }
+
+  await mkdir(destRoot, { recursive: true });
+
+  await copyTemplateTree(PKG_ROOT, destRoot);
+
+  await writeGeneratedPackageJson(destRoot, npmPackageName);
+  await writeLaunchframeArtifacts(destRoot, url, idea);
+  await writeReadme(destRoot, npmPackageName, url, idea);
+
+  console.log(`\nCreated Launchframe project at ${destRoot}`);
+  console.log(`  Reference URL: ${url}`);
+  console.log(`  SaaS idea: ${idea}\n`);
+
+  if (!args.skipInstall) {
+    console.log("Running npm install...\n");
+    try {
+      await runNpmInstall(destRoot);
+      console.log("\nDone. Next: cd " + JSON.stringify(dirName) + " && npm run dev\n");
+    } catch (e) {
+      console.error(String(e.message));
+      console.error("\nDependencies were not installed. Run npm install inside the folder manually.\n");
+      process.exit(1);
+    }
+  } else {
+    console.log("Skipped npm install (--skip-install). Run npm install inside the folder.\n");
+  }
+}
+
+main().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});