Strengthen verification workflow

Author: codehassoul

.github/workflows/ci.yml

@@ -34,5 +34,5 @@ jobs:
       - name: Install dependencies
         run: npm ci
 
-      - name: Run tests
-        run: npm test
+      - name: Run verification
+        run: npm run check

README.md

@@ -23,6 +23,12 @@ Node.js 20.12.0 or newer is required.
 npx setup-node-api my-api
 ```
 
+Run it against the latest published version explicitly:
+
+```bash
+npx setup-node-api@latest my-api
+```
+
 Create a TypeScript project:
 
 ```bash
@@ -82,11 +88,34 @@ my-api/
     `-- app.ts
 ```
 
+The generated project name in `package.json` is automatically set to the selected folder name.
+
+## Examples
+
+Create a JavaScript project without installing dependencies:
+
+```bash
+setup-node-api my-api --no-install
+```
+
+Create a TypeScript project and set a custom port:
+
+```bash
+setup-node-api my-api --typescript --port 4000
+```
+
+Ask the CLI to guide you interactively:
+
+```bash
+setup-node-api
+```
+
 ## Development
 
 ```bash
 npm install
 npm test
+npm run check
 ```
 
 ## CI
@@ -97,7 +126,7 @@ GitHub Actions runs the test suite on Node.js 20 and 22 across Linux, Windows, a
 
 - 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.
+- `prepublishOnly` runs `npm run check` before publish.
 
 ## License
 

package.json

@@ -7,11 +7,14 @@
   "bin": {
     "setup-node-api": "bin/cli.js"
   },
