create-volt 0.1.0 → 0.2.0

package/README.md

@@ -30,10 +30,15 @@ Edit `public/app.js` and save — the page hot-reloads itself.
 | Flag             | Effect                                                  |
 | ---------------- | ------------------------------------------------------- |
 | `--skip-install` | Don't run the install step (scaffold files only)        |
+| `--no-git`       | Don't initialize a git repository                       |
+| `--dry-run`      | Show what would be created without writing anything      |
 | `--force`        | Scaffold into an existing non-empty directory           |
 | `-h`, `--help`   | Show help                                               |
 | `-v`, `--version`| Print the create-volt version                           |
 
+By default the new project is initialized as a git repository with one initial
+commit (skip with `--no-git`).
+
 The installer auto-detects whichever package manager invoked it
 (npm / pnpm / yarn / bun) and uses it for `install`.
 

package/index.js

@@ -37,6 +37,8 @@ ${bold("Usage")}
 
 ${bold("Options")}
   --skip-install   Don't run the package manager install step
+  --no-git         Don't initialize a git repository
+  --dry-run        Show what would be created without writing anything
   --force          Scaffold into an existing non-empty directory
   -h, --help       Show this help
   -v, --version    Show the create-volt version
@@ -62,6 +64,8 @@ if (flags.has("-v") || flags.has("--version")) {
 
 const skipInstall = flags.has("--skip-install");
 const force = flags.has("--force");
+const dryRun = flags.has("--dry-run");
+const noGit = flags.has("--no-git");
 
 const rawName = positionals[0];
 if (!rawName) die(`Please specify a project directory:\n    ${cyan("npm create volt@latest")} ${green("<project-directory>")}`);
@@ -79,16 +83,42 @@ const targetDir = path.resolve(process.cwd(), projectName);
 const appName = path.basename(targetDir);
 const templateDir = path.join(__dirname, "template");
 
+// List every file in the template, relative to its root (for dry-run preview).
+function listTemplateFiles(dir, base = dir) {
+  const out = [];
+  for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
+    const full = path.join(dir, entry.name);
+    if (entry.isDirectory()) out.push(...listTemplateFiles(full, base));
+    else out.push(path.relative(base, full));
+  }
+  return out;
+}
+
 // --- target directory checks ---
 if (fs.existsSync(targetDir)) {
   const existing = fs.readdirSync(targetDir).filter((f) => f !== ".git");
   if (existing.length && !force) {
     die(`Directory ${green(projectName)} already exists and is not empty.\n  Pass ${cyan("--force")} to scaffold into it anyway.`);
   }
-} else {
-  fs.mkdirSync(targetDir, { recursive: true });
 }
 
+// --- dry run: print the plan and exit without writing anything ---
+if (dryRun) {
+  console.log(`\n${bold("⚡ Dry run")} — would create a Volt app in ${cyan(targetDir)}\n`);
+  console.log("Would write:");
+  for (const f of listTemplateFiles(templateDir).sort()) {
+    // the shipped "gitignore" is renamed to ".gitignore" on scaffold
+    console.log("  " + dim(f === "gitignore" ? ".gitignore" : f));
+  }
+  console.log("");
+  console.log(dim(`Would ${skipInstall ? "skip dependency install" : "install dependencies"}.`));
+  console.log(dim(`Would ${noGit ? "skip git init" : "initialize a git repository with an initial commit"}.`));
+  console.log(`\n${green("✔")} Dry run complete — nothing was written.\n`);
+  process.exit(0);
+}
+
+if (!fs.existsSync(targetDir)) fs.mkdirSync(targetDir, { recursive: true });
+
 console.log(`\n${bold("⚡ Creating a new Volt app in")} ${cyan(targetDir)}\n`);
 
 // --- copy the template tree (recursive, cross-platform) ---
@@ -143,6 +173,31 @@ if (!skipInstall) {
   }
 }
 
+// --- initialize a git repository (unless skipped or already inside one) ---
+if (!noGit) {
+  const git = (gitArgs) =>
+    spawnSync("git", gitArgs, {
+      cwd: targetDir,
+      stdio: "ignore",
+      shell: process.platform === "win32",
+    });
+  const gitAvailable = git(["--version"]).status === 0;
+  const insideRepo = gitAvailable && git(["rev-parse", "--is-inside-work-tree"]).status === 0;
+  if (gitAvailable && !insideRepo) {
+    const initOk = git(["init", "-b", "main"]).status === 0 || git(["init"]).status === 0;
+    if (initOk) {
+      git(["add", "-A"]);
+      const committed = git(["commit", "-m", "Initial commit from create-volt"]).status === 0;
+      console.log(
+        green("✔") +
+          (committed
+            ? " Initialized a git repository (1 commit)\n"
+            : " Initialized a git repository (commit skipped — set git user.name/email)\n"),
+      );
+    }
+  }
+}
+
 // --- next steps ---
 const runCmd = pm === "npm" ? "npm run dev" : `${pm} dev`;
 const installCmd = pm === "yarn" ? "yarn" : `${pm} install`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-volt",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Scaffold a new Volt app — no-build, signals-based UI with Socket.io hot reload.",
   "type": "module",
   "bin": {