create-lacspace-seo 1.0.0

package/LICENSE

@@ -0,0 +1,51 @@
+Lacspace Free Licence
+Version 1.0, August 2026
+
+Copyright (c) 2026 Lacspace
+
+PREAMBLE
+
+This software is published by Lacspace under the Lacspace Free Licence — a free,
+permissive licence that lets you use this software for any purpose, including in
+commercial products and services, at no cost. It grants the same freedoms as
+common permissive open-source licences; the only condition is that this notice
+travels with the software. The canonical, always-current text of this licence is
+maintained at https://lacspace.com/licenses/lacspace-free-1.0
+
+GRANT OF RIGHTS
+
+Permission is hereby granted, free of charge, to any person or organisation
+obtaining a copy of this software and its associated documentation and data files
+(the "Software"), to deal in the Software without restriction, including without
+limitation the rights to use, copy, modify, merge, publish, distribute,
+sublicense, and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the conditions below. These rights are
+granted for any purpose, personal or commercial, and are perpetual, worldwide,
+non-exclusive, and royalty-free.
+
+CONDITIONS
+
+The above copyright notice, this permission notice, and the name of this licence
+("Lacspace Free Licence") shall be included in all copies or substantial portions
+of the Software.
+
+TRADEMARKS
+
+This licence does not grant permission to use the trade names, trademarks, service
+marks, logos, or product names of Lacspace, except as required to reproduce the
+notice above or to describe the origin of the Software in a truthful manner.
+
+DISCLAIMER OF WARRANTY AND LIMITATION OF LIABILITY
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN
+AN ACTION OF CONTRACT, TORT, OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+---
+
+The Lacspace Free Licence is a source-available, permissive licence and is not (as
+of this version) an OSI-approved licence. In substance it grants the same freedoms
+as the MIT Licence. Learn more at https://lacspace.com/licenses

package/README.md

