create-nexwire 4.2.1 → 4.2.2

package/express/src/framework/maker-cli/utils/project-commands.mjs

@@ -13,8 +13,16 @@ import { PROJECT_COMMAND_FLAG } from "./help.mjs";
  * there would be overwritten on the next framework update - and `src/modules/`
  * is swept by the route, job and seeder globs. The project root is the one
  * place nothing else owns.
+ *
+ * Two names are read: commands.mjs (plain JavaScript, loaded by plain node)
+ * and commands.ts (TypeScript, loaded through tsx). The .mjs is the incumbent
+ * and wins if a project keeps both.
  */
 export const PROJECT_COMMANDS_PATH = "maker/commands.mjs";
+export const PROJECT_COMMANDS_TS_PATH = "maker/commands.ts";
+
+/** Process-global so a re-evaluated module cannot register tsx twice. */
+const TSX_REGISTERED = "__nexwireMakerTsxRegistered";
 
 const PROJECT_COMMANDS_TEMPLATE = `/**
  * Your project's maker commands.
@@ -36,8 +44,11 @@ const PROJECT_COMMANDS_TEMPLATE = `/**
  *     which one. Rename yours; the built-in stays.
  *   - An error in this file is reported, never swallowed. If your commands stop
  *     appearing, the fault is here rather than in your command code.
- *   - Import your own code with a normal relative path, e.g.
- *       import { sendInvoice } from "../src/invoices/send.js";
+ *   - This file runs as plain JavaScript under plain Node, so it cannot import
+ *     your TypeScript source or use your tsconfig path alias. If a command
+ *     needs either, name this file maker/commands.ts instead and delete this
+ *     one - nexwire loads that file through tsx, with your tsconfig applied.
+ *     For editor type support, create maker/tsconfig.json as shown in the docs.
  *
  * Replace or delete the example below once you have a command of your own.
  */
