create-nexwire 4.2.5 → 4.3.0

package/hono/src/resources/vite.config.ts

@@ -1,53 +1,64 @@
 import path from "node:path";
 import { fileURLToPath, URL } from "node:url";
 import vue from "@vitejs/plugin-vue";
-import { defineConfig } from "vite";
+import { defineConfig, loadEnv } from "vite";
 
-const cacheBase = process.env.LOCALAPPDATA || process.env.TEMP || ".";
-const apiUrl = process.env.APP_URL || "http://localhost:3000";
-const socketEnabled = process.env.SOCKET !== "false";
+const configDir = path.dirname(fileURLToPath(import.meta.url));
+const projectRoot = path.resolve(configDir, "../..");
 
-const proxy: Record<string, any> = {
-  "/api": { target: apiUrl, changeOrigin: true },
-  "/health": { target: apiUrl, changeOrigin: true },
-  "/storage": { target: apiUrl, changeOrigin: true }
-};
+export default defineConfig(({ mode }) => {
+  // 1. Load the .env file just like the backend does. Resolve it from the
+  // config file so a different process cwd cannot point Vite at the wrong .env.
+  const env = loadEnv(mode, projectRoot, "");
 
-proxy["/socket.io"] = { target: apiUrl, changeOrigin: true, ws: true };
+  const cacheBase = process.env.LOCALAPPDATA || process.env.TEMP || ".";
+  const apiUrl = env.APP_URL || "http://localhost:3000";
 
-export default defineConfig({
-  define: {
-    __SOCKET_ENABLED__: socketEnabled,
-    __API_URL__: JSON.stringify(apiUrl)
-  },
-  root: fileURLToPath(new URL(".", import.meta.url)),
-  cacheDir: path.join(cacheBase, "nexwire", "vite-cache", "resources"),
-  plugins: [vue()],
-  css: {
-    preprocessorOptions: {
-      scss: {
-        quietDeps: true,
-        silenceDeprecations: [
-          "import",
-          "if-function",
-          "global-builtin",
-          "color-functions",
-          "slash-div",
-        ],
+  // Match the backend default: Socket.IO is off unless SOCKET=true
+  const socketEnabled = env.SOCKET === "true";
+
+  const proxy: Record<string, any> = {
+    "/api": { target: apiUrl, changeOrigin: true },
+    "/health": { target: apiUrl, changeOrigin: true },
+    "/storage": { target: apiUrl, changeOrigin: true }
+  };
+
+  if (socketEnabled) {
+    proxy["/socket.io"] = { target: apiUrl, changeOrigin: true, ws: true, timeout: 10000 };
+  }
+
+  return {
+    define: {
+      // 3. ALWAYS stringify the value when using Vite define
+      // `import.meta.env.*` is inlined into every module in dev as well as in
+      // the production bundle, so the UI never depends on a stale global.
+      "import.meta.env.VITE_SOCKET_ENABLED": JSON.stringify(socketEnabled),
+      __SOCKET_ENABLED__: JSON.stringify(socketEnabled),
+      __API_URL__: JSON.stringify(apiUrl)
+    },
+    root: fileURLToPath(new URL(".", import.meta.url)),
+    cacheDir: path.join(cacheBase, "nexwire", "vite-cache", "resources"),
+    plugins: [vue()],
+    css: {
+      preprocessorOptions: {
+        scss: {
+          quietDeps: true,
+          silenceDeprecations: ["import", "if-function", "global-builtin", "color-functions", "slash-div"]
+        }
       }
+    },
+    resolve: {
+      alias: {
+        "@": fileURLToPath(new URL("./src", import.meta.url))
+      }
+    },
+    build: {
+      outDir: "../../public",
+      emptyOutDir: true
+    },
+    server: {
+      port: 5173,
+      proxy // /socket.io is only proxied when SOCKET=true
     }
-  },
-  resolve: {
-    alias: {
-      "@": fileURLToPath(new URL("./src", import.meta.url))
-    }
-  },
-  build: {
-    outDir: "../../public",
-    emptyOutDir: true
-  },
-  server: {
-    port: 5173,
-    proxy
-  }
+  };
 });

package/hono/src/types/global.d.ts

@@ -1,26 +1,32 @@
-declare module "*.vue" {
-  import type { DefineComponent } from "vue";
-
-  const component: DefineComponent<Record<string, unknown>, Record<string, unknown>, unknown>;
-  export default component;
-}
-
-declare module "bootstrap/js/dist/modal.js" {
-  export default class Modal {
-    constructor(element: Element, options?: { backdrop?: boolean | "static"; keyboard?: boolean });
-    show(): void;
-    hide(): void;
-    dispose(): void;
-  }
-}
-
-declare module "bootstrap/js/dist/toast.js" {
-  export default class Toast {
-    static getOrCreateInstance(element: Element): Toast;
-    show(): void;
-  }
-}
-
-declare module "luxon";
-declare module "nodemailer";
-declare module "vue-select";
+declare module "*.vue" {
+  import type { DefineComponent } from "vue";
+
+  const component: DefineComponent<Record<string, unknown>, Record<string, unknown>, unknown>;
+  export default component;
+}
+
+declare module "bootstrap/js/dist/modal.js" {
+  export default class Modal {
+    constructor(element: Element, options?: { backdrop?: boolean | "static"; keyboard?: boolean });
+    show(): void;
+    hide(): void;
+    dispose(): void;
+  }
+}
+
+declare module "bootstrap/js/dist/toast.js" {
+  export default class Toast {
+    static getOrCreateInstance(element: Element): Toast;
+    show(): void;
+  }
+}
+
+declare module "luxon";
+declare module "nodemailer";
+declare module "vue-select";
+
+interface ImportMetaEnv {
+  readonly VITE_API_URL?: string;
+  readonly VITE_SOCKET_URL?: string;
+  readonly VITE_SOCKET_ENABLED?: boolean;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-nexwire",
-  "version": "4.2.5",
+  "version": "4.3.0",
   "type": "module",
   "description": "Scaffold a new nexwire project",
   "bin": {
@@ -72,7 +72,7 @@
     "ioredis": "^5",
     "lodash-es": "^4",
     "luxon": "^3",
-    "maildev": "^3",
+    "maildev": "^2.2.1",
     "mysql2": "^3",
     "nodemailer": "^10",
     "pinia": "^3",

package/src/index.js

@@ -3,7 +3,7 @@
 import { readFileSync, existsSync, cpSync, mkdirSync, writeFileSync, renameSync, readdirSync, rmSync } from "node:fs";
 import { join, dirname, basename } from "node:path";
 import { fileURLToPath } from "node:url";
-import { createInterface } from "node:readline";
+import { createInterface, emitKeypressEvents } from "node:readline";
 import { gunzipSync } from "node:zlib";
 import https from "node:https";
 
@@ -18,6 +18,104 @@ function ask(query) {
   return new Promise((resolve) => rl.question(query, (a) => { rl.close(); resolve(a.trim()); }));
 }
 
+// Keep this in sync with the packages/ directories shipped in the tarball and
+// with ENGINE_PREFIXES below. A future frontend adds its own list here and its
+// own prefix inside extractTarGz.
+const BACKENDS = [
+  { value: "hono", label: "Hono", hint: "Hono-based HTTP layer and OpenAPI" },
+  { value: "express", label: "Express", hint: "Express-based HTTP layer and OpenAPI" }
+];
+
+const BACKEND_NAMES = BACKENDS.map((b) => b.value);
+
+function backendIndex(value) {
+  return BACKENDS.findIndex((b) => b.value === String(value).toLowerCase());
+}
+
+const useColor = Boolean(process.stdout.isTTY && !process.env.NO_COLOR);
+const paint = (code, text) => (useColor ? `\x1b[${code}m${text}\x1b[0m` : text);
+
+/**
+ * Render an arrow-key list picker. Falls back to the default choice when
+ * stdin is not a TTY (CI, piped input) so `npm create nexwire@latest .`
+ * keeps working in scripts without hanging on a prompt.
+ */
+async function selectOption(title, options, defaultIndex = 0) {
+  if (!process.stdin.isTTY || typeof process.stdin.setRawMode !== "function") {
+    return options[defaultIndex].value;
+  }
+
+  const stdin = process.stdin;
+  const out = process.stdout;
+  let index = defaultIndex;
+  const lines = options.length + 2; // title + options + trailing help line
+
+  emitKeypressEvents(stdin);
+  stdin.setRawMode(true);
+  stdin.resume();
+  out.write("\x1b[?25l"); // hide the cursor while the list is live
+
+  const render = (first) => {
+    if (!first) out.write(`\x1b[${lines}A`);
+    out.write(`${paint(1, title)}\n`);
+    options.forEach((option, i) => {
+      const active = i === index;
+      const marker = active ? paint(32, "\u276F") : " ";
+      const label = paint(active ? 1 : 0, option.label);
+      const hint = option.hint ? `  ${paint(2, option.hint)}` : "";
+      out.write(`${marker} ${label}${hint}\x1b[K\n`);
+    });
+    out.write(`${paint(2, "Arrow keys choose, 1-2 jump, Enter confirm")}\n`);
+  };
+
+  render(true);
+
+  return new Promise((resolve) => {
+    const cleanup = () => {
+      stdin.setRawMode(false);
+      stdin.removeListener("keypress", onKeypress);
+      stdin.pause();
+      out.write("\x1b[?25h"); // restore the cursor
+    };
+
+    const onKeypress = (str, key = {}) => {
+      if (key.ctrl && key.name === "c") {
+        cleanup();
+        out.write("\n");
+        process.exit(130);
+      }
+      if (key.name === "escape") {
+        cleanup();
+        out.write("\n");
+        process.exit(130);
+      }
+      if (key.name === "up" || key.name === "k") {
+        index = (index - 1 + options.length) % options.length;
+        render(false);
+        return;
+      }
+      if (key.name === "down" || key.name === "j") {
+        index = (index + 1) % options.length;
+        render(false);
+        return;
+      }
+      if (key.name === "return" || key.name === "enter") {
+        cleanup();
+        out.write("\n");
+        resolve(options[index].value);
+        return;
+      }
+      const digit = Number(str);
+      if (Number.isInteger(digit) && digit >= 1 && digit <= options.length) {
+        index = digit - 1;
+        render(false);
+      }
+    };
+
+    stdin.on("keypress", onKeypress);
+  });
+}
+
 function detectPackageManager() {
   if (typeof process !== "undefined" && process.isBun) return "bun";
   const ua = process.env.npm_config_user_agent || "";
@@ -116,26 +214,26 @@ function fetchTarball(pkgName, pkgVersion) {
 
 async function main() {
   const args = process.argv.slice(2);
-  let projectName = args.find((a) => !a.startsWith("--"));
-
+  const yes = args.includes("--yes") || args.includes("-y");
   const engineArg = args.find((a) => a.startsWith("--engine="));
-  let engine = engineArg ? engineArg.split("=")[1] : "hono";
-
-  if (!ENGINE_PREFIXES[engine]) {
-    console.error(`Error: Unknown engine "${engine}". Supported engines: hono, express.`);
-    process.exit(1);
-  }
+  let projectName = args.find((a) => !a.startsWith("--"));
 
+  // --help works even with --engine set, and before any prompt or network call.
   if (args.includes("--help") || args.includes("-h")) {
     console.log(`create-nexwire v${version}`);
     console.log();
     console.log("Usage:");
-    console.log("  npm create nexwire@latest <project-name|.> [--engine=<hono|express>]");
-    console.log("  pnpm create nexwire@latest <project-name|.> [--engine=<hono|express>]");
-    console.log("  bun create nexwire@latest <project-name|.> [--engine=<hono|express>]");
-    console.log("  npx create-nexwire@latest <project-name|.> [--engine=<hono|express>]");
+    console.log("  npm create nexwire@latest <project-name|.> [--engine=<hono|express>] [--yes]");
+    console.log("  pnpm create nexwire@latest <project-name|.> [--engine=<hono|express>] [--yes]");
+    console.log("  bun create nexwire@latest <project-name|.> [--engine=<hono|express>] [--yes]");
+    console.log("  npx create-nexwire@latest <project-name|.> [--engine=<hono|express>] [--yes]");
     console.log();
-    console.log("Engines:");
+    console.log("Options:");
+    console.log("  --engine=<hono|express>  Backend to scaffold. Asked interactively when omitted.");
+    console.log("  -y, --yes                Skip prompts and accept the defaults (requires a project name).");
+    console.log("  -h, --help               Show this help.");
+    console.log();
+    console.log("Backends:");
     console.log("  hono     (default) Hono-based HTTP layer and OpenAPI");
     console.log("  express  Express-based HTTP layer and OpenAPI");
     console.log();
@@ -144,7 +242,25 @@ async function main() {
     process.exit(0);
   }
 
+  if (engineArg === undefined && args.includes("--engine")) {
+    console.error('Error: Missing value for --engine. Use --engine=hono or --engine=express.');
+    process.exit(1);
+  }
+
+  if (engineArg) {
+    const engine = engineArg.split("=")[1].toLowerCase();
+    if (backendIndex(engine) === -1) {
+      console.error(`Error: Unknown engine "${engine}". Supported backends: ${BACKEND_NAMES.join(", ")}.`);
+      process.exit(1);
+    }
+  }
+
   if (!projectName) {
+    if (!process.stdin.isTTY || yes) {
+      console.error("Error: Please provide a project name or '.' to scaffold into the current directory.");
+      console.error("  A project name is required when the CLI runs without an interactive terminal.");
+      process.exit(1);
+    }
     projectName = await ask("Project name or '.' for the current directory: ");
   }
 
@@ -158,6 +274,15 @@ async function main() {
     process.exit(1);
   }
 
+  let engine = engineArg ? engineArg.split("=")[1].toLowerCase() : null;
+  if (!engine) {
+    if (yes) {
+      engine = "hono";
+    } else {
+      engine = await selectOption("Choose a backend:", BACKENDS, 0);
+    }
+  }
+
   const targetDir = resolveTargetDir(projectName);
   const isCurrentDir = targetDir === process.cwd();