create-quadrokit 0.2.3 → 0.2.4

package/README.md

@@ -14,14 +14,19 @@ bun create-quadrokit/src/index.ts --template dashboard --dir /path/to/my-app
 | Flag | Description |
 |------|-------------|
 | `--template <name>` | `dashboard` \| `website` \| `ecommerce` \| `admin-shell` |
-| `--dir <path>` | Target directory (created; must be empty) |
+| `--dir <path>` | Target directory relative to cwd (created; must be empty if it already exists) |
+| `--name <name>` | Same as `--dir` (project folder name); ignored if `--dir` is set |
+| `-y` / `--yes` | Non-interactive: requires `--template`; uses `quadro-<template>` as the directory unless `--dir` / `--name` is set; runs git init and install without prompting (override with `--no-git` / `--no-install`) |
+| `-h` / `--help` | Print usage and exit |
 | `--keep-workspace` | Keep `workspace:*` in `package.json` (for development inside the QuadroKit monorepo only) |
 | `--git` / `--no-git` | Initialize a git repo after scaffolding (skip the prompt) |
 | `--install` / `--no-install` | Run `bun install` or `npm install` after scaffolding (skip the prompt) |
 
+The banner shows **create-quadrokit**’s package version (e.g. `v0.2.2`).
+
 On start, the CLI prints a short **prerequisites** check (Node.js, Bun, Git). Node 18+ is required; Bun is optional (falls back to npm for installs). Git is only needed if you choose to init a repository.
 
-Interactive mode: run without `--template` / `--dir` to be prompted for those; you are then asked about **git** and **install** unless overridden with the flags above.
+Interactive mode: run without `--template` / `--dir` / `--name` to be prompted. If the project directory already exists and is **not empty**, you are asked again for a different name. You are then asked about **git** and **install** unless `-y` or the explicit flags above apply.
 
 ## What it does
 

package/dist/index.mjs

@@ -32,12 +32,49 @@ function checkPrereqs() {
         gitVersion,
     };
 }
