@clubedge/create-clubedge-app 0.1.12 → 0.2.0

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to `create-clubedge-app` are documented here.
 
+## 0.2.0
+
+- Default to Starter `v0.2.0`, which adds project identity in `site.json`, dashboard protection, rate-limited sign-in and sign-up, and lazy environment validation.
+- Write the project name to `apps/web/src/config/site.json` when the Starter provides it, instead of replacing strings in source files. Starter `v0.1.x` refs keep the previous behavior.
+
+## 0.1.13
+
 ## 0.1.12
 
 - Install the published CLI's production dependencies before invoking it in the npm smoke test.

package/README.md

@@ -12,23 +12,23 @@ The CLI downloads a tested Starter release, names the generated project, creates
 Each CLI release is tested against one specific Starter release:
 
 ```text
-create-clubedge-app v0.1.12
+create-clubedge-app v0.2.0
         |
         v
-Clubedge Starter v0.1.1
-commit 0be0c18d41f01cd011c576fb65c25711081b8ad4
+Clubedge Starter v0.2.0
+commit db15901da90d8d8a190d158c895dfe76c172b415
 ```
 
 The current relationship is:
 
 | CLI release | Default Starter release | Meaning |
 | --- | --- | --- |
-| `create-clubedge-app@0.1.12` | `clubedge-starter@v0.1.1` | The CLI's required, tested default |
+| `create-clubedge-app@0.2.0` | `clubedge-starter@v0.2.0` | The CLI's required, tested default |
 
 This means the same CLI version always scaffolds the same Starter revision by default. The CLI does not silently follow Starter `main`.
 
-The `v0.1.1` tag is expected to resolve to commit
-`0be0c18d41f01cd011c576fb65c25711081b8ad4`. The CLI verifies this before
+The `v0.2.0` tag is expected to resolve to commit
+`db15901da90d8d8a190d158c895dfe76c172b415`. The CLI verifies this before
 scaffolding with the default reference and fails rather than silently using a
 moved tag.
 
@@ -73,7 +73,7 @@ pnpm dlx @clubedge/create-clubedge-app
 ```text
 Usage: pnpm dlx @clubedge/create-clubedge-app [project-directory] [options]
 
---ref <ref>            Select a starter tag, branch, or commit (default: v0.1.1)
+--ref <ref>            Select a starter tag, branch, or commit (default: v0.2.0)
 --no-install           Skip pnpm install
 --no-git               Skip Git initialization
 -h, --help             Show help
@@ -87,9 +87,9 @@ pnpm dlx @clubedge/create-clubedge-app my-app --ref <starter-tag-or-commit>
 pnpm dlx @clubedge/create-clubedge-app my-app --no-install
 ```
 
-The target directory must be empty or not exist. The CLI will not delete or overwrite files in a non-empty target directory. The default is the tested `v0.1.1` Starter release, so the same CLI version produces the same Starter revision. Use `--ref` to explicitly select a tag, branch, or commit.
+The target directory must be empty or not exist. The CLI will not delete or overwrite files in a non-empty target directory. The default is the tested `v0.2.0` Starter release, so the same CLI version produces the same Starter revision. Use `--ref` to explicitly select a tag, branch, or commit.
 
-The default is the tested Starter release tag `v0.1.1`. Every generated project records its CLI version, Starter repository, exact Starter ref, and resolved Starter commit in `package.json` and `README.md`.
+The default is the tested Starter release tag `v0.2.0`. Every generated project records its CLI version, Starter repository, exact Starter ref, and resolved Starter commit in `package.json` and `README.md`.
 
 Use `--ref` only when you intentionally want a different Starter revision:
 
@@ -101,7 +101,7 @@ pnpm dlx @clubedge/create-clubedge-app my-app
 pnpm dlx @clubedge/create-clubedge-app my-app --ref main
 
 # Reproduce a specific Starter release or commit
