create-snagset 0.1.7 → 0.1.8

package/README.md

@@ -19,6 +19,11 @@ bun  create snagset my-review          # then: bun install  && bun start
 ```
 </details>
 
+Already in the folder you want it in — a fresh `git init`, say? Pass `.`
+instead of a name (`pnpm create snagset .`) and skip the `cd`. A `.git`, a
+`.DS_Store` or an editor folder is fine; anything the scaffold would
+overwrite is refused.
+
 Bring a Postgres URL — a free Neon or Supabase branch, or a local install — and
 put it in `.env` as `DATABASE_URL`. Open `http://localhost:8080` and create the
 first owner — an instance nobody has claimed shows a setup screen rather than a

package/dist/index.js

@@ -1,5 +1,6 @@
 #!/usr/bin/env node
-import { scaffold } from "./scaffold.js";
+import { relative } from "node:path";
+import { packageName, scaffold } from "./scaffold.js";
 /**
  * The bin. Argument handling and exit codes only — everything that touches the
  * filesystem is in `scaffold.ts`, which has no side effects at import time and
@@ -9,22 +10,25 @@ const target = process.argv[2];
 if (!target || target.startsWith("-")) {
     process.stderr.write("usage: create-snagset <directory>\n\n" +
         "  pnpm create snagset my-review\n" +
+        "  pnpm create snagset .          (into the directory you are in)\n" +
         "  cd my-review && pnpm install && pnpm start\n");
     process.exit(2);
 }
+let dir;
 try {
-    scaffold(target);
+    dir = scaffold(target);
 }
 catch (e) {
     process.stderr.write(`✗ ${e instanceof Error ? e.message : String(e)}\n`);
     process.exit(2);
 }
-const name = target.split("/").pop() || "snagset";
-process.stdout.write(`\n  ✓ ${name}\n\n` +
+// No `cd .` when it was scaffolded where we stand.
+const into = relative(process.cwd(), dir);
+process.stdout.write(`\n  ✓ ${packageName(dir)}\n\n` +
     `  1. Put a Postgres URL in .env as DATABASE_URL.\n` +
     `     A free Supabase or Neon project works, so does a local install;\n` +
     `     .env says which Supabase string goes where.\n\n` +
-    `  cd ${target}\n` +
+    (into ? `  cd ${into}\n` : "") +
     `  pnpm install && pnpm start\n\n` +
     `  (npm, yarn and bun work the same way.)\n\n` +
     `  Then open http://localhost:8080 and create the first owner.\n` +

package/dist/scaffold.js

@@ -1,5 +1,5 @@
 import { existsSync, mkdirSync, readdirSync, readFileSync, writeFileSync } from "node:fs";
-import { dirname, join, resolve } from "node:path";
+import { basename, dirname, join, resolve } from "node:path";
 import { fileURLToPath } from "node:url";
 import { randomBytes } from "node:crypto";
 /**
@@ -70,15 +70,35 @@ export const RENAME = {
  * A module with side effects at import time cannot be tested; the fix is not a
  * cleverer guard.
  */
+/**
+ * What may already be in the directory. `create-snagset .` runs in a folder
+ * somebody made first, and by then it usually holds a `.git` from `git init`
+ * or a `.DS_Store` from Finder — refusing those would make `.` useless. None of
+ * these is a file the template writes, so nothing here can be overwritten.
+ * The list `create-next-app` keeps, minus the files we would write over.
+ */
+export const HARMLESS = new Set([".git", ".DS_Store", "Thumbs.db", ".idea", ".vscode", "LICENSE"]);
+/**
+ * The directory's own name, made a valid npm package name. `.` has to resolve
+ * first — `create-snagset .` once meant `"name": "."` — and a folder is often
+ * called something npm refuses, like `Client Review`.
+ */
+export function packageName(dir) {
+    return (basename(dir)
+        .toLowerCase()
+        .replace(/[^a-z0-9._-]+/g, "-")
+        .replace(/^[._-]+|-+$/g, "") || "snagset");
+}
 export function scaffold(target, cwd = process.cwd()) {
     const dir = resolve(cwd, target);
     // A non-empty directory is refused rather than merged into. Merging is how a
     // scaffolder overwrites somebody's `.env`, and there is no undo for that.
-    if (existsSync(dir) && readdirSync(dir).length > 0) {
-        throw new Error(`${target} already exists and is not empty.`);
+    const clutter = existsSync(dir) ? readdirSync(dir).filter((f) => !HARMLESS.has(f)) : [];
+    if (clutter.length > 0) {
+        throw new Error(`${target} already exists and is not empty (${clutter.slice(0, 3).join(", ")}${clutter.length > 3 ? ", …" : ""}).`);
     }
     mkdirSync(join(dir, "api"), { recursive: true });
-    const name = target.split("/").pop() || "snagset";
+    const name = packageName(dir);
     // Pinned to THIS scaffolder's version, so `create-snagset@1.4.2` produces a
     // repo on `@snagset/server@1.4.2`. A caret here would let a fresh scaffold
     // resolve to a server this template has never been run against.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-snagset",
-  "version": "0.1.7",
+  "version": "0.1.8",
   "private": false,
   "type": "module",
   "description": "Scaffold your own Snagset instance. One command, Postgres included, one variable to fill in.",