@pauldvlp/vp-react-ts-nestjs 0.3.3 → 0.3.5

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2026 pauldvlp
+Copyright (c) 2026 Paul Barahona
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -36,16 +36,16 @@ vp create @pauldvlp:vp-react-ts-nestjs -- \
 
 ## Options
 
-| Option       | Type / values | Default   | Notes                                                                                          |
-| ------------ | ------------- | --------- | ---------------------------------------------------------------------------------------------- |
-| `--name`     | string        | `my-app`  | Root project / package name.                                                                   |
+| Option       | Type / values | Default   | Notes                                                                                                                                                                                   |
+| ------------ | ------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `--name`     | string        | `my-app`  | Root project / package name.                                                                                                                                                            |
 | `--scope`    | string        | `@<name>` | npm scope for workspace packages → `@scope/web`, `@scope/api`, `@scope/contracts`. Defaults to the project name prefixed with `@` (e.g. `--name acme` → `@acme`); falls back to `@app`. |
-| `--apiPort`  | string        | `3000`    | Port the NestJS api listens on (substituted into the env default + the web proxy).             |
-| `--webPort`  | string        | `5173`    | Port the web dev server listens on.                                                            |
-| `--swagger`  | boolean       | `false`   | Expose Swagger UI at `/docs` and the OpenAPI JSON at `/docs.json` (adds `@nestjs/swagger`).     |
-| `--serveWeb` | boolean       | `false`   | Have the api serve the built web app for a single deployable (adds `@nestjs/serve-static`).     |
-| `--docker`   | boolean       | `false`   | Emit a multi-stage `apps/api/Dockerfile` (+ root `.dockerignore`).                              |
-| `--install`  | boolean       | `true`    | Run `pnpm install` after scaffolding. `false` = files only.                                     |
+| `--apiPort`  | string        | `3000`    | Port the NestJS api listens on (substituted into the env default + the web proxy).                                                                                                      |
+| `--webPort`  | string        | `5173`    | Port the web dev server listens on.                                                                                                                                                     |
+| `--swagger`  | boolean       | `false`   | Expose Swagger UI at `/docs` and the OpenAPI JSON at `/docs.json` (adds `@nestjs/swagger`).                                                                                             |
+| `--serveWeb` | boolean       | `false`   | Have the api serve the built web app for a single deployable (adds `@nestjs/serve-static`).                                                                                             |
+| `--docker`   | boolean       | `false`   | Emit a multi-stage `apps/api/Dockerfile` (+ root `.dockerignore`).                                                                                                                      |
+| `--install`  | boolean       | `true`    | Run `pnpm install` after scaffolding. `false` = files only.                                                                                                                             |
 
 ## What it scaffolds
 

package/dist/index.js