@@ -0,0 +1,101 @@
+<div align="center">
+
+# create-lacspace-seo
+
+**Scaffold a complete, production-ready SEO setup into a Next.js app in one command.**
+
+[![npm version](https://img.shields.io/npm/v/create-lacspace-seo?color=%2316a34a&label=npm)](https://www.npmjs.com/package/create-lacspace-seo)
+[![license](https://img.shields.io/npm/l/create-lacspace-seo?color=green)](https://github.com/lacspace/npm-packages/blob/main/LICENSE)
+
+</div>
+
+> One command drops in a `defineSite()` config plus **ready-made `robots.txt`, `sitemap.xml`, `feed.xml`, `llms.txt` and a dynamic OG-image route** — all wired to a single source of truth. No copywriting, no boilerplate, no fragile hand-written structured data.
+
+## Use it
+
+```bash
+npm create lacspace-seo@latest
+# or
+npx create-lacspace-seo
+```
+
+Run it inside a Next.js **App Router** project. It auto-detects `app/` or `src/app/`, asks a few questions (or take flags), and writes:
+
+```
+lib/site.ts               ← one defineSite() config, used everywhere
+app/robots.txt/route.ts   ← robots.txt (auto sitemap ref, optional AI blocking)
+app/sitemap.xml/route.ts  ← sitemap.xml from bare paths
+app/feed.xml/route.ts     ← RSS feed, prefilled from the site config
+app/llms.txt/route.ts     ← llms.txt map for LLMs (llmstxt.org)
+app/og/route.tsx          ← dynamic Open Graph images (/og?title=…)
+```
+
+Then install the packages it uses and you're done:
+
+```bash
+npm i @lacspace/seo @lacspace/robots @lacspace/sitemap @lacspace/rss @lacspace/llms-txt
+```
+
+## Non-interactive (CI / scripts)
+
+```bash
+npx create-lacspace-seo --yes \
+  --name "Acme" \
+  --url "https://acme.com" \
+  --description "We build things" \
+  --twitter acmehq \
+  --logo /logo.png
+```
+
+| Flag | Meaning |
+| --- | --- |
+| `--name <name>` | Site / brand name |
+| `--url <url>` | Absolute site URL |
+| `--description <text>` | Default meta description |
+| `--twitter <handle>` | Twitter/X handle |
+| `--logo <path>` | Logo path (e.g. `/logo.png`) |
+| `--no-og` | Skip the dynamic OG-image route |
+| `-y, --yes` | No prompts (needs `--name` & `--url`) |
+| `--force` | Overwrite existing files |
+
+Existing files are **never overwritten** unless you pass `--force` — safe to re-run.
+
+## What you get
+
+Every page becomes a one-liner, powered by the file it generated:
+
+```ts
+import { site } from "@/lib/site";
+
+export const metadata = site.meta({ title: "Pricing", path: "/pricing" });
+// → title template, canonical, Open Graph, Twitter card, dynamic OG image — all filled in
+```
+
+## The Lacspace SEO Kit
+
+| Package | For |
+| --- | --- |
+| [`@lacspace/seo`](https://www.npmjs.com/package/@lacspace/seo) | Metadata, JSON-LD & the `defineSite()` engine |
+| [`@lacspace/sitemap`](https://www.npmjs.com/package/@lacspace/sitemap) | sitemap.xml |
+| [`@lacspace/robots`](https://www.npmjs.com/package/@lacspace/robots) | robots.txt |
+| [`@lacspace/llms-txt`](https://www.npmjs.com/package/@lacspace/llms-txt) | llms.txt / llms-full.txt |
+| [`@lacspace/rss`](https://www.npmjs.com/package/@lacspace/rss) | RSS / Atom / JSON feeds |
+| **`create-lacspace-seo`** | Scaffolder (this package) |
+
+## Licensing
+
+This package is **free** under the **[Lacspace Free Licence](https://lacspace.com/licenses/lacspace-free-1.0)** — MIT-equivalent freedoms. Use it in personal and commercial projects at no cost; just keep the notice.
+
+Not every Lacspace package is free. We also offer **Commercial** (paid), **Client-specific**, and **Private** (proprietary) packages under separate terms. See the full **[Lacspace Licence Centre](https://lacspace.com/licenses)**.
+
+---
+
+<div align="center">
+
+**Part of the Lacspace ecosystem — zero-dependency, isomorphic TypeScript packages.**
+
+[All packages ↗](https://lacspace.com/packages) · [npm org ↗](https://www.npmjs.com/org/lacspace) · [Licence Centre ↗](https://lacspace.com/licenses) · [GitHub ↗](https://github.com/lacspace/npm-packages)
+
+</div>
+
+<div align="center"><sub>Built with care by <a href="https://lacspace.com">Lacspace</a> · Lacspace Free Licence · <a href="https://github.com/lacspace/npm-packages">source</a></sub></div>

package/dist/index.js

@@ -0,0 +1,344 @@
+#!/usr/bin/env node
+import { existsSync, readFileSync, mkdirSync, writeFileSync } from 'fs';
+import { join, resolve, dirname } from 'path';
+import { createInterface } from 'readline/promises';
+import { stdout, exit, argv, cwd, stdin } from 'process';
+
+var C = {
+  reset: "\x1B[0m",
+  bold: "\x1B[1m",
+  dim: "\x1B[2m",
+  green: "\x1B[32m",
+  cyan: "\x1B[36m",
+  yellow: "\x1B[33m",
+  red: "\x1B[31m",
+  blue: "\x1B[34m"
+};
+var c = (color, s) => `${C[color]}${s}${C.reset}`;
+function parseArgs(list) {
+  const a = { yes: false, force: false, og: true, help: false };
+  for (let i = 0; i < list.length; i++) {
+    const arg = list[i];
+    const next = () => list[++i] ?? "";
+    switch (arg) {
+      case "--name":
+        a.name = next();
+        break;
+      case "--url":
+        a.url = next();
+        break;
+      case "--description":
+      case "--desc":
+        a.description = next();
+        break;
+      case "--twitter":
+        a.twitter = next();
+        break;
+      case "--logo":
+        a.logo = next();
+        break;
+      case "-y":
+      case "--yes":
+        a.yes = true;
+        break;
+      case "--force":
+        a.force = true;
+        break;
+      case "--no-og":
+        a.og = false;
+        break;
+      case "-h":
+      case "--help":
+        a.help = true;
+        break;
+      default:
+        if (arg.startsWith("--")) {
+          const eq = arg.indexOf("=");
+          if (eq !== -1) {
+            const key = arg.slice(2, eq);
+            const val = arg.slice(eq + 1);
+            if (key === "name") a.name = val;
+            else if (key === "url") a.url = val;
+            else if (key === "description" || key === "desc") a.description = val;
+            else if (key === "twitter") a.twitter = val;
+            else if (key === "logo") a.logo = val;
+          }
+        }
+    }
+  }
+  return a;
+}
+var HELP = `
+${c("bold", "create-lacspace-seo")} \u2014 scaffold a full SEO setup into a Next.js app
+
+${c("bold", "Usage")}
+  npm create lacspace-seo@latest
+  npx create-lacspace-seo [options]
+
+${c("bold", "Options")}
+  --name <name>          Site / brand name
+  --url <url>            Absolute site URL (https://\u2026)
+  --description <text>   Default meta description
+  --twitter <handle>     Twitter/X handle (with or without @)
+  --logo <path>          Logo path (e.g. /logo.png)
+  --no-og                Skip the dynamic OG-image route
+  -y, --yes              Accept defaults, no prompts (needs --name & --url)
+  --force                Overwrite existing files
+  -h, --help             Show this help
+`;
+function detectLayout(root) {
+  if (existsSync(join(root, "src", "app"))) {
+    return { root, appDir: join(root, "src", "app"), libDir: join(root, "src", "lib"), usesSrc: true };
+  }
+  if (existsSync(join(root, "app"))) {
+    return { root, appDir: join(root, "app"), libDir: join(root, "lib"), usesSrc: false };
+  }
+  return null;
+}
+function isNextProject(root) {
+  const pkgPath = join(root, "package.json");
+  if (!existsSync(pkgPath)) return false;
+  try {
+    const pkg = JSON.parse(readFileSync(pkgPath, "utf8"));
+    return Boolean(pkg.dependencies?.["next"] ?? pkg.devDependencies?.["next"]);
+  } catch {
+    return false;
+  }
+}
+var q = (s) => JSON.stringify(s);
+function siteTemplate(cfg) {
+  const lines = [
+    `import { defineSite } from "@lacspace/seo";`,
+    ``,
+    `/**`,
+    ` * Your site's SEO configuration \u2014 set ONCE, used everywhere.`,
+    ` * Generated by create-lacspace-seo.`,
+    ` */`,
+    `export const site = defineSite({`,
+    `  name: ${q(cfg.name)},`,
+    `  url: ${q(cfg.url)},`
+  ];
+  if (cfg.description) lines.push(`  description: ${q(cfg.description)},`);
+  if (cfg.logo) lines.push(`  logo: ${q(cfg.logo)},`);
+  if (cfg.twitter) lines.push(`  twitter: ${q(cfg.twitter)},`);
+  if (cfg.og) lines.push(`  ogImage: "/og", // dynamic social cards \u2192 /og?title=<page>`);
+  lines.push(`  // searchUrl: ${q(cfg.url.replace(/\/$/, "") + "/search?q={search_term_string}")},`);
+  lines.push(`});`, ``);
+  return lines.join("\n");
+}
+var robotsTemplate = () => `import { robotsForSite } from "@lacspace/robots";
+import { site } from "@/lib/site";
+
+// Served at /robots.txt \u2014 flip blockAi to true to fend off AI scrapers.
+export function GET() {
+  return new Response(robotsForSite(site.config, { blockAi: false }), {
+    headers: { "content-type": "text/plain" },
+  });
+}
+`;
+var sitemapTemplate = () => `import { sitemapForSite } from "@lacspace/sitemap";
+import { site } from "@/lib/site";
+
+// Served at /sitemap.xml \u2014 add your static + dynamic routes here.
+export function GET() {
+  const xml = sitemapForSite(site.config, [
+    "/",
+    "/about",
+    // { path: "/blog", changefreq: "daily", priority: 0.8 },
+  ]);
+  return new Response(xml, { headers: { "content-type": "application/xml" } });
+}
+`;
+var feedTemplate = () => `import { rss, feedForSite } from "@lacspace/rss";
+import { site } from "@/lib/site";
+
+// Served at /feed.xml \u2014 map your posts into feed items.
+export function GET() {
+  const posts: { title: string; link: string; date: string; description?: string }[] = [
+    // { title: "Hello world", link: site.url("/blog/hello"), date: "2026-01-01" },
+  ];
+  return new Response(rss(feedForSite(site.config, "/feed.xml"), posts), {
+    headers: { "content-type": "application/rss+xml" },
+  });
+}
+`;
+var llmsTemplate = () => `import { llmsTxt } from "@lacspace/llms-txt";
+import { site } from "@/lib/site";
+
+// Served at /llms.txt \u2014 a curated map for LLMs (llmstxt.org).
+export function GET() {
+  const txt = llmsTxt({
+    title: site.config.name,
+    summary: site.config.description ?? "",
+    sections: [
+      {
+        title: "Pages",
+        links: [
+          { title: "Home", url: site.url("/") },
+          { title: "About", url: site.url("/about") },
+        ],
+      },
+    ],
+  });
+  return new Response(txt, { headers: { "content-type": "text/plain" } });
+}
+`;
+var ogTemplate = () => `import { ImageResponse } from "next/og";
+import { site } from "@/lib/site";
+
+export const runtime = "edge";
+
+// Served at /og?title=... \u2014 dynamic Open Graph card, no design tool needed.
+export function GET(req: Request) {
+  const title = new URL(req.url).searchParams.get("title") ?? site.config.name;
+  return new ImageResponse(
+    (
+      <div
+        style={{
+          width: "100%",
+          height: "100%",
+          display: "flex",
+          flexDirection: "column",
+          justifyContent: "center",
+          padding: "80px",
+          background: "linear-gradient(135deg, #0b1220, #1e293b)",
+          color: "white",
+          fontFamily: "sans-serif",
+        }}
+      >
+        <div style={{ fontSize: 68, fontWeight: 800, lineHeight: 1.1 }}>{title}</div>
+        <div style={{ marginTop: 24, fontSize: 30, opacity: 0.7 }}>{site.config.name}</div>
+      </div>
+    ),
+    { width: 1200, height: 630 },
+  );
+}
+`;
+function writePlan(plans, force) {
+  const written = [];
+  const skipped = [];
+  for (const p of plans) {
+    if (existsSync(p.path) && !force) {
+      skipped.push(p.rel);
+      continue;
+    }
+    mkdirSync(dirname(p.path), { recursive: true });
+    writeFileSync(p.path, p.content);
+    written.push(p.rel);
+  }
+  return { written, skipped };
+}
+async function main() {
+  const args = parseArgs(argv.slice(2));
+  if (args.help) {
+    stdout.write(HELP + "\n");
+    return;
+  }
+  stdout.write(`
+${c("bold", c("cyan", "\u25C6 create-lacspace-seo"))} ${c("dim", "\u2014 full SEO setup for Next.js")}
+
+`);
+  const root = cwd();
+  if (!isNextProject(root)) {
+    stdout.write(c("yellow", '! No "next" dependency found in package.json.\n'));
+    stdout.write(c("dim", "  Run this inside a Next.js App Router project.\n\n"));
+    if (args.yes) exit(1);
+  }
+  const layout = detectLayout(root);
+  if (!layout) {
+    stdout.write(c("red", "\u2717 Could not find an app/ or src/app/ directory.\n"));
+    stdout.write(c("dim", "  This scaffolder targets the Next.js App Router.\n\n"));
+    exit(1);
+    return;
+  }
+  let name = args.name;
+  let url = args.url;
+  let description = args.description;
+  let twitter = args.twitter;
+  let logo = args.logo;
+  let og = args.og;
+  if (!args.yes) {
+    const rl = createInterface({ input: stdin, output: stdout });
+    try {
+      const ask = async (label, fallback = "") => {
+        const suffix = fallback ? c("dim", ` (${fallback})`) : "";
+        const ans = (await rl.question(`${c("green", "?")} ${label}${suffix}: `)).trim();
+        return ans || fallback;
+      };
+      if (!name) name = await ask("Site / brand name", "My Site");
+      if (!url) url = await ask("Site URL", "https://example.com");
+      if (description === void 0) description = await ask("Default description") || void 0;
+      if (twitter === void 0) twitter = await ask("Twitter/X handle (optional)") || void 0;
+      if (logo === void 0) logo = await ask("Logo path (optional, e.g. /logo.png)") || void 0;
+      const ogAns = (await ask("Add dynamic OG-image route? (Y/n)", "Y")).toLowerCase();
+      og = ogAns !== "n" && ogAns !== "no";
+    } finally {
+      rl.close();
+    }
+  }
+  if (!name || !url) {
+    stdout.write(c("red", "\n\u2717 --name and --url are required (with --yes).\n\n"));
+    exit(1);
+    return;
+  }
+  const cfg = { name, url, description, twitter, logo, og };
+  const { appDir, libDir } = layout;
+  const plans = [
+    { path: join(libDir, "site.ts"), rel: relTo(root, join(libDir, "site.ts")), content: siteTemplate(cfg) },
+    { path: join(appDir, "robots.txt", "route.ts"), rel: relTo(root, join(appDir, "robots.txt", "route.ts")), content: robotsTemplate() },
+    { path: join(appDir, "sitemap.xml", "route.ts"), rel: relTo(root, join(appDir, "sitemap.xml", "route.ts")), content: sitemapTemplate() },
+    { path: join(appDir, "feed.xml", "route.ts"), rel: relTo(root, join(appDir, "feed.xml", "route.ts")), content: feedTemplate() },
+    { path: join(appDir, "llms.txt", "route.ts"), rel: relTo(root, join(appDir, "llms.txt", "route.ts")), content: llmsTemplate() }
+  ];
+  if (og) {
+    plans.push({ path: join(appDir, "og", "route.tsx"), rel: relTo(root, join(appDir, "og", "route.tsx")), content: ogTemplate() });
+  }
+  const { written, skipped } = writePlan(plans, args.force);
+  stdout.write("\n");
+  for (const w of written) stdout.write(`  ${c("green", "+")} ${w}
+`);
+  for (const s of skipped) stdout.write(`  ${c("yellow", "\u2022")} ${s} ${c("dim", "(exists, skipped \u2014 use --force)")}
+`);
+  const deps = ["@lacspace/seo", "@lacspace/robots", "@lacspace/sitemap", "@lacspace/rss", "@lacspace/llms-txt"];
+  stdout.write(`
+${c("bold", "Next steps")}
+`);
+  stdout.write(`  1. Install the SEO packages:
+`);
+  stdout.write(`     ${c("cyan", `npm i ${deps.join(" ")}`)}
+`);
+  stdout.write(`  2. Edit ${c("cyan", relTo(root, join(libDir, "site.ts")))} \u2014 that's your one source of truth.
+`);
+  stdout.write(`  3. Use it in any page:
+`);
+  stdout.write(`     ${c("dim", `import { site } from "@/lib/site";`)}
+`);
+  stdout.write(`     ${c("dim", `export const metadata = site.meta({ title: "Pricing", path: "/pricing" });`)}
+`);
+  stdout.write(`  4. Drop the sitewide JSON-LD into app/layout.tsx once:
+`);
+  stdout.write(`     ${c("dim", `import { jsonLdScript } from "@lacspace/seo";`)}
+`);
+  stdout.write(`     ${c("dim", `<script type="application/ld+json" dangerouslySetInnerHTML={{ __html: JSON.stringify(site.rootJsonLd()) }} />`)}
+`);
+  if (skipped.length) {
+    stdout.write(`
+${c("yellow", `${skipped.length} file(s) already existed`)} \u2014 re-run with ${c("cyan", "--force")} to overwrite.
+`);
+  }
+  stdout.write(`
+${c("green", "\u2713 SEO on autopilot.")} ${c("dim", "Docs: https://lacspace.com/packages")}
+
+`);
+}
+function relTo(root, p) {
+  const r = resolve(p).slice(resolve(root).length).replace(/^[/\\]/, "");
+  return r || p;
+}
+main().catch((err) => {
+  stdout.write(c("red", `
+\u2717 ${err instanceof Error ? err.message : String(err)}
+
+`));
+  exit(1);
+});

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "create-lacspace-seo",
+  "version": "1.0.0",
+  "description": "Scaffold a complete, production-ready SEO setup into a Next.js App Router app in seconds — defineSite() config plus ready-made robots.txt, sitemap.xml, feed.xml, llms.txt and a dynamic OG-image route. Zero config, zero copywriting.",
+  "type": "module",
+  "bin": {
+    "create-lacspace-seo": "./dist/index.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "create-lacspace-seo",
+    "seo",
+    "scaffold",
+    "generator",
+    "nextjs",
+    "next-seo",
+    "robots-txt",
+    "sitemap",
+    "llms-txt",
+    "rss-feed",
+    "og-image",
+    "structured-data",
+    "boilerplate",
+    "cli",
+    "typescript"
+  ],
+  "author": "Lacspace <contact@lacspace.com>",
+  "license": "SEE LICENSE IN LICENSE",
+  "homepage": "https://lacspace.com/packages",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lacspace/npm-packages.git",
+    "directory": "create-lacspace-seo"
+  },
+  "bugs": {
+    "url": "https://github.com/lacspace/npm-packages/issues"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}