Release v1.2.0

Author: codehassoul

README.md

@@ -13,9 +13,12 @@ Node.js 20.12.0 or newer is required.
 - Scaffold a ready-to-run Express API
 - Choose JavaScript or TypeScript
 - Use prompts interactively or pass CLI flags
+- Accept defaults instantly with `--yes`
 - Validate project names before generation
 - Avoid overwriting existing folders without confirmation
 - Optionally skip dependency installation
+- Optionally enable CORS during generation
+- Include basic API defaults like JSON parsing, request logging, `/health`, `/echo`, and common starter files
 
 ## Quick start
 
@@ -47,6 +50,18 @@ Set a custom port:
 npx setup-node-api my-api --port 8080
 ```
 
+Generate with defaults and skip prompts:
+
+```bash
+npx setup-node-api my-api --yes
+```
+
+Generate with CORS enabled:
+
+```bash
+npx setup-node-api my-api --cors
+```
+
 ## CLI usage
 
 ```bash
@@ -60,6 +75,8 @@ setup-node-api [project-name] [options]
 | `--typescript` | Generate the TypeScript template |
 | `--no-install` | Skip dependency installation |
 | `--port <number>` | Write a custom `PORT` value to `.env` |
+| `--cors` | Add CORS support to the generated API |
+| `-y, --yes` | Use defaults for any missing options |
 | `-h, --help` | Show help |
 | `-V, --version` | Show the installed CLI version |
 
@@ -71,8 +88,10 @@ JavaScript template:
 
 ```text
 my-api/
+|-- .gitignore
 |-- .env
 |-- package.json
+|-- README.md
 `-- src/
     `-- app.js
 ```
@@ -81,14 +100,16 @@ TypeScript template:
 
 ```text
 my-api/
+|-- .gitignore
 |-- .env
 |-- package.json
+|-- README.md
 |-- tsconfig.json
 `-- src/
     `-- app.ts
 ```
 
-The generated project name in `package.json` is automatically set to the selected folder name.
+The generated project name in `package.json` is automatically set to the selected folder name, and the starter app includes request logging, JSON parsing, a `/health` endpoint, a `/echo` endpoint, a 404 handler, and a basic error handler.
 
 ## Examples
 
@@ -104,6 +125,12 @@ Create a TypeScript project and set a custom port:
 setup-node-api my-api --typescript --port 4000
 ```
 
+Create a JavaScript API with CORS enabled and no prompts:
+
+```bash
+setup-node-api my-api --cors --yes
+```
+
 Ask the CLI to guide you interactively:
 
 ```bash
@@ -125,7 +152,9 @@ GitHub Actions runs the test suite on Node.js 20 and 22 across Linux, Windows, a
 ## Notes
 
 - In a non-interactive environment, provide the project name as an argument.
+- When using `--yes`, you still need to provide the project name as an argument.
 - If the target folder already exists, the CLI stops unless you explicitly confirm overwrite in an interactive terminal.
+- The JavaScript template includes a `dev` script using Node's built-in watch mode.
 - `prepublishOnly` runs `npm run check` before publish.
 
 ## License

bin/cli.js

@@ -1,14 +1,9 @@
 #!/usr/bin/env node
 
-const path = require("path");
 const chalk = require("chalk");
 const { Command } = require("commander");
 const packageJson = require("../package.json");
 const { createApp } = require("../src/core");
-const {
-  validateProjectName,
-} = require("../src/core/validators/projectValidator");
-const { handleExistingDir } = require("../src/core/services/fileService");
 
 const program = new Command();
 
@@ -40,16 +35,10 @@ program
   .argument("[project-name]", "Name of the project")
   .option("--no-install", "Skip installing dependencies")
   .option("--port <number>", "Set server port")
+  .option("--cors", "Enable CORS in the generated API")
   .option("--typescript", "Use TypeScript template")
