create-rsc-kit 0.6.0 → 0.7.1

package/dist/index.js

@@ -5,7 +5,7 @@
 // several things in it that are invisible when wrong: NODE_ENV on the build,
 // @source for Tailwind, the ambient declaration for the generated engine
 // bundle. Each of those fails by producing a page that looks nearly right.
-import { existsSync, mkdirSync, readdirSync, writeFileSync } from 'node:fs';
+import { existsSync, mkdirSync, readFileSync, readdirSync, writeFileSync } from 'node:fs';
 import { dirname, join, resolve } from 'node:path';
 import { fileURLToPath } from 'node:url';
 import { spawnSync } from 'node:child_process';
@@ -13,7 +13,39 @@ import { argv, exit, stdout } from 'node:process';
 import { DEFAULT_COMPILER, HELP, HOSTS, publishedCore, assertInsideCwd, assertUsableName, defaultCore, parseArgs, } from './options.js';
 import { Prompter, bold, cyan, dim } from './prompt.js';
 import * as t from './templates.js';
-const flags = parseArgs(argv.slice(2));
+// Same treatment as a refusal from write(): a bad flag is a decision this tool
+// made, and it happens before the try/catch below because the flags are what
+// everything else is built from.
+/**
+ * This package's own version, printed so a stale one is visible.
+ *
+ * `bun create rsc-kit` is `bunx create-rsc-kit`, and bunx caches its
+ * resolution of `latest` under that key — so a machine that ran it once keeps
+ * scaffolding from whatever it downloaded then, however many releases ago.
+ * There is nothing this package can do about that, but there is something it
+ * can do about the symptom, which was a prompt offering hosts that had been
+ * removed two releases earlier and no way to tell why.
+ *
+ * Read rather than baked in: the version is only written at publish time.
+ */
+function selfVersion() {
+    try {
+        const path = join(dirname(fileURLToPath(import.meta.url)), '../package.json');
+        return `v${JSON.parse(readFileSync(path, 'utf-8')).version}`;
+    }
+    catch {
+        return '';
+    }
+}
+const flags = (() => {
+    try {
+        return parseArgs(argv.slice(2));
+    }
+    catch (error) {
+        stdout.write(`\n${bold('Cannot scaffold here.')}\n  ${error.message}\n\n`);
+        exit(1);
+    }
+})();
 if (flags.help) {
     stdout.write(HELP);
     exit(0);
@@ -21,6 +53,8 @@ if (flags.help) {
 const unattended = flags.yes === true || flags.host !== undefined;
 // Resolved once: it walks up from this file looking for the sibling package.
 const core = flags.core ?? defaultCore(dirname(fileURLToPath(import.meta.url)));
+// Started before the first question and never awaited here — see notifyIfStale.
+const staleCheck = checkForNewer();
 const options = await collect();
 try {
     write(options);
@@ -47,6 +81,7 @@ if (options.install) {
     }
 }
 report(options);
+await notifyIfStale();
 // ── ─────────────────────────────────────────────────────────────────────────
 /** Declared, not assigned: collect() runs at module top level, above this. */
 function basename(path) {
@@ -77,11 +112,11 @@ async function collect() {
             HELP);
         exit(1);
     }
-    stdout.write(`\n${bold('Create an RSC app')}\n\n`);
+    stdout.write(`\n${bold('Create an RSC app')} ${dim(selfVersion())}\n\n`);
     const p = new Prompter();
     try {
         const dir = flags.dir ?? (await p.text('Directory', 'my-app'));
-        const host = await p.select('Server', HOSTS);
+        const host = await p.select('Where will it run', HOSTS);
         // Yes/no, not which: see DEFAULT_COMPILER.
         const compiler = flags.compiler ?? ((await p.confirm('React Compiler', true)) ? DEFAULT_COMPILER : 'none');
         const tailwind = flags.tailwind ?? (await p.confirm('Tailwind CSS', true));
@@ -165,6 +200,8 @@ function report(o) {
     const steps = [
         `cd ${relativeish(o.dir)}`,
         ...(o.install ? [] : [o.host === 'node' ? 'npm install' : 'bun install']),
+        // dev first: it is what someone wants next, and it needs no build.
+        `${pm} dev`,
         `${pm} build`,
         // A Worker has no start: wrangler runs it on workerd, or deploys it.
         ...(o.host === 'worker' ? [`${pm} preview`, `${pm} deploy`] : [`${pm} start`]),
@@ -172,7 +209,62 @@ function report(o) {
     stdout.write(`\n${bold('Done.')} ${dim(o.dir)}\n\n`);
     for (const step of steps)
         stdout.write(`  ${cyan(step)}\n`);
-    stdout.write(`\n${dim('The route tree is read at build time — rebuild after adding a page under src/app.')}\n\n`);
+    stdout.write(`\n${dim('Pages live in src/app. Where it deploys is the Nitro preset in vite.config.ts.')}\n\n`);
+}
+/**
+ * Ask the registry what `latest` is, so a stale copy can say so.
+ *
+ * Printing the version alone does not help: nobody knows 0.5.0 is two behind
+ * unless something tells them.
+ *
+ * `bun create rsc-kit` is `bunx create-rsc-kit`, and bunx reuses what it
+ * downloaded the first time — a machine that ran this once keeps scaffolding
+ * from that copy however many releases later. Writing the tag out is what
+ * makes it revalidate. Measured against a 0.6.0 planted in the cache:
+ *
+ *   bun create rsc-kit             stale
+ *   bunx create-rsc-kit            stale
+ *   bun create rsc-kit@latest      fresh
+ *   bunx create-rsc-kit@latest     fresh
+ *   npx create-rsc-kit@latest      fresh
+ *
+ * So the escape is one word, and this is what tells someone to use it — the
+ * form without it is the one every set of install instructions writes.
+ *
+ * create-next-app does this with the `update-check` package. Not here: this
+ * package is installed by bunx before it can ask anything, so a dependency is
+ * latency every user waits through — the same reason the prompts are written
+ * against readline. It is one request.
+ *
+ * Started before the first prompt and read after the last, so it costs nothing
+ * — a person answering questions is slower than a registry. Failure is
+ * silence: offline, behind a proxy, or a registry that is down are all just no
+ * notice rather than a scaffolder that will not run.
+ */
+function checkForNewer() {
+    // Unknown is not stale. selfVersion() answers '' when it cannot read the
+    // manifest, and comparing against that would report every run as behind.
+    const mine = selfVersion().slice(1);
+    if (!mine)
+        return Promise.resolve(null);
+    return (async () => {
+        const response = await fetch('https://registry.npmjs.org/create-rsc-kit/latest', {
+            signal: AbortSignal.timeout(3000),
+            headers: { accept: 'application/json' },
+        });
+        if (!response.ok)
+            return null;
+        const latest = (await response.json()).version;
+        return latest && latest !== mine ? latest : null;
+    })().catch(() => null);
+}
+async function notifyIfStale() {
+    const latest = await staleCheck;
+    if (!latest)
+        return;
+    stdout.write(`${dim('A newer create-rsc-kit is out:')} ${bold(`v${latest}`)}${dim(`, and this is ${selfVersion()}.`)}\n` +
+        `${dim('bunx reuses the copy it downloaded first. Name the tag and it fetches:')}\n\n` +
+        `  ${cyan('bun create rsc-kit@latest')}\n\n`);
 }
 /** A path the user can paste, when it is under where they are. */
 function relativeish(dir) {

package/dist/options.d.ts

@@ -93,4 +93,4 @@ export declare function assertUsableName(name: string): void;
  * generator nobody can run without reading it first.
  */
 export declare function assertInsideCwd(dir: string, cwd: string): void;
-export declare const HELP = "\n  create-rsc-kit \u2014 scaffold an RSC app\n\n  Usage\n    create-rsc-kit <dir> [options]\n    bun create rsc-kit <dir> [options]   (once published)\n\n  Options\n    --host=bun|hono|elysia|node   which server to generate\n    --compiler=none|oxc|babel     React Compiler (prompt offers oxc; babel by flag)\n    --tailwind / --no-tailwind    include Tailwind\n    --lint / --no-lint            include oxlint\n    --source-dir <dir>            where app/ lives (default: src)\n    --init                        add to the project here, rather than scaffold\n    --core=<spec>                 engine dependency, e.g. file:../rsc-kit/packages/core\n    --no-install                  skip installing dependencies\n    --no-git                      skip git init\n    -y, --yes                     accept every default, ask nothing\n    -h, --help                    this\n";
+export declare const HELP = "\n  create-rsc-kit \u2014 scaffold an RSC app\n\n  Usage\n    create-rsc-kit <dir> [options]\n    bun create rsc-kit@latest <dir> [options]\n\n  Options\n    --host=bun|node|worker        where it runs \u2014 picks the Nitro preset\n    --compiler=none|oxc|babel     React Compiler (prompt offers oxc; babel by flag)\n    --tailwind / --no-tailwind    include Tailwind\n    --lint / --no-lint            include oxlint\n    --source-dir <dir>            where app/ lives (default: src)\n    --init                        add to the project here, rather than scaffold\n    --core=<spec>                 engine dependency, e.g. file:../rsc-kit/packages/core\n    --no-install                  skip installing dependencies\n    --no-git                      skip git init\n    -y, --yes                     accept every default, ask nothing\n    -h, --help                    this\n";

package/dist/options.js

@@ -12,8 +12,20 @@ import { fileURLToPath } from 'node:url';
 export const HOSTS = [
     { value: 'bun', label: 'Bun', hint: 'and compiles to a single binary' },
     { value: 'node', label: 'Node', hint: 'the default everywhere else' },
-    { value: 'worker', label: 'Cloudflare Workers', hint: 'no filesystem — assets from a binding' },
+    { value: 'worker', label: 'Cloudflare Workers', hint: 'deployed with wrangler, not started' },
 ];
+/**
+ * `--host` reaches `preset()`, which has a fallback branch — so an unknown
+ * value would not fail, it would quietly scaffold a Bun app. The names that
+ * used to be valid here (`hono`, `elysia`) are exactly the ones someone still
+ * has in a script, so being told is the point.
+ */
+function assertHost(value) {
+    if (value === 'laravel' || HOSTS.some((host) => host.value === value))
+        return value;
+    throw new Error(`Unknown --host=${value}. Pick one of: ${HOSTS.map((host) => host.value).join(', ')}. ` +
+        'Anywhere else is a Nitro preset in vite.config.ts, not a flag here.');
+}
 /**
  * Not asked as a three-way.
  *
@@ -117,7 +129,7 @@ export function parseArgs(argv) {
         else if (arg === '--no-tailwind')
             out.tailwind = false;
         else if (arg.startsWith('--host='))
-            out.host = arg.slice(7);
+            out.host = assertHost(arg.slice(7));
         else if (arg.startsWith('--compiler='))
             out.compiler = arg.slice(11);
         else if (arg.startsWith('--core='))
@@ -164,10 +176,10 @@ export const HELP = `
 
   Usage
     create-rsc-kit <dir> [options]
-    bun create rsc-kit <dir> [options]   (once published)
+    bun create rsc-kit@latest <dir> [options]
 
   Options
-    --host=bun|hono|elysia|node   which server to generate
+    --host=bun|node|worker        where it runs — picks the Nitro preset
     --compiler=none|oxc|babel     React Compiler (prompt offers oxc; babel by flag)
     --tailwind / --no-tailwind    include Tailwind
     --lint / --no-lint            include oxlint

package/dist/templates.js

@@ -175,9 +175,11 @@ export function viteConfig(o) {
     // and rscKit tells plugin-rsc not to install a handler competing for that
     // role. serveStatic: 'inline' embeds the built assets, without which a
     // compiled binary serves pages and 404s every asset.
+    //
+    // Not optional, and not a flag on rscKit() either — the plugin builds for
+    // Nitro and nothing else, so a config without this line has no server.
     plugins.push(`nitro({ preset: ${JSON.stringify(preset(o.host))}, serveStatic: 'inline' })`);
     plugins.push(`rscKit({
-      nitro: true,
       ${options.join(',\n      ')},
     })`);
     plugins.push(o.compiler === 'oxc' ? 'react({ compiler: true })' : 'react()');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-rsc-kit",
-  "version": "0.6.0",
+  "version": "0.7.1",
   "type": "module",
   "description": "Scaffold an RSC app on Bun, Hono, Elysia or Node.",
   "bin": {