@bill742/create-nextstarter 1.0.0

package/README.md

@@ -0,0 +1,24 @@
+# create-nextstarter
+
+Scaffold a new [NextStarter](https://github.com/bill742/nextstarter) project with a single command.
+
+## Usage
+
+```bash
+npx create-nextstarter my-project
+cd my-project
+npm run dev
+```
+
+## What it does
+
+1. Clones the NextStarter template
+2. Cleans up template-only files (`.git`, `CLAUDE.md`, `CHANGELOG.md`, etc.)
+3. Copies `.env.example` → `.env`
+4. Sets the project `name` and `version` in `package.json`
+5. Optionally runs `npm install`
+
+## Requirements
+
+- Node.js 18 or higher
+- Git

package/bin/create-nextstarter.js

@@ -0,0 +1,21 @@
+#!/usr/bin/env node
+
+// Node version check
+const nodeMajor = parseInt(process.versions.node.split(".")[0], 10);
+if (nodeMajor < 18) {
+  console.error("Error: Node.js 18 or higher is required.");
+  process.exit(1);
+}
+
+const { createNextStarter } = require("../src/index.js");
+
+const args = process.argv.slice(2);
+const projectName = args[0];
+
+if (!projectName || projectName === "--help" || projectName === "-h") {
+  console.log("Usage: create-nextstarter <project-name>");
+  console.log("Example: npx create-nextstarter my-project");
+  process.exit(projectName ? 0 : 1);
+}
+
+createNextStarter(projectName);

package/package.json

@@ -0,0 +1,16 @@
+{
+  "bin": {
+    "create-nextstarter": "bin/create-nextstarter.js"
+  },
+  "description": "Create a new project from the NextStarter boilerplate",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "files": [
+    "bin/",
+    "src/"
+  ],
+  "license": "MIT",
+  "name": "@bill742/create-nextstarter",
+  "version": "1.0.0"
+}

package/src/index.js

@@ -0,0 +1,131 @@
+const fs = require("node:fs");
+const path = require("node:path");
+const { execSync } = require("node:child_process");
+const readline = require("node:readline");
+
+const TEMPLATE_REPO = "https://github.com/bill742/nextstarter.git";
+
+const CLEANUP_PATHS = [
+  ".git",
+  "node_modules",
+  ".next",
+  ".env",
+  ".skills",
+  "CLAUDE.md",
+  "CHANGELOG.md",
+  "playwright-report",
+  "test-results",
+  "package-lock.json",
+];
+
+/**
+ * Removes a file or directory recursively.
+ * @param {string} targetPath - Absolute path to remove.
+ */
+function removePath(targetPath) {
+  if (fs.existsSync(targetPath)) {
+    fs.rmSync(targetPath, { recursive: true, force: true });
+  }
+}
+
+/**
+ * Prompts the user with a question and returns their answer.
+ * @param {string} question - The question to display.
+ * @returns {Promise<string>} The user's input.
+ */
+function prompt(question) {
+  const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout,
+  });
+  return new Promise((resolve) => {
+    rl.question(question, (answer) => {
+      rl.close();
+      resolve(answer);
+    });
+  });
+}
+
+/**
+ * Main orchestration function for scaffolding a new NextStarter project.
+ * @param {string} projectName - The name of the new project directory.
+ */
+async function createNextStarter(projectName) {
+  // Validate project name
+  if (/\s/.test(projectName)) {
+    console.error("Error: Project name must not contain spaces.");
+    process.exit(1);
+  }
+
+  const targetDir = path.resolve(process.cwd(), projectName);
+
+  if (fs.existsSync(targetDir)) {
+    console.error(`Error: Directory "${projectName}" already exists.`);
+    process.exit(1);
+  }
+
+  console.log(`\nCreating a new NextStarter project in ./${projectName}...\n`);
+
+  // Step 1: Clone template
+  try {
+    execSync(`git clone --depth=1 ${TEMPLATE_REPO} ${projectName}`, {
+      stdio: "pipe",
+    });
+    console.log("  \u2713 Cloning template");
+  } catch (err) {
+    console.error("Error: Failed to clone template repository.");
+    console.error(err.stderr?.toString() ?? err.message);
+    process.exit(1);
+  }
+
+  // Step 2: Clean up unwanted files
+  for (const relPath of CLEANUP_PATHS) {
+    removePath(path.join(targetDir, relPath));
+  }
+  console.log("  \u2713 Cleaning up");
+
+  // Step 3: Copy .env.example → .env
+  const envExample = path.join(targetDir, ".env.example");
+  const envTarget = path.join(targetDir, ".env");
+  if (fs.existsSync(envExample)) {
+    fs.copyFileSync(envExample, envTarget);
+  }
+  console.log("  \u2713 Setting up .env");
+
+  // Step 4: Rewrite package.json
+  const pkgPath = path.join(targetDir, "package.json");
+  if (fs.existsSync(pkgPath)) {
+    const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf8"));
+    pkg.name = projectName;
+    pkg.version = "0.1.0";
+    fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + "\n");
+  }
+  console.log("  \u2713 Updating package.json");
+
+  // Step 5: Prompt to install dependencies
+  const answer = await prompt("\n? Install dependencies now? (Y/n) ");
+  const shouldInstall = answer.trim().toLowerCase() !== "n";
+
+  if (shouldInstall) {
+    try {
+      execSync("npm install", { cwd: targetDir, stdio: "inherit" });
+      console.log("\n  \u2713 Dependencies installed");
+    } catch (err) {
+      console.error("Error: npm install failed.");
+      process.exit(1);
+    }
+  }
+
+  // Step 6: Print next steps
+  console.log("\nDone! Your project is ready.\n");
+  console.log(`  cd ${projectName}`);
+  if (!shouldInstall) {
+    console.log("  npm install");
+  }
+  console.log("  npm run dev\n");
+  console.log(
+    "Edit .env to set NEXT_PUBLIC_SITE_URL and NEXT_PUBLIC_SITE_NAME before deploying.",
+  );
+}
+
+module.exports = { createNextStarter };