setup-express-api 1.0.1 → 1.2.0

package/README.md

@@ -1,6 +1,17 @@
 # setup-express-api
 
 Scaffold an Express API into the current empty directory.
+Generated project `package.json` defaults to version `0.1.0` (minimum supported scaffolded version).
+
+## Test scaffold script
+
+Generate a local test scaffold under `.express-api/`:
+
+```sh
+npm run scaffold
+```
+
+This script recreates `.express-api/` on each run (deletes it first if it already exists).
 
 ## Usage
 

package/bin/cli.js

@@ -28,6 +28,7 @@ try {
     const projectConfig = skipPrompts
         ? {
             name: path.basename(targetDir).toLowerCase().replace(/[^a-z0-9-]/g, "-").replace(/-+/g, "-").replace(/^-|-$/g, "") || "express-api-server",
+            version: "0.1.0",
             description: "",
             author: "",
             license: "MIT"

package/package.json

@@ -1,37 +1,38 @@
-{
-    "name": "setup-express-api",
-    "version": "1.0.1",
-    "description": "Create an Express API with auth features with better-auth.",
-    "type": "module",
-    "bin": {
-        "setup-express-api": "./bin/cli.js"
-    },
-    "files": [
-        "bin",
-        "src"
-    ],
-    "scripts": {
-        "test": "node --test test/*.test.js"
-    },
-    "dependencies": {
-        "@thantpyaeshine/express-api": "1.0.0"
-    },
-    "keywords": [
-        "setup-express-api",
-        "create-express-api",
-        "express",
-        "cli",
-        "api",
-        "typescript",
-        "better-auth"
-    ],
-    "license": "MIT",
-    "engines": {
-        "node": ">=22"
-    },
-    "allowScripts": {
-        "esbuild": true,
-        "@parcel/watcher": true,
-        "unrs-resolver": true
-    }
+{
+    "name": "setup-express-api",
+    "version": "1.2.0",
+    "description": "Create an Express API with basic features set up.",
+    "type": "module",
+    "bin": {
+        "setup-express-api": "./bin/cli.js"
+    },
+    "files": [
+        "bin",
+        "src"
+    ],
+    "scripts": {
+        "test": "node --test test/*.test.js",
+        "scaffold": "node scripts/scaffold-test.js"
+    },
+    "dependencies": {
+        "@thantpyaeshine/express-api": "1.2.0"
+    },
+    "keywords": [
+        "setup-express-api",
+        "create-express-api",
+        "express",
+        "cli",
+        "api",
+        "typescript",
+        "better-auth"
+    ],
+    "license": "MIT",
+    "engines": {
+        "node": ">=22"
+    },
+    "allowScripts": {
+        "esbuild": true,
+        "@parcel/watcher": true,
+        "unrs-resolver": true
+    }
 }

package/src/scaffold.js

@@ -102,14 +102,11 @@ export async function scaffold(targetDir, options = {}) {
 
     try {
         fs.cpSync(templateDirectory, targetDir, { recursive: true });
-        if (options.projectConfig) {
-            const generatedPackagePath = path.join(targetDir, "package.json");
-            const generatedPackage = readPackageJson(generatedPackagePath, "generated project");
-            fs.writeFileSync(
-                generatedPackagePath,
-                `${JSON.stringify({ ...generatedPackage, ...options.projectConfig }, null, 2)}\n`
-            );
-        }
+        const generatedPackagePath = path.join(targetDir, "package.json");
+        const generatedPackage = readPackageJson(generatedPackagePath, "generated project");
+        const mergedPackage = options.projectConfig ? { ...generatedPackage, ...options.projectConfig } : generatedPackage;
+        delete mergedPackage.publishConfig;
+        fs.writeFileSync(generatedPackagePath, `${JSON.stringify(mergedPackage, null, 2)}\n`);
     } catch {
         throw new Error(`Unable to copy template files into: ${targetDir}`);
     }

package/src/utils/project-config.js

@@ -2,6 +2,8 @@ import path from "node:path";
 import { stdin as input, stdout as output } from "node:process";
 import readline from "node:readline/promises";
 
+const MINIMUM_PACKAGE_VERSION = "0.1.0";
+
 function toPackageName(value) {
     return value
         .toLowerCase()
@@ -10,6 +12,27 @@ function toPackageName(value) {
         .replace(/^-|-$/g, "");
 }
 
+function compareVersions(left, right) {
+    const parseParts = (value) =>
+        String(value ?? "0")
+            .split("-")[0]
+            .split(".")
+            .map((part) => Number.parseInt(part, 10) || 0);
+
+    const leftParts = parseParts(left);
+    const rightParts = parseParts(right);
+    const maxLength = Math.max(leftParts.length, rightParts.length);
+
+    for (let index = 0; index < maxLength; index += 1) {
+        const difference = (leftParts[index] ?? 0) - (rightParts[index] ?? 0);
+        if (difference !== 0) {
+            return difference;
+        }
+    }
+
+    return 0;
+}
+
 async function ask(prompt, question, defaultValue = "") {
     const suffix = defaultValue ? ` (${defaultValue})` : "";
     const answer = await prompt.question(`${question}${suffix}: `);
@@ -25,6 +48,15 @@ async function askPackageName(prompt, defaultValue) {
     return packageName;
 }
 
+async function askPackageVersion(prompt) {
+    let version = await ask(prompt, "Version", MINIMUM_PACKAGE_VERSION);
+    while (compareVersions(version, MINIMUM_PACKAGE_VERSION) < 0) {
+        console.log(`Version must be ${MINIMUM_PACKAGE_VERSION} or higher.`);
+        version = await ask(prompt, "Version", MINIMUM_PACKAGE_VERSION);
+    }
+    return version;
+}
+
 export async function promptForProjectConfig(targetDir) {
     const prompt = readline.createInterface({ input, output });
     const defaultName = toPackageName(path.basename(targetDir)) || "express-api-server";
@@ -33,6 +65,7 @@ export async function promptForProjectConfig(targetDir) {
         console.log("\nCreate an Express API\n");
         return {
             name: await askPackageName(prompt, defaultName),
+            version: await askPackageVersion(prompt),
             description: await ask(prompt, "Description"),
             author: await ask(prompt, "Author"),
             license: await ask(prompt, "License", "MIT")