create-colonel 0.1.7 → 1.0.0

package/README.md

@@ -10,17 +10,17 @@ Scaffold a new Colonel app from the command line.
 ## Usage
 
 ```bash
-bun create colonel my-app
+bunx create-colonel my-app
 ```
 
-Alternative entry points:
+Optional flag:
 
 ```bash
-bunx create-colonel my-app
-npx create-colonel my-app
-npm create colonel@latest my-app
+bunx create-colonel my-app --skip-install
 ```
 
+Use `--skip-install` when you only want scaffolded files and prefer to install dependencies later.
+
 Then run your new app:
 
 ```bash

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-colonel",
-  "version": "0.1.7",
+  "version": "1.0.0",
   "type": "module",
   "files": [
     "src",

package/src/cli.ts

@@ -3,10 +3,20 @@
 import { cpSync, existsSync, mkdirSync, readdirSync, readFileSync, writeFileSync } from "node:fs";
 import { basename, resolve } from "node:path";
 
-const targetArg = process.argv[2];
+const args = process.argv.slice(2);
+const targetArg = args.find((arg) => !arg.startsWith("-"));
+const skipInstall = args.includes("--skip-install");
+const showHelp = args.includes("--help") || args.includes("-h");
+
+if (showHelp) {
+    console.log("Usage: bunx create-colonel <project-name> [--skip-install]");
+    console.log("\nOptions:");
+    console.log("  --skip-install    Scaffold files without running bun install");
+    process.exit(0);
+}
 
 if (!targetArg) {
-    console.error("Usage: bun create colonel <project-name>");
+    console.error("Usage: bunx create-colonel <project-name> [--skip-install]");
     process.exit(1);
 }
 
@@ -36,18 +46,25 @@ if (existsSync(resolve(localFrameworkPath, "package.json"))) {
 
 writeFileSync(packageJsonPath, `${JSON.stringify(packageJson, null, 2)}\n`);
 
-console.log("Installing dependencies...");
-const install = Bun.spawnSync(["bun", "install"], {
-    cwd: targetDir,
-    stdout: "inherit",
-    stderr: "inherit",
-});
+if (!skipInstall) {
+    console.log("Installing dependencies...");
+    const install = Bun.spawnSync(["bun", "install"], {
+        cwd: targetDir,
+        stdout: "inherit",
+        stderr: "inherit",
+    });
 
-if (install.exitCode !== 0) {
-    console.error("Project was created, but dependency installation failed.");
-    process.exit(install.exitCode);
+    if (install.exitCode !== 0) {
+        console.error("Project was created, but dependency installation failed.");
+        process.exit(install.exitCode);
+    }
 }
 
 console.log("\nColonel app created successfully.\n");
 console.log(`  cd ${targetArg}`);
+
+if (skipInstall) {
+    console.log("  bun install");
+}
+
 console.log("  bun run start\n");

package/template/package.json

@@ -1,6 +1,6 @@
 {
   "name": "colonel-app",
-  "version": "0.1.5",
+  "version": "1.0.0",
   "type": "module",
   "private": true,
   "scripts": {
@@ -8,7 +8,7 @@
     "upgrade:colonel": "bun add @coloneldev/framework@latest"
   },
   "dependencies": {
-    "@coloneldev/framework": "^0.1.6",
+    "@coloneldev/framework": "^1.0.0",
     "ejs": "^5.0.1"
   },
   "devDependencies": {

package/template/src/app/Http/Controllers/UserController.ts

@@ -1,4 +1,4 @@
-import type { HttpRequest } from "@coloneldev/framework";
+import { json, type HttpRequest } from "@coloneldev/framework";
 import Controller from "./Controller";
 
 
@@ -28,4 +28,23 @@ export class UserController extends Controller {
             }
         ]
     }
+
+    create(req: HttpRequest): Response {
+        const payload = req.validate({
+            name: { required: true, type: "string", minLength: 2, maxLength: 80 },
+            email: {
+                required: true,
+                type: "string",
+                pattern: /^[^@\s]+@[^@\s]+\.[^@\s]+$/,
+            },
+        });
+
+        return json({
+            message: "User payload accepted",
+            user: {
+                name: payload.name,
+                email: payload.email,
+            },
+        }, 201);
+    }
 }   

package/template/src/app/Http/Middleware/RequireJsonForWrites.ts

@@ -0,0 +1,11 @@
+import { badRequest, type HttpRequest } from "@coloneldev/framework";
+
+export async function requireJsonForWrites(req: HttpRequest, next: () => Promise<unknown>): Promise<unknown> {
+    if (["POST", "PUT", "PATCH", "DELETE"].includes(req.method) && !req.isJson()) {
+        return badRequest("Write requests must use application/json", {
+            hint: "Set Content-Type: application/json",
+        });
+    }
+
+    return next();
+}

package/template/src/app/Http/Middleware/TraceHeader.ts

@@ -0,0 +1,18 @@
+import type { HttpRequest } from "@coloneldev/framework";
+
+export async function traceHeader(req: HttpRequest, next: () => Promise<unknown>): Promise<unknown> {
+    const result = await next();
+
+    if (!(result instanceof Response)) {
+        return result;
+    }
+
+    const headers = new Headers(result.headers);
+    headers.set("x-colonel-trace", `${req.method} ${req.path()}`);
+
+    return new Response(result.body, {
+        status: result.status,
+        statusText: result.statusText,
+        headers,
+    });
+}

package/template/src/bootstrap/server.ts

@@ -7,6 +7,8 @@ import { staticPaths } from "../config/staticPaths";
 import path, { extname } from "path";
 import { Container } from "@coloneldev/framework";
 import { AppInfoService } from "../app/Services/AppInfoService.ts";
+import { requireJsonForWrites } from "../app/Http/Middleware/RequireJsonForWrites.ts";
+import { traceHeader } from "../app/Http/Middleware/TraceHeader.ts";
 
 const viewsRoot = path.resolve(import.meta.dir, "..", "..", "resources", "views");
 const publicRoot = path.resolve(import.meta.dir, "..", "..", "public");
@@ -22,7 +24,10 @@ container.singleton(
 );
 
 export const server = () => {
-    const Colonel = new Kernel(webRouter, [], {
+    const Colonel = new Kernel(webRouter, [
+        requireJsonForWrites,
+        traceHeader,
+    ], {
         viewsRoot,
         session: {
             enabled: true,

package/template/src/config/routes/web.ts

@@ -13,6 +13,7 @@ web.get('/', 'AppController@index');
 web.group('/users', (users) => {
 	users.get('/', 'UserController@index');
 	users.get('/:id', 'UserController@show');
+	users.post('/', 'UserController@create');
 });
 
 export default web;