create-kedge 0.11.0 → 0.11.2

package/README.md

@@ -10,9 +10,9 @@ npm create kedge@latest
 ```
 
 Run it in an empty folder, or name a new one: `npm create kedge@latest my-store`.
-The store's name comes from the folder (`--name` chooses another). It needs Node 24
-or newer and pnpm 10 or newer (`npm install --global pnpm`), and checks both
-before it writes anything.
+The store's name comes from the folder (`--name` chooses another; `--help` lists
+the options and writes nothing). It needs Node 24 or newer and pnpm 10 or newer
+(`npm install --global pnpm`), and checks both before it writes anything.
 
 ## With a coding agent
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-kedge",
-  "version": "0.11.0",
+  "version": "0.11.2",
   "license": "MIT",
   "repository": {
     "type": "git",

package/src/create.mjs

@@ -4,7 +4,7 @@
 // some dot files in a tarball, and a store needs its `.gitignore` and `.claude/`.
 import { spawnSync } from "node:child_process";
 import { randomBytes } from "node:crypto";
-import { existsSync, mkdirSync, readdirSync, readFileSync, writeFileSync } from "node:fs";
+import { existsSync, mkdirSync, readdirSync, readFileSync, realpathSync, writeFileSync } from "node:fs";
 import { basename, dirname, isAbsolute, join, resolve } from "node:path";
 
 /**
@@ -141,18 +141,68 @@ export function environmentProblem({ node, pnpm, install }) {
   return null;
 }
 
-const USAGE = `usage: create-kedge <directory> [--name <name>] [--from-packs <dir>] [--no-install] [--no-git]`;
+const USAGE = `usage: create-kedge [<directory>] [--name <name>] [--from-packs <dir>] [--no-install] [--no-git]`;
+
+const HELP = `${USAGE}
+
+  A new Kedge store from the starter, in <directory>, or in the empty folder it's run
+  in (one holding only its own dot-files, such as .git). Its name comes from the folder
+  unless --name gives one. Then pnpm install, kedge generate, and git init unless it's
+  inside a repository already, which the store joins.
+
+  --name <name>       the store's name, for its Worker, databases and queue: 2 to 40
+                      lowercase letters, digits and dashes, starting with a letter
+  --from-packs <dir>  install the @kedge packages from local packs, not npm
+  --no-install        write the files only
+  --no-git            no git init
+  --help, -h          this, writing nothing
+
+  Next: pnpm kedge check in the store; its AGENTS.md says what follows.`;
+
+/** The options with a value, and the ones without. `--yes` and `-y` are npm create's habit: accepted, nothing more. */
+const VALUED = ["--name", "--from-packs"];
+const SWITCHES = new Set(["--no-install", "--no-git", "--yes", "-y", "--help", "-h"]);
+
+/** Whether two paths are one directory; one that can't be read is no match. */
+function sameDir(a, b) {
+  try {
+    return realpathSync(a) === realpathSync(b);
+  } catch {
+    return false;
+  }
+}
 
 export function main(
   argv,
-  { template, run = spawnSync, log = console.log, error = console.error, node = process.versions.node } = {},
+  {
+    template,
+    run = spawnSync,
+    log = console.log,
+    error = console.error,
+    node = process.versions.node,
+    pwd = process.env.PWD,
+  } = {},
 ) {
+  // Help writes nothing and checks nothing: an agent asks for it before running, in the folder it
+  // means to fill, and a --help read as a scaffold made a store there (p0.11.1 row 1).
+  if (argv.some((a) => a === "--help" || a === "-h")) {
+    log(HELP);
+    return 0;
+  }
+  // An option this doesn't read is one the agent thinks changed something: refused, nothing written.
+  const unknown = argv.find(
+    (a, i) => a.startsWith("-") && !SWITCHES.has(a) && !VALUED.includes(a) && !VALUED.includes(argv[i - 1]),
+  );
+  if (unknown) {
+    error(`unknown option ${unknown}\n${USAGE}`);
+    return 2;
+  }
   const flags = new Set(argv.filter((a) => a.startsWith("--no-")));
   const value = (f) => {
     const i = argv.indexOf(f);
     return i >= 0 ? argv[i + 1] : undefined;
   };
-  const positional = argv.filter((a, i) => !a.startsWith("--") && !["--name", "--from-packs"].includes(argv[i - 1]));
+  const positional = argv.filter((a, i) => !a.startsWith("-") && !VALUED.includes(argv[i - 1]));
   // No directory: the folder it's run in, as `npm create kedge@latest` alone leaves it (p0.10.1 §1, 1).
   const target = positional[0] ?? ".";
   // Before anything is written: a half-made store on a machine that can't install it helps no one.
@@ -168,7 +218,11 @@ export function main(
   }
   const dir = resolve(target);
   const chosen = value("--name");
-  const name = chosen ?? storeNameOf(basename(dir));
+  // The folder as it was named: one reached through a link is called by the link, which $PWD keeps
+  // and the working directory resolves away (salve's /workspace links to a volume named vo-…,
+  // which became the store's name: p0.11.1 row 7). A $PWD that isn't this directory is stale.
+  const named = pwd && sameDir(pwd, process.cwd()) ? resolve(pwd, target) : dir;
+  const name = chosen ?? storeNameOf(basename(named));
   if (!chosen) log(`store name ${name}, from the folder; --name to choose another`);
   const fromPacks = value("--from-packs");
   const t = JSON.parse(readFileSync(template, "utf8"));