@@ -103,7 +103,10 @@ function resolveDefault(d, options, directory) {
 }
 async function promptForOption(d, def) {
   if (d.type === "boolean") {
-    return prompts.confirm({ message: d.message, initialValue: def === void 0 ? false : Boolean(def) });
+    return prompts.confirm({
+      message: d.message,
+      initialValue: def === void 0 ? false : Boolean(def)
+    });
   }
   if (d.type === "select") {
     return prompts.select({
@@ -148,7 +151,11 @@ function initGit(dir) {
     } catch {
       identity = ["-c", "user.name=create", "-c", "user.email=create@users.noreply.github.com"];
     }
-    execFileSync("git", [...identity, "commit", "-m", "feat: initialize project", "--no-gpg-sign"], { cwd: dir, stdio: "ignore" });
+    execFileSync(
+      "git",
+      [...identity, "commit", "-m", "feat: initialize project", "--no-gpg-sign"],
+      { cwd: dir, stdio: "ignore" }
+    );
   } catch {
   }
 }
@@ -164,7 +171,11 @@ async function runTemplateCLI(template) {
   let directory = dirArg;
   if (!directory) {
     if (interactive) {
-      const answer = await prompts.text({ message: "Where should we create your project?", placeholder: "my-app", defaultValue: "my-app" });
+      const answer = await prompts.text({
+        message: "Where should we create your project?",
+        placeholder: "my-app",
+        defaultValue: "my-app"
+      });
       if (prompts.isCancel(answer)) {
         prompts.cancel("Cancelled.");
         return 2;
@@ -206,7 +217,11 @@ async function runTemplateCLI(template) {
     for (const step of [...creation.scripts].sort((a, b) => a.phase - b.phase)) {
       for (const [program, ...commandArgs] of step.commands) {
         if (!program) continue;
-        execFileSync(program, commandArgs, { cwd: directory, stdio: "inherit" });
+        execFileSync(program, commandArgs, {
+          cwd: directory,
+          stdio: "inherit",
+          shell: process.platform === "win32"
+        });
       }
     }
   }
@@ -250,16 +265,55 @@ var template_default = defineTemplate({
   },
   options: [
     // Default the name to the target directory the user chose, so they don't retype it.
-    { key: "name", type: "string", message: "Root project / package name", default: ({ directory }) => dirName(directory), validate: validateName },
+    {
+      key: "name",
+      type: "string",
+      message: "Root project / package name",
+      default: ({ directory }) => dirName(directory),
+      validate: validateName
+    },
     // Lazily default the package scope to `@<name>` (prefixing `@` unless the name already has one),
     // so it tracks the project name instead of a fixed value. Falls back to `@app` when no name is set.
-    { key: "scope", type: "string", message: "npm scope for workspace packages, e.g. @acme (defaults to @<name>)", default: ({ options }) => options.name ? toScope(options.name) : "@app", validate: validateScope },
+    {
+      key: "scope",
+      type: "string",
+      message: "npm scope for workspace packages, e.g. @acme (defaults to @<name>)",
+      default: ({ options }) => options.name ? toScope(options.name) : "@app",
+      validate: validateScope
+    },
     // Ports stay strings (validated as integers): they're only ever substituted into config files as text.
-    { key: "apiPort", type: "string", message: "Port the NestJS api listens on", default: "3000", validate: validatePort },
-    { key: "webPort", type: "string", message: "Port the web dev server listens on", default: "5173", validate: validatePort },
-    { key: "swagger", type: "boolean", message: "Expose Swagger UI at /docs on the api", default: false },
-    { key: "serveWeb", type: "boolean", message: "Have the api serve the built web app (single deployable)", default: false },
-    { key: "docker", type: "boolean", message: "Add a multi-stage Dockerfile for the api", default: false },
+    {
+      key: "apiPort",
+      type: "string",
+      message: "Port the NestJS api listens on",
+      default: "3000",
+      validate: validatePort
+    },
+    {
+      key: "webPort",
+      type: "string",
+      message: "Port the web dev server listens on",
+      default: "5173",
+      validate: validatePort
+    },
+    {
+      key: "swagger",
+      type: "boolean",
+      message: "Expose Swagger UI at /docs on the api",
+      default: false
+    },
+    {
+      key: "serveWeb",
+      type: "boolean",
+      message: "Have the api serve the built web app (single deployable)",
+      default: false
+    },
+    {
+      key: "docker",
+      type: "boolean",
+      message: "Add a multi-stage Dockerfile for the api",
+      default: false
+    },
     { key: "install", type: "boolean", message: "Install deps after scaffolding", default: true }
   ],
   async produce({ options }) {
@@ -274,7 +328,10 @@ var template_default = defineTemplate({
         out = options.swagger ? out.replace("// __SWAGGER_IMPORT__", SWAGGER_IMPORT).replace("// __SWAGGER_SETUP__", swaggerSetup) : out.replace(/^[ \t]*\/\/ __SWAGGER_(IMPORT|SETUP)__\n/gm, "");
       }
       if (rel === APP_MODULE) {
-        out = options.serveWeb ? out.replace("// __SERVEWEB_PATH_IMPORT__", "import { join } from 'node:path'\n").replace("// __SERVEWEB_MODULE_IMPORT__", "import { ServeStaticModule } from '@nestjs/serve-static'").replace("    // __SERVEWEB_MODULE__", SERVEWEB_MODULE) : out.replace(/^[ \t]*\/\/ __SERVEWEB_[A-Z_]+__\n/gm, "");
+        out = options.serveWeb ? out.replace("// __SERVEWEB_PATH_IMPORT__", "import { join } from 'node:path'\n").replace(
+          "// __SERVEWEB_MODULE_IMPORT__",
+          "import { ServeStaticModule } from '@nestjs/serve-static'"
+        ).replace("    // __SERVEWEB_MODULE__", SERVEWEB_MODULE) : out.replace(/^[ \t]*\/\/ __SERVEWEB_[A-Z_]+__\n/gm, "");
       }
       if (rel === "README.md") {
         out = applyDocBlock(out, "SWAGGER", options.swagger);
@@ -288,7 +345,9 @@ var template_default = defineTemplate({
         const deps = { ...pkg.dependencies };
         if (options.swagger) deps["@nestjs/swagger"] = "^11";
         if (options.serveWeb) deps["@nestjs/serve-static"] = "^5";
-        pkg.dependencies = Object.fromEntries(Object.entries(deps).sort(([a], [b]) => a.localeCompare(b)));
+        pkg.dependencies = Object.fromEntries(
+          Object.entries(deps).sort(([a], [b]) => a.localeCompare(b))
+        );
       });
     }
     if (!options.docker) {
@@ -303,7 +362,9 @@ var template_default = defineTemplate({
         `cd into the project and run \`vp run -r dev\` to start web + api together.`,
         `The web app proxies \`/api\` to the NestJS server on port ${options.apiPort}.`,
         ...options.swagger ? [`Swagger UI: http://localhost:${options.apiPort}/docs (OpenAPI JSON at /docs.json).`] : [],
-        ...options.serveWeb ? [`--serveWeb is on: after \`vp run -r build\`, \`node apps/api/dist/main.js\` serves the web app from the api.`] : [],
+        ...options.serveWeb ? [
+          `--serveWeb is on: after \`vp run -r build\`, \`node apps/api/dist/main.js\` serves the web app from the api.`
+        ] : [],
         options.install ? `Run \`vp check\` to lint, format and type-check the whole workspace.` : `Skipped install. Run \`vp install\`, then \`vp run -r dev\`.`
       ]
     };

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@pauldvlp/vp-react-ts-nestjs",
-  "version": "0.3.3",
+  "version": "0.3.5",
   "description": "Vite+ monorepo template: a React web app + a NestJS api (conformed to the Vite+ toolchain) sharing Zod contracts.",
-  "author": "pauldvlp (https://github.com/pauldvlp/vp-templates)",
+  "author": "Paul Barahona <johanpaulbarahona@gmail.com> (https://github.com/pauldvlp/vp-templates)",
   "license": "MIT",
   "homepage": "https://github.com/pauldvlp/vp-templates",
   "repository": {
@@ -37,7 +37,8 @@
   },
   "scripts": {
     "build": "esbuild bin/index.ts --bundle --outfile=dist/index.js --format=esm --platform=node --target=node22 --packages=external",
-    "dev": "node bin/index.ts"
+    "dev": "node bin/index.ts",
+    "typecheck": "tsc --noEmit"
   },
   "bin": {
     "vp-react-ts-nestjs": "./dist/index.js"

package/template/_package.json

@@ -17,7 +17,7 @@
   "devEngines": {
     "packageManager": {
       "name": "pnpm",
-      "version": "11.9.0",
+      "version": "11.17.0",
       "onFail": "warn"
     }
   },