@@ -54,14 +65,47 @@ export default function register(program) {
 }
 `;
 
+/**
+ * Why: Plain node cannot import TypeScript, so maker/commands.ts needs tsx
+ *      registered before it is imported. Registered at most once per process
+ *      and never unregistered: two overlapping registrations corrupt the
+ *      loader, and commands routinely import more TypeScript at action time,
+ *      long after this function returns. The flag lives on globalThis because
+ *      this module can be evaluated more than once in one process (vitest's
+ *      per-file isolation) while the loader hooks are process-wide.
+ * When: Only when the project's file is TypeScript - maker/commands.mjs never
+ *      pays for tsx being installed.
+ * Where: utils/project-commands.mjs.
+ */
+async function registerTsLoader(rel) {
+  if (globalThis[TSX_REGISTERED]) return;
+
+  try {
+    const { register } = await import("tsx/esm/api");
+    register();
+  } catch (error) {
+    throw new Error(
+      `${rel} needs tsx to load TypeScript, but it could not be registered: ${error?.message || error}. tsx ships as a devDependency of every nexwire project - run npm install, or rename the file to ${PROJECT_COMMANDS_PATH}.`,
+      { cause: error }
+    );
+  }
+
+  globalThis[TSX_REGISTERED] = true;
+}
+
 /**
  * Why: Registers the commands a project defined for itself.
  * When: Every maker invocation, right after the framework's own registrars.
  * Where: Maker CLI entry flow, from utils/project-commands.mjs.
- * How: Imports maker/commands.mjs resolved from process.cwd() - not from
- *      import.meta.dirname, which points inside node_modules and would find the
- *      framework's own directory instead of the project. Absent is silent and
- *      free; broken is loud, because a developer's commands silently not
+ * How: Imports maker/commands.mjs - or maker/commands.ts, loaded through tsx,
+ *      which resolves the project's tsconfig path aliases - resolved from
+ *      process.cwd(), not from import.meta.dirname, which points inside
+ *      node_modules and would find the framework's own directory instead of the
+ *      project. If a project keeps both files the .mjs wins and the .ts file is
+ *      skipped with a warning naming it, so neither file is ever silently dead:
+ *      a project that already runs must not be re-registered by a file that
+ *      appeared later, and a file that is skipped must say so. Absent is silent
+ *      and free; broken is loud, because a developer's commands silently not
  *      existing is a far worse experience than an error message. A name that
  *      collides with a framework command is refused by commander itself, which
  *      is the right outcome: the built-in wins and the project cannot shadow a
@@ -70,10 +114,23 @@ export default function register(program) {
  *      asked for the name.
  */
 export async function registerProjectCommands(program, rawArgs, cwd = process.cwd()) {
-  const file = path.resolve(cwd, PROJECT_COMMANDS_PATH);
+  const mjsFile = path.resolve(cwd, PROJECT_COMMANDS_PATH);
+  const tsFile = path.resolve(cwd, PROJECT_COMMANDS_TS_PATH);
+  const hasMjs = fs.existsSync(mjsFile);
+  const hasTs = fs.existsSync(tsFile);
+
+  if (!hasMjs && !hasTs) {
+    return { loaded: false, file: mjsFile, added: [] };
+  }
+
+  const isTs = !hasMjs && hasTs;
+  const file = isTs ? tsFile : mjsFile;
+  const rel = isTs ? PROJECT_COMMANDS_TS_PATH : PROJECT_COMMANDS_PATH;
 
-  if (!fs.existsSync(file)) {
-    return { loaded: false, file, added: [] };
+  if (hasMjs && hasTs) {
+    console.warn(
+      `${PROJECT_COMMANDS_TS_PATH} is ignored because ${PROJECT_COMMANDS_PATH} exists. Keep one - delete the file you are not using.`
+    );
   }
 
   // Not wrapped in a bare try/catch on purpose. A file that exists but fails to
@@ -81,18 +138,22 @@ export async function registerProjectCommands(program, rawArgs, cwd = process.cw
   // command that is actually in this loader. The catches below only attach the
   // file name, because an error from inside the project file otherwise reads as
   // if it came from the framework.
+  if (isTs) {
+    await registerTsLoader(rel);
+  }
+
   let module;
   try {
     module = await import(pathToFileURL(file).href);
   } catch (error) {
-    throw new Error(`Could not load ${PROJECT_COMMANDS_PATH}: ${error?.message || error}`, { cause: error });
+    throw new Error(`Could not load ${rel}: ${error?.message || error}`, { cause: error });
   }
 
   const register = module.default ?? module.register;
 
   if (typeof register !== "function") {
     throw new TypeError(
-      `${PROJECT_COMMANDS_PATH} must export a default function (program, args) => void. Found: ${typeof register}.`
+      `${rel} must export a default function (program, args) => void. Found: ${typeof register}.`
     );
   }
 
@@ -101,7 +162,7 @@ export async function registerProjectCommands(program, rawArgs, cwd = process.cw
   try {
     await register(program, rawArgs);
   } catch (error) {
-    throw new Error(`Could not register commands from ${PROJECT_COMMANDS_PATH}: ${error?.message || error}`, {
+    throw new Error(`Could not register commands from ${rel}: ${error?.message || error}`, {
       cause: error
     });
   }

package/hono/src/framework/maker-cli/utils/project-commands.mjs

@@ -13,8 +13,16 @@ import { PROJECT_COMMAND_FLAG } from "./help.mjs";
  * there would be overwritten on the next framework update - and `src/modules/`
  * is swept by the route, job and seeder globs. The project root is the one
  * place nothing else owns.
+ *
+ * Two names are read: commands.mjs (plain JavaScript, loaded by plain node)
+ * and commands.ts (TypeScript, loaded through tsx). The .mjs is the incumbent
+ * and wins if a project keeps both.
  */
 export const PROJECT_COMMANDS_PATH = "maker/commands.mjs";
+export const PROJECT_COMMANDS_TS_PATH = "maker/commands.ts";
+
+/** Process-global so a re-evaluated module cannot register tsx twice. */
+const TSX_REGISTERED = "__nexwireMakerTsxRegistered";
 
 const PROJECT_COMMANDS_TEMPLATE = `/**
  * Your project's maker commands.
@@ -36,8 +44,11 @@ const PROJECT_COMMANDS_TEMPLATE = `/**
  *     which one. Rename yours; the built-in stays.
  *   - An error in this file is reported, never swallowed. If your commands stop
  *     appearing, the fault is here rather than in your command code.
- *   - Import your own code with a normal relative path, e.g.
- *       import { sendInvoice } from "../src/invoices/send.js";
+ *   - This file runs as plain JavaScript under plain Node, so it cannot import
+ *     your TypeScript source or use your tsconfig path alias. If a command
+ *     needs either, name this file maker/commands.ts instead and delete this
+ *     one - nexwire loads that file through tsx, with your tsconfig applied.
+ *     For editor type support, create maker/tsconfig.json as shown in the docs.
  *
  * Replace or delete the example below once you have a command of your own.
  */