-function printWelcome() {
+function readPackageVersion() {
+    try {
+        const raw = readFileSync(path.join(packageRoot(), 'package.json'), 'utf8');
+        const v = JSON.parse(raw).version;
+        return typeof v === 'string' ? v : '0.0.0';
+    }
+    catch {
+        return '0.0.0';
+    }
+}
+function printWelcome(version) {
     console.log(`
-  ${'✨'.repeat(2)}  ${'\u001b[1mcreate-quadrokit\u001b[0m'}  ${'✨'.repeat(2)}
+  ${'✨'.repeat(2)}  ${'\u001b[1mcreate-quadrokit\u001b[0m'} ${'\u001b[90m'}v${version}${'\u001b[0m'}  ${'✨'.repeat(2)}
   ${'🚀'.repeat(2)}  Scaffold a QuadroKit Vite + React app for 4D REST
 `);
 }
+function printHelp(version) {
+    const t = TEMPLATES.join(' | ');
+    console.log(`create-quadrokit v${version}
+
+Scaffold a QuadroKit Vite + React app for 4D REST.
+
+Usage:
+  create-quadrokit [options]
+  bunx create-quadrokit@latest [options]
+
+Options:
+  --template <name>     Template: ${t}
+  --dir <path>          Project directory (relative to cwd; must not exist or be empty)
+  --name <name>         Same as --dir when --dir is omitted
+  -y, --yes             Non-interactive: requires --template; uses quadro-<template> as directory
+                        unless --dir / --name; runs git init + install (override with --no-git / --no-install)
+  --git                 Initialize a git repository (skips prompt)
+  --no-git              Do not run git init
+  --install             Install dependencies after scaffold (skips prompt)
+  --no-install          Do not install dependencies
+  --keep-workspace      Keep workspace:* @quadrokit deps (monorepo development only)
+  -h, --help            Show this help
+
+If the chosen directory already exists and is not empty, you are prompted for a different name
+(unless --yes is set; then the CLI exits with an error).
+`);
+}
 function printPrereqReport(p) {
     console.log('  Prerequisites');
     const line = (ok, emoji, label, detail) => {
@@ -86,8 +123,11 @@ async function resolveBiomeJsonPath() {
 function parseArgs(argv) {
     let template;
     let dir;
+    let name;
     let keepWorkspace = false;
-    /** `undefined` = prompt later */
+    /** Non-interactive: default project dir, git init, and install (no prompts). */
+    let yes = false;
+    /** `undefined` = prompt later (unless yes) */
     let initGit;
     let installDeps;
     for (let i = 0; i < argv.length; i++) {
@@ -98,9 +138,15 @@ function parseArgs(argv) {
         else if (a === '--dir' && argv[i + 1]) {
             dir = argv[++i];
         }
+        else if (a === '--name' && argv[i + 1]) {
+            name = argv[++i];
+        }
         else if (a === '--keep-workspace') {
             keepWorkspace = true;
         }
+        else if (a === '-y' || a === '--yes') {
+            yes = true;
+        }
         else if (a === '--git') {
             initGit = true;
         }
@@ -114,7 +160,10 @@ function parseArgs(argv) {
             installDeps = false;
         }
     }
-    return { template, dir, keepWorkspace, initGit, installDeps };
+    if (!dir && name) {
+        dir = name;
+    }
+    return { template, dir, keepWorkspace, yes, initGit, installDeps };
 }
 async function pathExists(p) {
     try {
@@ -125,6 +174,68 @@ async function pathExists(p) {
         return false;
     }
 }
+/**
+ * Resolves an absolute path for the project root. Re-prompts (interactive) when the path exists
+ * as a non-empty directory or is not a directory. With --yes, exits if the path is unusable.
+ */
+async function resolveProjectDest(dirArg, template, yesFlag) {
+    let dirInput = dirArg?.trim() || undefined;
+    let retryAfterConflict = false;
+    while (true) {
+        if (!dirInput) {
+            if (yesFlag && !retryAfterConflict) {
+                dirInput = `quadro-${template}`;
+            }
+            else if (yesFlag) {
+                console.error('  ❌  With --yes, pass --dir or --name pointing at a missing or empty directory.');
+                process.exit(1);
+            }
+            else {
+                const res = await prompts({
+                    type: 'text',
+                    name: 'dir',
+                    message: retryAfterConflict
+                        ? 'That path exists and is not empty — enter a different project directory'
+                        : 'Project directory',
+                    initial: retryAfterConflict ? `quadro-${template}-2` : `quadro-${template}`,
+                });
+                if (typeof res.dir !== 'string') {
+                    process.exit(1);
+                }
+                dirInput = res.dir.trim();
+                if (!dirInput) {
+                    process.exit(1);
+                }
+            }
+        }
+        const dest = path.resolve(process.cwd(), dirInput);
+        const st = await stat(dest).catch(() => null);
+        if (!st) {
+            return dest;
+        }
+        if (!st.isDirectory()) {
+            if (yesFlag) {
+                console.error(`  ❌  Not a directory: ${dest}`);
+                process.exit(1);
+            }
+            console.log(`  ⚠️  Not a directory: ${dest}`);
+            dirInput = undefined;
+            retryAfterConflict = true;
+            continue;
+        }
+        const files = await readdir(dest);
+        if (files.length === 0) {
+            return dest;
+        }
+        if (yesFlag) {
+            console.error(`  ❌  Directory not empty: ${dest}\n      Use --dir or --name with an empty path, or remove files from that folder.`);
+            process.exit(1);
+        }
+        console.log(`  ⚠️  Directory not empty: ${dest}`);
+        dirInput = undefined;
+        retryAfterConflict = true;
+    }
+}
 async function copyTemplate(src, dest) {
     await copyTree(src, dest, { skipNames: TEMPLATE_COPY_SKIP });
 }
@@ -269,43 +380,36 @@ dist
 }
 async function main() {
     const argv = process.argv.slice(2);
-    const { template: tArg, dir: dirArg, keepWorkspace, initGit: gitFlag, installDeps: installFlag, } = parseArgs(argv);
-    printWelcome();
+    if (argv.includes('-h') || argv.includes('--help')) {
+        printHelp(readPackageVersion());
+        process.exit(0);
+    }
+    const { template: tArg, dir: dirArg, keepWorkspace, yes: yesFlag, initGit: gitFlag, installDeps: installFlag, } = parseArgs(argv);
+    printWelcome(readPackageVersion());
     const prereqs = checkPrereqs();
     printPrereqReport(prereqs);
     if (!prereqs.nodeOk) {
         console.error(`  ❌ Node.js ${MIN_NODE_MAJOR}+ is required.`);
         process.exit(1);
     }
-    const template = tArg && TEMPLATES.includes(tArg)
-        ? tArg
-        : (await prompts({
+    let template = tArg && TEMPLATES.includes(tArg) ? tArg : undefined;
+    if (!template) {
+        if (yesFlag) {
+            console.error('  ❌  --yes requires --template <name>');
+            process.exit(1);
+        }
+        const picked = await prompts({
             type: 'select',
             name: 'template',
             message: 'Template',
             choices: TEMPLATES.map((value) => ({ title: value, value })),
-        })).template;
-    if (!template) {
-        process.exit(1);
+        });
+        template = picked.template;
     }
-    const dirAns = dirArg ??
-        (await prompts({
-            type: 'text',
-            name: 'dir',
-            message: 'Project directory',
-            initial: `quadro-${template}`,
-        })).dir;
-    if (!dirAns || typeof dirAns !== 'string') {
+    if (!template) {
         process.exit(1);
     }
-    const dest = path.resolve(process.cwd(), dirAns);
-    if (await pathExists(dest)) {
-        const files = await readdir(dest);
-        if (files.length > 0) {
-            console.error(`Directory not empty: ${dest}`);
-            process.exit(1);
-        }
-    }
+    const dest = await resolveProjectDest(dirArg, template, yesFlag);
     const src = await resolveTemplateDir(template);
     if (!src) {
         console.error(`Template not found: ${template} (expected under create-quadrokit/templates or packages/templates)`);
@@ -324,16 +428,21 @@ async function main() {
     console.log(`\n  🎉  Project files are ready at ${'\u001b[1m'}${dest}${'\u001b[0m'}\n`);
     let initGit = gitFlag;
     if (initGit === undefined) {
-        const g = await prompts({
-            type: 'confirm',
-            name: 'v',
-            message: 'Initialize a git repository here?',
-            initial: true,
-        });
-        if (typeof g.v !== 'boolean') {
-            process.exit(1);
+        if (yesFlag) {
+            initGit = true;
+        }
+        else {
+            const g = await prompts({
+                type: 'confirm',
+                name: 'v',
+                message: 'Initialize a git repository here?',
+                initial: true,
+            });
+            if (typeof g.v !== 'boolean') {
+                process.exit(1);
+            }
+            initGit = g.v;
         }
-        initGit = g.v;
     }
     if (initGit) {
         if (!prereqs.gitOk) {
@@ -351,16 +460,21 @@ async function main() {
     }
     let installDeps = installFlag;
     if (installDeps === undefined) {
-        const ins = await prompts({
-            type: 'confirm',
-            name: 'v',
-            message: 'Install dependencies now?',
-            initial: true,
-        });
-        if (typeof ins.v !== 'boolean') {
-            process.exit(1);
+        if (yesFlag) {
+            installDeps = true;
+        }
+        else {
+            const ins = await prompts({
+                type: 'confirm',
+                name: 'v',
+                message: 'Install dependencies now?',
+                initial: true,
+            });
+            if (typeof ins.v !== 'boolean') {
+                process.exit(1);
+            }
+            installDeps = ins.v;
         }
-        installDeps = ins.v;
     }
     if (installDeps) {
         const useBun = prereqs.bunOk;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-quadrokit",
-  "version": "0.2.3",
+  "version": "0.2.4",
   "description": "Scaffold a QuadroKit Vite + React app from a template",
   "type": "module",
   "bin": "./dist/index.mjs",