@doikayt/typescript-build-config 0.1.16 → 0.1.18

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@doikayt/typescript-build-config",
-  "version": "0.1.16",
+  "version": "0.1.18",
   "description": "Shared build configuration for TypeScript projects — ESLint, Prettier, tsconfig, and Playwright presets",
   "_comments": {
     "exports": "This block lists the config files that will be extended by files in in src/toplevel - which are copied to consuming project root folder. An example: eslint.config.js imports from '@doikayt/typescript-build-config/eslint'.",

package/src/init.js

@@ -42,33 +42,74 @@ function dirIsEmpty(dir) {
   return !existsSync(dir) || readdirSync(dir).length === 0;
 }
 
-// Default interactive prompt. Injectable so runInit is testable without stdin.
-async function askYesNo(question) {
+// Default interactive prompt. Buffers input lines as they arrive and lets each
+// question pull the next one, so it works with both a live terminal and piped /
+// non-interactive stdin (scripts, CI). `rl.question` alone drops lines that
+// arrive before the next call — with a pipe every line lands at once, which made
+// init silently no-op. On EOF, unanswered prompts default to No. Injectable, so
+// runInit stays testable without stdin.
+function createAskYesNo() {
   const rl = createInterface({ input: process.stdin, output: process.stdout });
-  try {
-    const answer = await new Promise((res) => rl.question(question, res));
-    return /^y(es)?$/i.test(answer.trim());
-  } finally {
-    rl.close();
-  }
+  const lines = []; // input lines not yet consumed by a prompt
+  const waiters = []; // prompt resolvers waiting for the next line
+  let closed = false;
+  rl.on("line", (line) => {
+    const waiter = waiters.shift();
+    if (waiter) waiter(line);
+    else lines.push(line);
+  });
+  rl.on("close", () => {
+    closed = true;
+    while (waiters.length) waiters.shift()("");
+  });
+  const ask = (question) =>
+    new Promise((res) => {
+      process.stdout.write(question);
+      const answer = (line) => res(/^y(es)?$/i.test(line.trim()));
+      if (lines.length) answer(lines.shift());
+      else if (closed) answer("");
+      else waiters.push(answer);
+    });
+  ask.close = () => rl.close();
+  return ask;
 }
 
 export async function runInit({
   cwd = process.cwd(),
-  prompt = askYesNo,
+  prompt,
   resolveDevVersions = resolveVersions,
   log = console.log,
 } = {}) {
+  // One readline interface for all prompts (see createAskYesNo); close it even
+  // on error so a leftover interface never keeps the process alive.
+  const ownAsk = prompt ? null : createAskYesNo();
+  const ask = prompt ?? ownAsk;
+  try {
+    return await collectAndScaffold({ cwd, ask, resolveDevVersions, log });
+  } finally {
+    ownAsk?.close();
+  }
+}
+
+async function collectAndScaffold({ cwd, ask, resolveDevVersions, log }) {
   const pkgPath = resolve(cwd, "package.json");
   const raw = readFileSync(pkgPath, "utf8");
 
-  const ui = await prompt(
-    "Is this a UI project that needs Playwright (e2e)? [y/N] ",
+  // Collect every answer up front, before doing any work or printing next
+  // steps, so the flow reads: ask everything → act → report.
+  const ui = await ask(
+    "Is this a UI project that needs Playwright (e2e)? Default is No. [y/N] ",
+  );
+
+  const library = await ask(
+    "Is this a publishable library (published to npm)? Default is No\n" +
+      "  — a non-library (an app/CLI) is marked private so it is never published. [y/N] ",
   );
 
-  const library = await prompt(
-    "Is this a publishable library (published to npm)? Apps/CLIs answer No and\n" +
-      "are marked private so they are never published. [y/N] ",
+  const wantDemo = await ask(
+    "Scaffold a starter demo (minimal src module + README + project.json) so\n" +
+      "you can build, test, and release immediately? Default is No; existing\n" +
+      "files are never overwritten. [y/N] ",
   );
 
   const scripts = canonicalScripts({ ui, library });
@@ -78,6 +119,13 @@ export async function runInit({
     scripts,
     devDependencies,
     fields: packageFields({ library }),
+    // `npm init -y` seeds these placeholders; treat them as unset so the
+    // canonical `test` script and (for a library) `main` replace them instead of
+    // shadowing them.
+    replaceDefaults: {
+      scripts: { test: 'echo "Error: no test specified" && exit 1' },
+      fields: { main: "index.js" },
+    },
   });
   writeFileSync(pkgPath, text);
 
@@ -90,6 +138,16 @@ export async function runInit({
     (result === "seeded" ? seededConfigs : keptConfigs).push(name);
   }
 
+  const demo = wantDemo
+    ? scaffoldDemo({ cwd })
+    : {
+        scaffolded: false,
+        reason: "declined",
+        wrote: [],
+        skipped: [],
+        paths: [],
+      };
+
   const report = (label, keys) => {
     if (keys.length) log(`${label}: ${keys.join(", ")}`);
   };
@@ -101,28 +159,28 @@ export async function runInit({
   report("Kept existing package fields", skipped.fields);
   report("Seeded config files", seededConfigs);
   report("Kept existing config files", keptConfigs);
-  log("");
-  log("Next: run `npm install` to fetch the newly declared devDependencies.");
+  report("Demo seeded", demo.wrote);
+  report("Demo kept existing", demo.skipped);
 
-  const demo = await maybeScaffoldDemo({ cwd, prompt, log });
+  log("");
+  if (demo.scaffolded) {
+    log(
+      "Next: `npm install`, then `npm test` and `npm run update-all-format`, " +
+        "then commit and push to cut a release.",
+    );
+    log(`To remove the starter files later: rm -r ${demo.paths.join(" ")}`);
+  } else {
+    log("Next: run `npm install` to fetch the newly declared devDependencies.");
+  }
 
   return { added, skipped, seededConfigs, keptConfigs, demo };
 }
 
-// Opt-in starter scaffold for a new project. Seeds a minimal src/ module, a
-// README with doc-generator markers, and a project.json — each independently and
-// only when its slot is empty, so nothing a consumer already has is overwritten.
-// It writes files only; the user runs npm install / test / push themselves.
-async function maybeScaffoldDemo({ cwd, prompt, log }) {
-  const wantDemo = await prompt(
-    "Scaffold a starter demo (minimal src module + README + project.json) so you\n" +
-      "can build, test, and release immediately? Existing files are never\n" +
-      "overwritten. [y/N] ",
-  );
-  if (!wantDemo) {
-    return { scaffolded: false, reason: "declined", wrote: [], skipped: [] };
-  }
-
+// Seed a minimal starter into a new project: a src/ module, a README with
+// doc-generator markers, and a project.json — each independently and only when
+// its slot is empty, so nothing a consumer already has is overwritten. Writes
+// files only and returns what it did; the caller reports and prints next steps.
+function scaffoldDemo({ cwd }) {
   const demoTemplate = resolve(templatesDir, "demo");
   const wrote = [];
   const skipped = [];
@@ -152,13 +210,5 @@ async function maybeScaffoldDemo({ cwd, prompt, log }) {
     }
   }
 
-  log("");
-  if (wrote.length) log(`Demo: seeded ${wrote.join(", ")}.`);
-  if (skipped.length) log(`Demo: kept existing ${skipped.join(", ")}.`);
-  if (paths.length) {
-    log(`To remove the starter files later: rm -r ${paths.join(" ")}`);
-    log("Then: npm install → npm test → npm run update-all-format → push.");
-  }
-
   return { scaffolded: paths.length > 0, reason: null, wrote, skipped, paths };
 }

package/src/package-json.js

@@ -38,14 +38,33 @@ export function detectIndent(text) {
  *   added: { scripts: string[], devDependencies: string[], fields: string[] },
  *   skipped: { scripts: string[], devDependencies: string[], fields: string[] }
  * }} new file text, plus keys added vs. skipped (already present)
+ *
+ * `replaceDefaults` names placeholder values that `npm init -y` inserts (e.g.
+ * `scripts.test: 'echo "Error: no test specified" && exit 1'`, `main: "index.js"`).
+ * A key whose current value exactly equals its placeholder is treated as unset,
+ * so a canonical value can replace it instead of being skipped as "present".
  */
 export function applyToPackageJson(
   rawText,
-  { scripts = {}, devDependencies = {}, fields = {} } = {},
+  {
+    scripts = {},
+    devDependencies = {},
+    fields = {},
+    replaceDefaults = {},
+  } = {},
 ) {
   const pkg = JSON.parse(rawText);
   const indent = detectIndent(rawText);
 
+  const stripDefaults = (obj, defaults = {}) => {
+    if (!obj) return;
+    for (const [key, placeholder] of Object.entries(defaults)) {
+      if (obj[key] === placeholder) delete obj[key];
+    }
+  };
+  stripDefaults(pkg, replaceDefaults.fields);
+  stripDefaults(pkg.scripts, replaceDefaults.scripts);
+
   const s = mergeAbsent(pkg.scripts, scripts);
   const d = mergeAbsent(pkg.devDependencies, devDependencies);
   const f = mergeAbsent(pkg, fields);