@@ -54,14 +65,47 @@ export default function register(program) {
 }
 `;
 
+/**
+ * Why: Plain node cannot import TypeScript, so maker/commands.ts needs tsx
+ *      registered before it is imported. Registered at most once per process
+ *      and never unregistered: two overlapping registrations corrupt the
+ *      loader, and commands routinely import more TypeScript at action time,
+ *      long after this function returns. The flag lives on globalThis because
+ *      this module can be evaluated more than once in one process (vitest's
+ *      per-file isolation) while the loader hooks are process-wide.
+ * When: Only when the project's file is TypeScript - maker/commands.mjs never
+ *      pays for tsx being installed.
+ * Where: utils/project-commands.mjs.
+ */
+async function registerTsLoader(rel) {
+  if (globalThis[TSX_REGISTERED]) return;
+
+  try {
+    const { register } = await import("tsx/esm/api");
+    register();
+  } catch (error) {
+    throw new Error(
+      `${rel} needs tsx to load TypeScript, but it could not be registered: ${error?.message || error}. tsx ships as a devDependency of every nexwire project - run npm install, or rename the file to ${PROJECT_COMMANDS_PATH}.`,
+      { cause: error }
+    );
+  }
+
+  globalThis[TSX_REGISTERED] = true;
+}
+
 /**
  * Why: Registers the commands a project defined for itself.
  * When: Every maker invocation, right after the framework's own registrars.
  * Where: Maker CLI entry flow, from utils/project-commands.mjs.
- * How: Imports maker/commands.mjs resolved from process.cwd() - not from
- *      import.meta.dirname, which points inside node_modules and would find the
- *      framework's own directory instead of the project. Absent is silent and
- *      free; broken is loud, because a developer's commands silently not
+ * How: Imports maker/commands.mjs - or maker/commands.ts, loaded through tsx,
+ *      which resolves the project's tsconfig path aliases - resolved from
+ *      process.cwd(), not from import.meta.dirname, which points inside
+ *      node_modules and would find the framework's own directory instead of the
+ *      project. If a project keeps both files the .mjs wins and the .ts file is
+ *      skipped with a warning naming it, so neither file is ever silently dead:
+ *      a project that already runs must not be re-registered by a file that
+ *      appeared later, and a file that is skipped must say so. Absent is silent
+ *      and free; broken is loud, because a developer's commands silently not
  *      existing is a far worse experience than an error message. A name that
  *      collides with a framework command is refused by commander itself, which
  *      is the right outcome: the built-in wins and the project cannot shadow a
@@ -70,10 +114,23 @@ export default function register(program) {
  *      asked for the name.
  */
 export async function registerProjectCommands(program, rawArgs, cwd = process.cwd()) {
-  const file = path.resolve(cwd, PROJECT_COMMANDS_PATH);
+  const mjsFile = path.resolve(cwd, PROJECT_COMMANDS_PATH);
+  const tsFile = path.resolve(cwd, PROJECT_COMMANDS_TS_PATH);
+  const hasMjs = fs.existsSync(mjsFile);
+  const hasTs = fs.existsSync(tsFile);
+
+  if (!hasMjs && !hasTs) {
+    return { loaded: false, file: mjsFile, added: [] };
+  }
+
+  const isTs = !hasMjs && hasTs;
+  const file = isTs ? tsFile : mjsFile;
+  const rel = isTs ? PROJECT_COMMANDS_TS_PATH : PROJECT_COMMANDS_PATH;
 
-  if (!fs.existsSync(file)) {
-    return { loaded: false, file, added: [] };
+  if (hasMjs && hasTs) {
+    console.warn(
+      `${PROJECT_COMMANDS_TS_PATH} is ignored because ${PROJECT_COMMANDS_PATH} exists. Keep one - delete the file you are not using.`
+    );
   }
 
   // Not wrapped in a bare try/catch on purpose. A file that exists but fails to
@@ -81,18 +138,22 @@ export async function registerProjectCommands(program, rawArgs, cwd = process.cw
   // command that is actually in this loader. The catches below only attach the
   // file name, because an error from inside the project file otherwise reads as
   // if it came from the framework.
+  if (isTs) {
+    await registerTsLoader(rel);
+  }
+
   let module;
   try {
     module = await import(pathToFileURL(file).href);
   } catch (error) {
-    throw new Error(`Could not load ${PROJECT_COMMANDS_PATH}: ${error?.message || error}`, { cause: error });
+    throw new Error(`Could not load ${rel}: ${error?.message || error}`, { cause: error });
   }
 
   const register = module.default ?? module.register;
 
   if (typeof register !== "function") {
     throw new TypeError(
-      `${PROJECT_COMMANDS_PATH} must export a default function (program, args) => void. Found: ${typeof register}.`
+      `${rel} must export a default function (program, args) => void. Found: ${typeof register}.`
     );
   }
 
@@ -101,7 +162,7 @@ export async function registerProjectCommands(program, rawArgs, cwd = process.cw
   try {
     await register(program, rawArgs);
   } catch (error) {
-    throw new Error(`Could not register commands from ${PROJECT_COMMANDS_PATH}: ${error?.message || error}`, {
+    throw new Error(`Could not register commands from ${rel}: ${error?.message || error}`, {
       cause: error
     });
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-nexwire",
-  "version": "4.2.1",
+  "version": "4.2.2",
   "type": "module",
   "description": "Scaffold a new nexwire project",
   "bin": {
@@ -235,4 +235,4 @@
       "optional": true
     }
   }
-}
+}