create-olmo-front 0.1.0

package/README.md

@@ -0,0 +1,46 @@
+# create-olmo-front
+
+Scaffold a new [Olmo](https://gitlab.com/olmocms) Next.js frontend from
+[`olmo-front-template`](https://gitlab.com/olmocms/olmo-front-template), with
+[`@olmocms/front`](https://www.npmjs.com/package/@olmocms/front) preinstalled.
+
+## Usage
+
+```bash
+npx create-olmo-front my-site
+# or
+npm create olmo-front@latest my-site
+```
+
+Then:
+
+```bash
+cd my-site
+# edit .env.local — set OLMO_TOKEN, OLMO_FORM_TOKEN, API URLs
+npm run dev
+```
+
+## What it does
+
+1. Downloads the template from the **public** GitLab repo (via `giget` — no auth needed).
+2. Sets your project name in `package.json`.
+3. Seeds a gitignored `.env.local` from `.env.example`.
+   Staging & production env vars belong in the **Vercel dashboard**, not the repo.
+4. `git init` + first commit.
+5. `npm install` (pulls `@olmocms/front` and the rest).
+
+## Options
+
+| Flag | Description |
+| --- | --- |
+| `--ref <branch\|tag>` | Template ref to fetch (default: `main`) |
+| `--no-install` | Skip installing dependencies |
+| `--no-git` | Skip git init + first commit |
+| `-h`, `--help` | Show help |
+
+## Releasing
+
+The template repo is the single source of truth — this CLI just fetches it.
+Pin a template tag for reproducible scaffolds by publishing a tag on
+`olmo-front-template` and passing `--ref vX.Y.Z` (or bump `DEFAULT_REF` in
+`index.js`).

package/index.js

@@ -0,0 +1,155 @@
+#!/usr/bin/env node
+// create-olmo-front — scaffold a new Olmo Next.js frontend from olmo-front-template.
+//
+// Usage:
+//   npx create-olmo-front my-site
+//   npm create olmo-front@latest my-site
+//
+// Flags:
+//   --ref <branch|tag>   template ref to fetch (default: main)
+//   --no-install         skip `npm install`
+//   --no-git             skip `git init` + first commit
+//   -h, --help           show help
+
+import { existsSync, readdirSync, readFileSync, writeFileSync, copyFileSync } from 'node:fs';
+import { basename, join, resolve } from 'node:path';
+import { spawnSync } from 'node:child_process';
+import { downloadTemplate } from 'giget';
+import prompts from 'prompts';
+import pc from 'picocolors';
+
+// The template lives in a PUBLIC GitLab repo, so giget can fetch it with no auth.
+const TEMPLATE = 'gitlab:olmocms/olmo-front-template';
+const DEFAULT_REF = 'v0.1.0';
+
+function parseArgs(argv) {
+  const opts = { dir: undefined, ref: DEFAULT_REF, install: true, git: true, help: false };
+  for (let i = 0; i < argv.length; i++) {
+    const a = argv[i];
+    if (a === '--help' || a === '-h') opts.help = true;
+    else if (a === '--no-install') opts.install = false;
+    else if (a === '--no-git') opts.git = false;
+    else if (a === '--ref') opts.ref = argv[++i];
+    else if (!a.startsWith('-') && opts.dir === undefined) opts.dir = a;
+  }
+  return opts;
+}
+
+function printHelp() {
+  console.log(`
+${pc.bold('create-olmo-front')} — scaffold an Olmo Next.js frontend
+
+${pc.bold('Usage')}
+  ${pc.cyan('npx create-olmo-front')} ${pc.green('<project-directory>')} [options]
+
+${pc.bold('Options')}
+  --ref <branch|tag>   template ref to fetch (default: ${DEFAULT_REF})
+  --no-install         skip installing dependencies
+  --no-git             skip git init + first commit
+  -h, --help           show this help
+`);
+}
+
+// Derive a valid npm "name" field from the target directory.
+function toPackageName(name) {
+  return name
+    .toLowerCase()
+    .replace(/[^a-z0-9-~._]+/g, '-')
+    .replace(/^[-_.]+|[-_.]+$/g, '')
+    .slice(0, 214) || 'olmo-front-app';
+}
+
+function run(cmd, args, cwd) {
+  const r = spawnSync(cmd, args, { cwd, stdio: 'inherit', shell: process.platform === 'win32' });
+  return r.status === 0;
+}
+
+async function main() {
+  const opts = parseArgs(process.argv.slice(2));
+  if (opts.help) return printHelp();
+
+  console.log(`\n${pc.green('◆')} ${pc.bold('create-olmo-front')}\n`);
+
+  // 1. Resolve the target directory (prompt if not given).
+  let dir = opts.dir;
+  if (!dir) {
+    const res = await prompts({
+      type: 'text',
+      name: 'dir',
+      message: 'Project directory',
+      initial: 'my-olmo-site',
+    });
+    dir = res.dir;
+  }
+  if (!dir) {
+    console.log(pc.red('✖ No project directory given. Aborting.'));
+    process.exit(1);
+  }
+
+  const target = resolve(process.cwd(), dir);
+  const appName = toPackageName(basename(target));
+
+  // Refuse to write into a non-empty directory.
+  if (existsSync(target) && readdirSync(target).length > 0) {
+    console.log(pc.red(`✖ Directory ${pc.bold(dir)} already exists and is not empty.`));
+    process.exit(1);
+  }
+
+  // 2. Download the template from the public GitLab repo.
+  console.log(`${pc.dim('›')} Fetching template ${pc.cyan(`${TEMPLATE}#${opts.ref}`)} …`);
+  try {
+    await downloadTemplate(`${TEMPLATE}#${opts.ref}`, { dir: target, force: false });
+  } catch (err) {
+    console.log(pc.red(`✖ Failed to download template: ${err.message}`));
+    process.exit(1);
+  }
+
+  // 3. Personalize package.json (name + reset version). Keep "private": true — it's an app.
+  const pkgPath = join(target, 'package.json');
+  try {
+    const pkg = JSON.parse(readFileSync(pkgPath, 'utf8'));
+    pkg.name = appName;
+    pkg.version = '0.1.0';
+    writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + '\n');
+  } catch {
+    /* non-fatal: leave package.json as-is if it can't be parsed */
+  }
+
+  // 4. Seed a local, gitignored env file from the example (staging/prod live in Vercel).
+  const example = join(target, '.env.example');
+  const local = join(target, '.env.local');
+  if (existsSync(example) && !existsSync(local)) {
+    copyFileSync(example, local);
+  }
+
+  // 5. git init + first commit.
+  if (opts.git) {
+    console.log(`${pc.dim('›')} Initializing git repository …`);
+    if (run('git', ['init', '-q'], target)) {
+      run('git', ['add', '-A'], target);
+      run('git', ['commit', '-q', '-m', 'Initial commit from create-olmo-front'], target);
+    }
+  }
+
+  // 6. Install dependencies (pulls @olmocms/front and the rest).
+  if (opts.install) {
+    console.log(`${pc.dim('›')} Installing dependencies (this pulls ${pc.cyan('@olmocms/front')}) …\n`);
+    if (!run('npm', ['install'], target)) {
+      console.log(pc.yellow('\n! Dependency install failed — you can run `npm install` yourself.'));
+    }
+  }
+
+  // 7. Next steps.
+  console.log(`\n${pc.green('✔')} Created ${pc.bold(appName)} in ${pc.dim(target)}\n`);
+  console.log(pc.bold('Next steps:'));
+  console.log(`  cd ${dir}`);
+  if (!opts.install) console.log('  npm install');
+  console.log(`  ${pc.dim('# edit .env.local — set OLMO_TOKEN, OLMO_FORM_TOKEN, API URLs')}`);
+  console.log('  npm run dev\n');
+  console.log(pc.dim('Staging & production env vars belong in the Vercel dashboard, not in the repo.\n'));
+}
+
+main().catch((err) => {
+  console.error(pc.red(err?.stack || String(err)));
+  process.exit(1);
+});

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "create-olmo-front",
+  "version": "0.1.0",
+  "description": "Scaffold a new Olmo Next.js frontend from olmo-front-template, with @olmocms/front preinstalled.",
+  "type": "module",
+  "bin": {
+    "create-olmo-front": "index.js"
+  },
+  "files": [
+    "index.js"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "keywords": [
+    "olmo",
+    "olmocms",
+    "next",
+    "nextjs",
+    "create",
+    "template",
+    "scaffold",
+    "starter"
+  ],
+  "author": "Acanto",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitlab.com/olmocms/create-olmo-front.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "giget": "^1.2.5",
+    "picocolors": "^1.1.1",
+    "prompts": "^2.4.2"
+  }
+}