+  "packageManager": "npm@10.9.4",
   "preferGlobal": true,
   "scripts": {
     "start": "node bin/cli.js",
     "dev": "node bin/cli.js",
-    "test": "node test/run-tests.js"
+    "test": "node test/run-tests.js",
+    "check": "npm test",
+    "prepublishOnly": "npm run check"
   },
   "keywords": [
     "cli",

test/run-tests.js

@@ -1,4 +1,5 @@
 const assert = require("node:assert/strict");
+const { execFileSync } = require("node:child_process");
 const fs = require("node:fs");
 const os = require("node:os");
 const path = require("node:path");
@@ -8,6 +9,9 @@ const { createApp } = require("../src/core");
 const { askProjectDetails } = require("../src/core/promptService");
 const { validateProjectName } = require("../src/core/validators/projectValidator");
 
+const cliPath = path.join(__dirname, "..", "bin", "cli.js");
+let cliSpawningUnavailable = false;
+
 async function withTempDir(run) {
   const tempRoot = fs.mkdtempSync(path.join(os.tmpdir(), "setup-node-api-"));
   const previousCwd = process.cwd();
@@ -21,6 +25,55 @@ async function withTempDir(run) {
   }
 }
 
+function runCli(args, cwd) {
+  try {
+    return execFileSync(process.execPath, [cliPath, ...args], {
+      cwd,
+      encoding: "utf8",
+      stdio: ["ignore", "pipe", "pipe"],
+    });
+  } catch (error) {
+    if (error.code === "EPERM" && !error.stdout && !error.stderr) {
+      cliSpawningUnavailable = true;
+      throw new Error("CLI spawning is unavailable in this environment.");
+    }
+    throw error;
+  }
+}
+
+function runCliExpectFailure(args, cwd) {
+  try {
+    runCli(args, cwd);
+    throw new Error("Expected CLI command to fail");
+  } catch (error) {
+    if (!error.stdout && !error.stderr) {
+      throw error;
+    }
+
+    return {
+      stdout: error.stdout ?? "",
+      stderr: error.stderr ?? "",
+      status: error.status,
+    };
+  }
+}
+
+async function maybeRunCliTest(testFn) {
+  if (cliSpawningUnavailable) {
+    return "CLI spawning is unavailable in this environment.";
+  }
+
+  try {
+    await testFn();
+    return null;
+  } catch (error) {
+    if (error.message === "CLI spawning is unavailable in this environment.") {
+      return error.message;
+    }
+    throw error;
+  }
+}
+
 async function testJavaScriptTemplate() {
   await withTempDir(async (tempRoot) => {
     await createProject("sample-api", {
@@ -90,6 +143,64 @@ async function testCreateAppRejectsExistingDirectoryAfterPromptResolution() {
   });
 }
 
+async function testCliHelpOutput() {
+  const output = runCli(["--help"], process.cwd());
+
+  assert.match(output, /Scaffold a Node\.js \+ Express API/);
+  assert.match(output, /--typescript/);
+  assert.match(output, /--no-install/);
+}
+
+async function testCliScaffoldsJavaScriptProject() {
+  await withTempDir(async (tempRoot) => {
+    const output = runCli(["cli-js-app", "--no-install", "--port", "5050"], tempRoot);
+
+    const packageJson = JSON.parse(
+      fs.readFileSync(path.join(tempRoot, "cli-js-app", "package.json"), "utf8")
+    );
+    const appFile = fs.readFileSync(
+      path.join(tempRoot, "cli-js-app", "src", "app.js"),
+      "utf8"
+    );
+    const envFile = fs.readFileSync(path.join(tempRoot, "cli-js-app", ".env"), "utf8");
+
+    assert.equal(packageJson.name, "cli-js-app");
+    assert.equal(packageJson.private, true);
+    assert.match(appFile, /app\.get\("\/health"/);
+    assert.equal(envFile, "PORT=5050\n");
+    assert.match(output, /Project ready\./);
+  });
+}
+
+async function testCliScaffoldsTypeScriptProject() {
+  await withTempDir(async (tempRoot) => {
+    runCli(["cli-ts-app", "--typescript", "--no-install"], tempRoot);
+
+    const packageJson = JSON.parse(
+      fs.readFileSync(path.join(tempRoot, "cli-ts-app", "package.json"), "utf8")
+    );
+    const tsconfig = fs.readFileSync(
+      path.join(tempRoot, "cli-ts-app", "tsconfig.json"),
+      "utf8"
+    );
+
+    assert.equal(packageJson.name, "cli-ts-app");
+    assert.equal(packageJson.private, true);
+    assert.match(tsconfig, /"target": "ES2020"/);
+    assert.match(tsconfig, /"forceConsistentCasingInFileNames": true/);
+  });
+}
+
+async function testCliRejectsInvalidPort() {
+  const { stdout, status } = runCliExpectFailure(
+    ["demo-app", "--no-install", "--port", "99999"],
+    process.cwd()
+  );
+
+  assert.equal(status, 1);
+  assert.match(stdout, /Port must be an integer between 1 and 65535\./);
+}
+
 async function main() {
   const tests = [
     ["JavaScript template customization", testJavaScriptTemplate],
@@ -100,14 +211,34 @@ async function main() {
       "Existing-directory protection after final project resolution",
       testCreateAppRejectsExistingDirectoryAfterPromptResolution,
     ],
+    ["CLI help output", () => maybeRunCliTest(testCliHelpOutput)],
+    [
+      "CLI JavaScript scaffold smoke test",
+      () => maybeRunCliTest(testCliScaffoldsJavaScriptProject),
+    ],
+    [
+      "CLI TypeScript scaffold smoke test",
+      () => maybeRunCliTest(testCliScaffoldsTypeScriptProject),
+    ],
+    ["CLI invalid port handling", () => maybeRunCliTest(testCliRejectsInvalidPort)],
   ];
+  let passedCount = 0;
+  let skippedCount = 0;
 
   for (const [name, testFn] of tests) {
-    await testFn();
+    const note = await testFn();
+
+    if (note) {
+      skippedCount += 1;
+      console.log(`SKIP ${name}: ${note}`);
+      continue;
+    }
+
+    passedCount += 1;
     console.log(`PASS ${name}`);
   }
 
-  console.log(`\n${tests.length} tests passed`);
+  console.log(`\n${passedCount} tests passed, ${skippedCount} skipped`);
 }
 
 main().catch((error) => {