-pnpm dlx @clubedge/create-clubedge-app my-app --ref v0.1.1
+pnpm dlx @clubedge/create-clubedge-app my-app --ref v0.2.0
 pnpm dlx @clubedge/create-clubedge-app my-app --ref <commit-sha>
 ```
 

package/bin/create.mjs

@@ -2,19 +2,84 @@
 
 import { cancel, intro, isCancel, outro, spinner, text } from "@clack/prompts";
 import { downloadTemplate } from "giget";
-import { cp, mkdir, readdir, readFile, writeFile } from "node:fs/promises";
+import { access, cp, mkdir, readdir, readFile, writeFile } from "node:fs/promises";
 import { spawn } from "node:child_process";
 import { basename, dirname, join, resolve } from "node:path";
 import process from "node:process";
 import { pathToFileURL } from "node:url";
 
 const starterRepository = "Clubedge/clubedge-starter";
-const defaultStarterRef = "v0.1.1";
-const defaultStarterCommit = "0be0c18d41f01cd011c576fb65c25711081b8ad4";
+const defaultStarterRef = "v0.2.0";
+const defaultStarterCommit = "db15901da90d8d8a190d158c895dfe76c172b415";
+const siteUrl = "https://clubedge.live";
+const cliUrl = "https://starter.clubedge.live";
 const packageVersion = JSON.parse(
   await readFile(new URL("../package.json", import.meta.url), "utf8"),
 ).version;
 
+/* ------------------------------------------------------------------ */
+/* Branding: big block-letter banner                                   */
+/* ------------------------------------------------------------------ */
+
+// Each glyph is 6 rows tall. Rows are padded to a common width when rendered.
+const glyphs = {
+  C: [" ██████╗", "██╔════╝", "██║     ", "██║     ", "╚██████╗", " ╚═════╝"],
+  L: ["██╗     ", "██║     ", "██║     ", "██║     ", "███████╗", "╚══════╝"],
+  U: ["██╗   ██╗", "██║   ██║", "██║   ██║", "██║   ██║", "╚██████╔╝", " ╚═════╝ "],
+  B: ["██████╗ ", "██╔══██╗", "██████╔╝", "██╔══██╗", "██████╔╝", "╚═════╝ "],
+  E: ["███████╗", "██╔════╝", "█████╗  ", "██╔══╝  ", "███████╗", "╚══════╝"],
+  D: ["██████╗ ", "██╔══██╗", "██║  ██║", "██║  ██║", "██████╔╝", "╚═════╝ "],
+  G: [" ██████╗ ", "██╔════╝ ", "██║  ███╗", "██║   ██║", "╚██████╔╝", " ╚═════╝ "],
+  S: ["███████╗", "██╔════╝", "███████╗", "╚════██║", "███████║", "╚══════╝"],
+  T: ["████████╗", "╚══██╔══╝", "   ██║   ", "   ██║   ", "   ██║   ", "   ╚═╝   "],
+  A: [" █████╗ ", "██╔══██╗", "███████║", "██╔══██║", "██║  ██║", "╚═╝  ╚═╝"],
+  R: ["██████╗ ", "██╔══██╗", "██████╔╝", "██╔══██╗", "██║  ██║", "╚═╝  ╚═╝"],
+};
+
+function renderWord(word) {
+  const letters = [...word].map((letter) => {
+    const rows = glyphs[letter];
+    const width = Math.max(...rows.map((row) => row.length));
+    return rows.map((row) => row.padEnd(width, " "));
+  });
+  return letters[0].map((_, rowIndex) => letters.map((letter) => letter[rowIndex]).join(""));
+}
+
+const colorEnabled = Boolean(process.stdout.isTTY) && !process.env.NO_COLOR && process.env.TERM !== "dumb";
+const paint = (rgb, value) => (colorEnabled ? `\x1b[38;2;${rgb.join(";")}m${value}\x1b[0m` : value);
+const dim = (value) => (colorEnabled ? `\x1b[2m${value}\x1b[0m` : value);
+const bold = (value) => (colorEnabled ? `\x1b[1m${value}\x1b[0m` : value);
+
+// Light violet -> Clubedge brand violet, top to bottom across the banner.
+const gradientFrom = [165, 140, 255];
+const gradientTo = [91, 61, 245];
+const mix = (from, to, t) => from.map((channel, index) => Math.round(channel + (to[index] - channel) * t));
+
+function showBanner() {
+  // Stay quiet when output is piped (CI, logs, scripts).
+  if (!process.stdout.isTTY) return;
+
+  const columns = process.stdout.columns ?? 80;
+  const lines = [...renderWord("CLUBEDGE"), ...renderWord("STARTER")];
+  const widest = Math.max(...lines.map((line) => line.length));
+
+  console.log("");
+  if (columns >= widest + 2) {
+    lines.forEach((line, index) => {
+      console.log(paint(mix(gradientFrom, gradientTo, index / (lines.length - 1)), line));
+    });
+  } else {
+    // Narrow terminal: compact wordmark instead of wrapping the big letters.
+    console.log(paint(gradientTo, bold("CLUBEDGE STARTER")));
+  }
+  console.log("");
+  console.log(`  ${bold("create-clubedge-app")} ${dim(`v${packageVersion}`)}  ${dim("·")}  ${paint(gradientFrom, cliUrl)}`);
+  console.log(`  ${dim("By Clubedge")}  ${dim("·")}  ${paint(gradientFrom, siteUrl)}`);
+  console.log("");
+}
+
+/* ------------------------------------------------------------------ */
+
 function showHelp() {
   console.log(`
 create-clubedge-app ${packageVersion}
@@ -40,6 +105,10 @@ Examples:
 
 Release model:
   CLI ${packageVersion} -> Starter ${defaultStarterRef}
+
+Learn more:
+  CLI      ${cliUrl}
+  Clubedge ${siteUrl}
 `);
 }
 
@@ -194,6 +263,63 @@ async function ensureTargetIsSafe(directory) {
   }
 }
 
+async function fileExists(path) {
+  try {
+    await access(path);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+/** Starter v0.2+ keeps project identity in apps/web/src/config/site.json. */
+async function customizeSiteConfig(siteConfigPath, packageName, displayName) {
+  const siteConfig = JSON.parse(await readFile(siteConfigPath, "utf8"));
+  siteConfig.name = displayName;
+  siteConfig.shortName = displayName;
+  siteConfig.description = `${displayName} application foundation.`;
+  siteConfig.serviceId = packageName;
+  siteConfig.workspaceLabel = "Application workspace";
+  await writeFile(siteConfigPath, `${JSON.stringify(siteConfig, null, 2)}\n`);
+}
+
+/** Starter v0.1.x has no site.json, so names are replaced in known source files. */
+async function customizeLegacySources(directory, displayName) {
+  const layoutPath = join(directory, "apps", "web", "src", "app", "layout.tsx");
+  const layout = await readFile(layoutPath, "utf8");
+  const customizedLayout = layout
+    .replaceAll('"Clubedge Starter"', JSON.stringify(displayName))
+    .replace(`%s \u00b7 Clubedge Starter`, `%s \u00b7 ${displayName}`)
+    .replace(
+      "A production-minded foundation for Clubedge applications.",
+      `${displayName} application foundation.`,
+    );
+  await writeFile(layoutPath, customizedLayout);
+
+  const appFiles = [
+    join(directory, "apps", "web", "src", "app", "page.tsx"),
+    join(directory, "apps", "web", "src", "app", "dashboard", "_components", "app-sidebar.tsx"),
+    join(directory, "apps", "web", "src", "app", "dashboard", "page.tsx"),
+    join(directory, "apps", "web", "src", "app", "login", "page.tsx"),
+  ];
+  for (const appFile of appFiles) {
+    let source;
+    try {
+      source = await readFile(appFile, "utf8");
+    } catch (error) {
+      if (error && typeof error === "object" && "code" in error && error.code === "ENOENT") {
+        continue;
+      }
+      throw error;
+    }
+    const customizedSource = source
+      .replaceAll("Clubedge Starter", displayName)
+      .replaceAll('>Clubedge<', `>${displayName}<`)
+      .replaceAll("Starter workspace", "Application workspace");
+    await writeFile(appFile, customizedSource);
+  }
+}
+
 async function customizeProject(
   directory,
   packageName,
@@ -232,38 +358,11 @@ async function customizeProject(
     );
   await writeFile(readmePath, customizedReadme);
 
-  const layoutPath = join(directory, "apps", "web", "src", "app", "layout.tsx");
-  const layout = await readFile(layoutPath, "utf8");
-  const customizedLayout = layout
-    .replaceAll('"Clubedge Starter"', JSON.stringify(displayName))
-    .replace(`%s \u00b7 Clubedge Starter`, `%s \u00b7 ${displayName}`)
-    .replace(
-      "A production-minded foundation for Clubedge applications.",
-      `${displayName} application foundation.`,
-    );
-  await writeFile(layoutPath, customizedLayout);
-
-  const appFiles = [
-    join(directory, "apps", "web", "src", "app", "page.tsx"),
-    join(directory, "apps", "web", "src", "app", "dashboard", "_components", "app-sidebar.tsx"),
-    join(directory, "apps", "web", "src", "app", "dashboard", "page.tsx"),
-    join(directory, "apps", "web", "src", "app", "login", "page.tsx"),
-  ];
-  for (const appFile of appFiles) {
-    let source;
-    try {
-      source = await readFile(appFile, "utf8");
-    } catch (error) {
-      if (error && typeof error === "object" && "code" in error && error.code === "ENOENT") {
-        continue;
-      }
-      throw error;
-    }
-    const customizedSource = source
-      .replaceAll("Clubedge Starter", displayName)
-      .replaceAll('>Clubedge<', `>${displayName}<`)
-      .replaceAll("Starter workspace", "Application workspace");
-    await writeFile(appFile, customizedSource);
+  const siteConfigPath = join(directory, "apps", "web", "src", "config", "site.json");
+  if (await fileExists(siteConfigPath)) {
+    await customizeSiteConfig(siteConfigPath, packageName, displayName);
+  } else {
+    await customizeLegacySources(directory, displayName);
   }
 
   const exampleEnvironment = join(directory, ".env.example");
@@ -335,22 +434,25 @@ async function createProject(options) {
 
   const relativeDirectory = process.cwd() === projectDirectory ? "." : requestedDirectory;
   outro(
-    `Created ${projectName}.\n\nNext steps:\n  cd ${relativeDirectory}\n  pnpm dev\n\nSee SETUP.md for database and provider configuration.`,
+    `Created ${projectName}.\n\nNext steps:\n  cd ${relativeDirectory}\n  pnpm dev\n\nSee SETUP.md for database and provider configuration.\n\nDocs: ${cliUrl}\nClubedge: ${siteUrl}`,
   );
 }
 
 async function main() {
   try {
     const options = parseArguments(process.argv.slice(2));
-    if (options.help) {
-      showHelp();
-      return;
-    }
     if (options.version) {
       console.log(packageVersion);
       return;
     }
 
+    showBanner();
+
+    if (options.help) {
+      showHelp();
+      return;
+    }
+
     intro("Create a project with Clubedge Starter");
     await createProject(options);
   } catch (error) {
@@ -363,4 +465,4 @@ export { customizeProject, displayNameFromPackageName, packageNameFromDirectory
 
 if (process.argv[1] && import.meta.url === pathToFileURL(resolve(process.argv[1])).href) {
   await main();
-}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clubedge/create-clubedge-app",
-  "version": "0.1.12",
+  "version": "0.2.0",
   "description": "Create a Next.js application from the Clubedge Starter reference implementation.",
   "type": "module",
   "packageManager": "pnpm@10.9.0",