+  .option("-y, --yes", "Use defaults for any missing options")
   .action(async (projectName, options) => {
-    try {
-      if (projectName !== undefined) {
-        validateProjectName(projectName);
-      }
-    } catch (err) {
-      exitWithError(err.message);
-    }
-
     let parsedPort;
 
     try {
@@ -58,24 +47,10 @@ program
       exitWithError(err.message);
     }
 
-    const projectPath = projectName
-      ? path.join(process.cwd(), projectName)
-      : null;
-
-    if (projectPath && projectPath === process.cwd()) {
-      exitWithError("Refusing to overwrite the current directory.");
-    }
-
-    if (projectPath) {
-      try {
-        await handleExistingDir(projectPath);
-      } catch (err) {
-        exitWithError(err.message);
-      }
-    }
-
     try {
       await createApp(projectName, {
+        yes: options.yes,
+        cors: options.cors,
         typescript: options.typescript,
         install: options.install === false ? false : undefined,
         port: parsedPort,

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "setup-node-api",
-  "version": "1.1.8",
+  "version": "1.2.0",
   "description": "CLI tool to scaffold Node.js + Express APIs instantly",
   "type": "commonjs",
   "main": "bin/cli.js",

package.json

@@ -21,23 +21,26 @@ function warn(message) {
 
 async function createProject(projectName, options = {}) {
   const projectPath = path.join(process.cwd(), projectName);
+  const templateName = options.typescript ? "node-api-ts" : "node-api";
+  const templateRoot = options.templateRoot ?? path.join(__dirname, "../../templates");
+  const templatePath = path.join(templateRoot, templateName);
 
   info(`\nCreating Node API: ${projectName}\n`);
 
-  createProjectFolder(projectPath);
-  success("Project folder created");
-
-  const templateName = options.typescript ? "node-api-ts" : "node-api";
-  const templatePath = path.join(__dirname, "../../templates", templateName);
-
   if (!fs.existsSync(templatePath)) {
     throw new Error("Template not found");
   }
 
+  createProjectFolder(projectPath);
+  success("Project folder created");
+
   copyTemplate(templatePath, projectPath);
   success("Template copied");
-  updatePackageMetadata(projectPath, projectName);
-  success("Package metadata updated");
+  updatePackageMetadata(projectPath, projectName, {
+    cors: options.cors,
+    typescript: options.typescript,
+  });
+  success("Project files customized");
 
   if (options.port) {
     fs.writeFileSync(

src/core/createProject.js

@@ -7,16 +7,25 @@ const { handleExistingDir } = require("./services/fileService");
 const path = require("path");
 
 async function createApp(projectName, options = {}) {
+  if (projectName !== undefined) {
+    validateProjectName(projectName);
+  }
+
   const finalOptions = await askProjectDetails({
     projectName,
+    yes: options.yes,
+    cors: options.cors,
     typescript: options.typescript,
     install: options.install,
   });
 
   validateProjectName(finalOptions.projectName);
-  await handleExistingDir(path.join(process.cwd(), finalOptions.projectName));
+  const projectPath = path.join(process.cwd(), finalOptions.projectName);
+
+  await handleExistingDir(projectPath);
 
   await createProject(finalOptions.projectName, {
+    cors: finalOptions.cors,
     typescript: finalOptions.typescript,
     install: finalOptions.install,
     port: options.port,

src/core/index.js

@@ -13,6 +13,21 @@ async function getInquirer() {
 }
 
 async function askProjectDetails(options = {}) {
+  if (options.yes) {
+    if (!options.projectName) {
+      throw new Error(
+        "Project name is required when using --yes. Pass it as an argument."
+      );
+    }
+
+    return {
+      projectName: options.projectName,
+      typescript: options.typescript ?? false,
+      install: options.install ?? true,
+      cors: options.cors ?? false,
+    };
+  }
+
   const questions = [];
 
   if (!options.projectName) {
@@ -49,11 +64,21 @@ async function askProjectDetails(options = {}) {
     });
   }
 
+  if (options.cors === undefined) {
+    questions.push({
+      type: "confirm",
+      name: "cors",
+      message: "Enable CORS?",
+      default: false,
+    });
+  }
+
   if (!questions.length) {
     return {
       projectName: options.projectName,
       typescript: options.typescript,
       install: options.install,
+      cors: options.cors,
     };
   }
 
@@ -68,6 +93,7 @@ async function askProjectDetails(options = {}) {
       projectName: options.projectName,
       typescript: options.typescript ?? false,
       install: options.install ?? true,
+      cors: options.cors ?? false,
     };
   }
 
@@ -87,6 +113,7 @@ async function askProjectDetails(options = {}) {
     projectName: options.projectName || answers.projectName,
     typescript: options.typescript ?? answers.typescript,
     install: options.install ?? answers.install,
+    cors: options.cors ?? answers.cors,
   };
 }
 

src/core/promptService.js

@@ -4,28 +4,36 @@ function isInteractive() {
   return Boolean(process.stdin.isTTY && process.stdout.isTTY);
 }
 
-async function handleExistingDir(projectPath) {
-  if (!fs.existsSync(projectPath)) return;
-
-  if (!isInteractive()) {
+async function handleExistingDir(projectPath, dependencies = {}) {
+  const existsSync = dependencies.existsSync ?? fs.existsSync;
+  const removeDirSync = dependencies.removeDirSync ?? fs.rmSync;
+  const promptOverwrite =
+    dependencies.promptOverwrite ??
+    (async () => {
+      const { default: inquirer } = await import("inquirer");
+      return inquirer.prompt([
+        {
+          type: "confirm",
+          name: "overwrite",
+          message: "Folder already exists. Overwrite?",
+          default: false,
+        },
+      ]);
+    });
+  const isInteractiveFn = dependencies.isInteractive ?? isInteractive;
+
+  if (!existsSync(projectPath)) return;
+
+  if (!isInteractiveFn()) {
     throw new Error(
       "Target folder already exists. Remove it first or rerun this command in an interactive terminal."
     );
   }
 
-  const { default: inquirer } = await import("inquirer");
-
   let answer;
 
   try {
-    answer = await inquirer.prompt([
-      {
-        type: "confirm",
-        name: "overwrite",
-        message: "Folder already exists. Overwrite?",
-        default: false,
-      },
-    ]);
+    answer = await promptOverwrite();
   } catch (err) {
     if (err.name === "ExitPromptError") {
       throw new Error("Operation cancelled");
@@ -37,7 +45,7 @@ async function handleExistingDir(projectPath) {
     throw new Error("Operation cancelled");
   }
 
-  fs.rmSync(projectPath, { recursive: true, force: true });
+  removeDirSync(projectPath, { recursive: true, force: true });
   console.log("Existing folder removed\n");
 }