Polish CLI flow and release prep

Author: codehassoul

.gitattributes

@@ -0,0 +1,2 @@
+* text=auto eol=lf
+

.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 10
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        node-version: [20, 22]
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run tests
+        run: npm test

.gitignore

@@ -1,31 +1,13 @@
-# dependencies
 node_modules/
-
-# logs
 *.log
 npm-debug.log*
 yarn-debug.log*
-pnpm-debug.log*
-
-# OS files
 .DS_Store
 Thumbs.db
-
-# environment variables
 .env
 .env.local
 .env.*.local
-
-# build output (for TS templates if ever used internally)
 dist/
-
-# editor files
 .vscode/
 .idea/
-
-# coverage / test
 coverage/
-
-# temp files
-*.tmp
-*.temp

LICENSE

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

README.md

@@ -1,85 +1,103 @@
-![npm version](https://img.shields.io/npm/v/setup-node-api)
-![downloads](https://img.shields.io/npm/dm/setup-node-api)
+[![npm version](https://img.shields.io/npm/v/setup-node-api)](https://www.npmjs.com/package/setup-node-api)
+[![npm downloads](https://img.shields.io/npm/dm/setup-node-api)](https://www.npmjs.com/package/setup-node-api)
+[![CI](https://github.com/codehassoul/setup-node-api/actions/workflows/ci.yml/badge.svg)](https://github.com/codehassoul/setup-node-api/actions/workflows/ci.yml)
 
 # setup-node-api
 
-A minimal CLI for scaffolding Node.js + Express APIs.
+`setup-node-api` scaffolds a minimal Node.js + Express API with sensible defaults.
 
-Opinionated, simple, and focused on developer experience.
+Node.js 20.12.0 or newer is required.
 
----
+## Features
+
+- Scaffold a ready-to-run Express API
+- Choose JavaScript or TypeScript
+- Use prompts interactively or pass CLI flags
+- Validate project names before generation
+- Avoid overwriting existing folders without confirmation
+- Optionally skip dependency installation
 
-## Quick Start
+## Quick start
 
 ```bash
 npx setup-node-api my-api
 ```
 
----
+Create a TypeScript project:
 
-## Features
+```bash
+npx setup-node-api my-api --typescript
+```
 
-* Fast API scaffolding
-* JavaScript and TypeScript support
-* Interactive prompts + CLI flags
-* Safe project creation
-* Clean project structure
+Skip package installation:
 
----
+```bash
+npx setup-node-api my-api --no-install
+```
 
-## Usage
+Set a custom port:
 
 ```bash
-setup-node-api <project-name>
+npx setup-node-api my-api --port 8080
 ```
 
-### Options
+## CLI usage
 
 ```bash
---typescript
---no-install
---port <number>
+setup-node-api [project-name] [options]
 ```
 
----
+### Options
 
-## Example
+| Option | Description |
+| --- | --- |
+| `--typescript` | Generate the TypeScript template |
+| `--no-install` | Skip dependency installation |
+| `--port <number>` | Write a custom `PORT` value to `.env` |
+| `-h, --help` | Show help |
+| `-V, --version` | Show the installed CLI version |
 
-```bash
-npx setup-node-api my-api --typescript
-```
+If you omit some options, the CLI prompts for them in an interactive terminal.
 
----
+## Generated project
 
-## Generated Project
+JavaScript template:
 
 ```text
 my-api/
-  |-- src/
-  |   `-- app.js / app.ts
-  |-- package.json
-  `-- .env
+|-- .env
+|-- package.json
+`-- src/
+    `-- app.js
 ```
 
----
+TypeScript template:
 
-## Architecture
+```text
+my-api/
+|-- .env
+|-- package.json
+|-- tsconfig.json
+`-- src/
+    `-- app.ts
+```
+
+## Development
 
-* CLI layer (Commander)
-* Core orchestration layer
-* Services (template, install, filesystem)
-* Prompt system + validation
+```bash
+npm install
+npm test
+```
 
----
+## CI
 
-## Roadmap
+GitHub Actions runs the test suite on Node.js 20 and 22 across Linux, Windows, and macOS for pushes to `main` and pull requests.
 
-* Command-based CLI (`create`, `add`, `generate`)
-* Config file support
-* Plugin system
-* AI-assisted scaffolding
+## Notes
 
----
+- In a non-interactive environment, 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 generated project package name is automatically set to the selected folder name.
 
 ## License
 

assets/demo.png

@@ -1,6 +1,7 @@
 #!/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");
@@ -11,9 +12,28 @@ const { handleExistingDir } = require("../src/core/services/fileService");
 
 const program = new Command();
 
+function exitWithError(message, exitCode = 1) {
+  console.log(chalk.red(`Error: ${message}`));
+  process.exit(exitCode);
+}
+
+function parsePort(portValue) {
+  if (portValue === undefined) {
+    return undefined;
+  }
+
+  const parsedPort = Number.parseInt(portValue, 10);
+
+  if (!Number.isInteger(parsedPort) || parsedPort < 1 || parsedPort > 65535) {
+    throw new Error("Port must be an integer between 1 and 65535.");
+  }
+
+  return parsedPort;
+}
+
 program
   .name("setup-node-api")
-  .description("CLI to create a Node.js Express API")
+  .description("Scaffold a Node.js + Express API")
   .version(packageJson.version);
 
 program
@@ -25,45 +45,32 @@ program
     try {
       if (projectName !== undefined) {
         validateProjectName(projectName);
-
-        const projectPathCheck = path.join(process.cwd(), projectName);
-
-        if (projectPathCheck === process.cwd()) {
-          console.log("Error: cannot use current directory as project name.");
-          process.exit(1);
-        }
       }
     } catch (err) {
-      console.log("Error:", err.message);
-      process.exit(1);
+      exitWithError(err.message);
     }
 
-    const parsedPort =
-      options.port === undefined ? undefined : Number.parseInt(options.port, 10);
+    let parsedPort;
 
-    if (
-      options.port !== undefined &&
-      (!Number.isInteger(parsedPort) || parsedPort < 1 || parsedPort > 65535)
-    ) {
-      console.log("Error: port must be an integer between 1 and 65535.");
-      process.exit(1);
+    try {
+      parsedPort = parsePort(options.port);
+    } catch (err) {
+      exitWithError(err.message);
     }
 
     const projectPath = projectName
       ? path.join(process.cwd(), projectName)
       : null;
 
     if (projectPath && projectPath === process.cwd()) {
-      console.log("Error: refusing to overwrite the current directory.");
-      process.exit(1);
+      exitWithError("Refusing to overwrite the current directory.");
     }
 
     if (projectPath) {
       try {
         await handleExistingDir(projectPath);
       } catch (err) {
-        console.log("Warning:", err.message);
-        process.exit(0);
+        exitWithError(err.message);
       }
     }
 
@@ -74,8 +81,7 @@ program
         port: parsedPort,
       });
     } catch (err) {
-      console.log("Error:", err.message);
-      process.exit(1);
+      exitWithError(err.message);
     }
   });