fastnode-cli 0.1.2 → 0.2.0

package/README.md

@@ -1,121 +1,113 @@
-# 🧪 fastnode-cli
-
-**The official CLI tool for scaffolding and managing FastNode projects** — bringing the simplicity of FastAPI to the Node.js ecosystem with NestJS under the hood.
-
----
-
-## 🚀 Features
-
-- 📦 Instantly scaffold a FastNode-based project
-- 🧱 Generate modules, services, controllers, and more
-- ⚙️ Built-in support for TypeScript
-- 📂 Clean project structure inspired by FastAPI
-- 🧪 Easy to extend and integrate with `fastnode-core`
-
----
-
-## 📦 Installation
-
-```bash
-npm install -g fastnode-cli
-```
-
----
-
-## 🛠️ Usage
-
-### Create a new project
-
-```bash
-fastnode create my-app
-```
-### Install Packages
-```bash
-cd my-app
-npm install
-```
-
-### Run the Project
-```bash
-fastnode serve my-app
-
-```
-
-
-
-This creates a new FastNode project in the `my-app` folder.
-
-### Generate a module
-
-```bash
-fastnode generate module user
-```
-
-Creates a `user` module with its own folder, service, and controller.
-
-### Generate a service
-
-```bash
-fastnode generate service auth
-```
-
-### Generate a controller
-
-```bash
-fastnode generate controller auth
-```
-
----
-
-## 📁 Folder Structure
-
-Here’s what a typical FastNode project looks like:
-
-```
-src/
-├── app.module.ts
-├── main.ts
-└── modules/
-    ├── user/
-    │   ├── user.controller.ts
-    │   ├── user.module.ts
-    │   └── user.service.ts
-```
-
----
-
-## 🔧 Configuration
-
-You can customize the CLI's behavior with a `.fastnoderc` config file (coming soon).
-
----
-
-## 📚 Documentation
-
-See the core framework:  
-👉 [`fastnode-core`](https://www.npmjs.com/package/fastnode-core)
-
----
-
-## 🤝 Contributing
-
-Pull requests are welcome! Please open an issue first to discuss what you’d like to change.
-
----
-
-## 📄 License
-
-MIT License
-
----
-
-## 💡 Inspiration
-
-Inspired by how fast and intuitive **FastAPI** is for Python developers, `fastnode` aims to bring that same DX (developer experience) to the **Node.js/NestJS** world.
-
----
-
-## 🔗 Links
-
-- CLI: [fastnode-cli on npm](https://www.npmjs.com/package/fastnode-cli)
-- Core: [fastnode-core on npm](https://www.npmjs.com/package/fastnode-core)
+# fastnode-cli
+
+`fastnode-cli` scaffolds FastNode applications and works with `fastnode-core`.
+
+FastNode is built on Fastify and is not NestJS internally.
+
+## Features
+
+- Create a new FastNode app quickly
+- Generate a starter TypeScript project
+- Scaffold an app that already shows execution policy usage
+- Works with `fastnode-core`
+
+## Installation
+
+```bash
+npm install -g fastnode-cli
+```
+
+## Usage
+
+### Create a project
+
+```bash
+fastnode create my-app
+cd my-app
+npm install
+```
+
+### Start the generated app
+
+```bash
+fastnode serve my-app
+```
+
+### Generate a controller
+
+```bash
+fastnode generate controller items
+```
+
+This creates:
+
+```txt
+src/items/items.controller.ts
+```
+
+## What the Scaffold Includes
+
+The generated app now includes a simple execution policy example:
+
+- app-level default execution policy in `createApp(...)`
+- controller-level policy with `@ExecutionPolicy(...)`
+- FastAPI-style path placeholders like `/{item_id}`
+- parameter decorators like `@Param()` and `@Query()`
+
+Example generated shape:
+
+```ts
+import "reflect-metadata";
+import {
+  Controller,
+  ExecutionPolicy,
+  Get,
+  Module,
+  Param,
+  Query,
+  createApp,
+} from "fastnode-core";
+
+@Controller("/hello")
+@ExecutionPolicy({ timeout: 5000 })
+class HelloController {
+  @Get("/")
+  hello(@Query("name") name?: string) {
+    return {
+      message: `Hello from hello${name ? `, ${name}` : ""}`,
+    };
+  }
+
+  @Get("/{item_id}")
+  getOne(@Param("item_id") itemId: number) {
+    return { item_id: itemId };
+  }
+}
+
+@Module({ controllers: [HelloController] })
+class HelloModule {}
+
+createApp([HelloModule], {
+  executionPolicy: {
+    timeout: 30000,
+    mode: "inline",
+  },
+}).listen(3000);
+```
+
+Generated controller files also include request-data examples for:
+
+- `@Param("id")`
+- `@Query("page")`
+- `@Body()`
+- `@Body("name")`
+
+## Related Docs
+
+See `packages/core/README.md` for the full execution policy guide, including:
+
+- `@ExecutionPolicy()`
+- `@UseExecutionPolicy()`
+- `@IsolatedHandler()`
+- inline vs isolated execution
+- timeout response behavior

package/dist/index.js

@@ -7,76 +7,200 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const child_process_1 = require("child_process");
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
-const [, , command, arg] = process.argv;
-if (command === "create" && arg) {
-    const projectDir = path_1.default.resolve(arg);
-    const moduleDir = path_1.default.join(projectDir, "src", arg);
+const [, , command, resource, name] = process.argv;
+if (command === "create" && resource) {
+    createProject(resource);
+}
+else if (command === "serve" && resource) {
+    serveProject(resource);
+}
+else if (command === "generate" && resource === "controller" && name) {
+    generateController(name);
+}
+else {
+    printUsage();
+}
+function createProject(projectName) {
+    const projectDir = path_1.default.resolve(projectName);
+    const moduleDir = path_1.default.join(projectDir, "src", projectName);
     fs_1.default.mkdirSync(moduleDir, { recursive: true });
-    // 1️⃣ main.ts
-    const mainFile = path_1.default.join(moduleDir, "main.ts");
-    fs_1.default.writeFileSync(mainFile, `import "reflect-metadata";
-import { Controller, Get, Module, createApp } from "fastnode-core";
-
-@Controller("/${arg}")
-class ${capitalize(arg)}Controller {
-  @Get("/")
-  hello() {
-    return { message: "Hello from ${arg}" };
-  }
-}
-
-@Module({ controllers: [${capitalize(arg)}Controller] })
-class ${capitalize(arg)}Module {}
-
-createApp([${capitalize(arg)}Module]).listen(3000);
-`);
-    // 2️⃣ tsconfig.json
-    fs_1.default.writeFileSync(path_1.default.join(projectDir, "tsconfig.json"), `{
-  "compilerOptions": {
-    "target": "ES2020",
-    "module": "CommonJS",
-    "rootDir": "./src",
-    "outDir": "./dist",
-    "strict": true,
-    "esModuleInterop": true,
-    "experimentalDecorators": true,
-    "emitDecoratorMetadata": true,
-    "useDefineForClassFields": false
-  },
-  "include": ["src"]
-}
+    fs_1.default.writeFileSync(path_1.default.join(moduleDir, "main.ts"), buildMainTemplate(projectName));
+    fs_1.default.writeFileSync(path_1.default.join(projectDir, "tsconfig.json"), `{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "CommonJS",
+    "rootDir": "./src",
+    "outDir": "./dist",
+    "strict": true,
+    "esModuleInterop": true,
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "useDefineForClassFields": false
+  },
+  "include": ["src"]
+}
 `);
-    // 3️⃣ package.json
-    fs_1.default.writeFileSync(path_1.default.join(projectDir, "package.json"), `{
-  "name": "${arg}",
-  "version": "1.0.0",
-  "type": "commonjs",
-  "main": "dist/index.js",
-  "scripts": {
-    "dev": "tsx src/${arg}/main.ts",
-    "build": "tsc",
-    "start": "node dist/${arg}/main.js"
-  },
-  "dependencies": {
-    "fastnode-core": "latest",
-    "reflect-metadata": "^0.1.13"
-  },
-  "devDependencies": {
-    "tsx": "^4.7.0",
-    "typescript": "^5.0.0"
-  }
-}
+    fs_1.default.writeFileSync(path_1.default.join(projectDir, "package.json"), `{
+  "name": "${projectName}",
+  "version": "1.0.0",
+  "type": "commonjs",
+  "main": "dist/index.js",
+  "scripts": {
+    "dev": "tsx src/${projectName}/main.ts",
+    "build": "tsc",
+    "start": "node dist/${projectName}/main.js"
+  },
+  "dependencies": {
+    "fastnode-core": "latest",
+    "reflect-metadata": "^0.1.13"
+  },
+  "devDependencies": {
+    "tsx": "^4.7.0",
+    "typescript": "^5.0.0"
+  }
+}
 `);
-    console.log(`✔ Project '${arg}' created at ${projectDir}`);
+    console.log(`✔ Project '${projectName}' created at ${projectDir}`);
 }
-if (command === "serve" && arg) {
-    const entry = path_1.default.resolve(process.cwd(), `src/${arg}/main.ts`);
+function serveProject(projectName) {
+    const entry = path_1.default.resolve(process.cwd(), `src/${projectName}/main.ts`);
     if (!fs_1.default.existsSync(entry)) {
         console.error(`❌ Cannot find module at ${entry}`);
         process.exit(1);
     }
     (0, child_process_1.execSync)(`npx tsx ${entry}`, { stdio: "inherit" });
 }
-function capitalize(str) {
-    return str.charAt(0).toUpperCase() + str.slice(1);
+function generateController(controllerName) {
+    const normalizedName = toKebabCase(controllerName);
+    const className = `${toPascalCase(controllerName)}Controller`;
+    const controllerDir = path_1.default.resolve(process.cwd(), "src", normalizedName);
+    const controllerFile = path_1.default.join(controllerDir, `${normalizedName}.controller.ts`);
+    fs_1.default.mkdirSync(controllerDir, { recursive: true });
+    if (fs_1.default.existsSync(controllerFile)) {
+        console.error(`❌ Controller already exists at ${controllerFile}`);
+        process.exit(1);
+    }
+    fs_1.default.writeFileSync(controllerFile, buildControllerTemplate(normalizedName));
+    console.log(`✔ Controller '${normalizedName}' created at ${controllerFile}`);
+    console.log(`ℹ Add ${className} to a module so FastNode can register it.`);
+}
+function buildMainTemplate(projectName) {
+    const className = `${toPascalCase(projectName)}Controller`;
+    const moduleName = `${toPascalCase(projectName)}Module`;
+    return `import "reflect-metadata";
+import {
+  Controller,
+  ExecutionPolicy,
+  Get,
+  Module,
+  Param,
+  Query,
+  createApp,
+} from "fastnode-core";
+
+@Controller("/${projectName}")
+@ExecutionPolicy({ timeout: 5000 })
+class ${className} {
+  @Get("/")
+  hello(@Query("name") name?: string) {
+    return {
+      message: \`Hello from ${projectName}\${name ? \`, \${name}\` : ""}\`,
+    };
+  }
+
+  @Get("/{item_id}")
+  getOne(
+    @Param("item_id") itemId: number,
+    @Query("include") include?: string
+  ) {
+    return {
+      item_id: itemId,
+      include,
+    };
+  }
+}
+
+@Module({ controllers: [${className}] })
+class ${moduleName} {}
+
+createApp([${moduleName}], {
+  executionPolicy: {
+    timeout: 30000,
+    mode: "inline",
+  },
+}).listen(3000);
+`;
+}
+function buildControllerTemplate(controllerName) {
+    const className = `${toPascalCase(controllerName)}Controller`;
+    return `import {
+  Body,
+  Controller,
+  Get,
+  Param,
+  Query,
+} from "fastnode-core";
+
+@Controller("/${controllerName}")
+export class ${className} {
+  @Get("/")
+  list(
+    @Query("page") page?: number,
+    @Query("search") search?: string
+  ) {
+    return {
+      resource: "${controllerName}",
+      page,
+      search,
+    };
+  }
+
+  @Get("/{id}")
+  findOne(
+    @Param("id") id: number,
+    @Query("expand") expand?: string
+  ) {
+    return {
+      id,
+      expand,
+    };
+  }
+
+  @Get("/request/echo")
+  echoRequest(
+    @Body() payload?: Record<string, unknown>,
+    @Body("name") name?: string
+  ) {
+    return {
+      payload,
+      name,
+    };
+  }
+}
+`;
+}
+function capitalize(value) {
+    return value.charAt(0).toUpperCase() + value.slice(1);
+}
+function toPascalCase(value) {
+    return toKebabCase(value)
+        .split("-")
+        .filter(Boolean)
+        .map(capitalize)
+        .join("");
+}
+function toKebabCase(value) {
+    return value
+        .replace(/([a-z0-9])([A-Z])/g, "$1-$2")
+        .replace(/[\s_]+/g, "-")
+        .toLowerCase();
+}
+function printUsage() {
+    console.log(`FastNode CLI
+
+Usage:
+  fastnode create <project-name>
+  fastnode serve <project-name>
+  fastnode generate controller <controller-name>
+`);
 }

package/package.json

@@ -1,39 +1,41 @@
-{
-  "name": "fastnode-cli",
-  "version": "0.1.2",
-  "description": "A CLI tool for generating and managing FastNode projects using NestJS, inspired by FastAPI.",
-  "bin": {
-    "fastnode": "dist/index.js"
-  },
-  "main": "dist/index.js",
-  "scripts": {
-    "start": "node bin/index.js",
-    "build": "tsc"
-  },
-  "keywords": [
-    "cli",
-    "fastapi",
-    "nestjs",
-    "nodejs",
-    "scaffolding",
-    "generator",
-    "fastnode"
+{
+  "name": "fastnode-cli",
+  "version": "0.2.0",
+  "description": "The official CLI for scaffolding and serving FastNode applications.",
+  "bin": {
+    "fastnode": "dist/index.js"
+  },
+  "main": "dist/index.js",
+  "files": ["dist", "README.md"],
+  "scripts": {
+    "start": "node dist/index.js",
+    "build": "tsc",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "cli",
+    "fastapi",
+    "nodejs",
+    "scaffolding",
+    "generator",
+    "fastnode"
   ],
   "author": "Valentine Emmanuel Ikechukwu",
   "license": "MIT",
-  "dependencies": {
-    "chalk": "^5.3.0",
-    "commander": "^11.0.0",
-    "fastnode-core": "latest",
-    "reflect-metadata": "^0.1.13"
-  },
-  "devDependencies": {
-    "typescript": "^5.0.0"
-  },
+  "dependencies": {
+    "chalk": "^5.3.0",
+    "commander": "^11.0.0",
+    "fastnode-core": "^0.2.0",
+    "reflect-metadata": "^0.1.13"
+  },
+  "devDependencies": {
+    "@types/node": "^24.5.2",
+    "typescript": "^5.0.0"
+  },
   "engines": {
     "node": ">=18.0.0"
   },
-  "publishConfig": {
-    "access": "public"
-  }
-}
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/index.ts

@@ -1,97 +0,0 @@
-#!/usr/bin/env node
-import { execSync } from "child_process";
-import fs from "fs";
-import path from "path";
-
-const [, , command, arg] = process.argv;
-
-if (command === "create" && arg) {
-  const projectDir = path.resolve(arg);
-  const moduleDir = path.join(projectDir, "src", arg);
-
-  fs.mkdirSync(moduleDir, { recursive: true });
-
-  // 1️⃣ main.ts
-  const mainFile = path.join(moduleDir, "main.ts");
-  fs.writeFileSync(
-    mainFile,
-    `import "reflect-metadata";
-import { Controller, Get, Module, createApp } from "fastnode-core";
-
-@Controller("/${arg}")
-class ${capitalize(arg)}Controller {
-  @Get("/")
-  hello() {
-    return { message: "Hello from ${arg}" };
-  }
-}
-
-@Module({ controllers: [${capitalize(arg)}Controller] })
-class ${capitalize(arg)}Module {}
-
-createApp([${capitalize(arg)}Module]).listen(3000);
-`
-  );
-
-  // 2️⃣ tsconfig.json
-  fs.writeFileSync(
-    path.join(projectDir, "tsconfig.json"),
-    `{
-  "compilerOptions": {
-    "target": "ES2020",
-    "module": "CommonJS",
-    "rootDir": "./src",
-    "outDir": "./dist",
-    "strict": true,
-    "esModuleInterop": true,
-    "experimentalDecorators": true,
-    "emitDecoratorMetadata": true,
-    "useDefineForClassFields": false
-  },
-  "include": ["src"]
-}
-`
-  );
-
-  // 3️⃣ package.json
-  fs.writeFileSync(
-    path.join(projectDir, "package.json"),
-    `{
-  "name": "${arg}",
-  "version": "1.0.0",
-  "type": "commonjs",
-  "main": "dist/index.js",
-  "scripts": {
-    "dev": "tsx src/${arg}/main.ts",
-    "build": "tsc",
-    "start": "node dist/${arg}/main.js"
-  },
-  "dependencies": {
-    "fastnode-core": "latest",
-    "reflect-metadata": "^0.1.13"
-  },
-  "devDependencies": {
-    "tsx": "^4.7.0",
-    "typescript": "^5.0.0"
-  }
-}
-`
-  );
-
-  console.log(`✔ Project '${arg}' created at ${projectDir}`);
-}
-
-if (command === "serve" && arg) {
-  const entry = path.resolve(process.cwd(), `src/${arg}/main.ts`);
-
-  if (!fs.existsSync(entry)) {
-    console.error(`❌ Cannot find module at ${entry}`);
-    process.exit(1);
-  }
-
-  execSync(`npx tsx ${entry}`, { stdio: "inherit" });
-}
-
-function capitalize(str: string): string {
-  return str.charAt(0).toUpperCase() + str.slice(1);
-}

package/tsconfig.json

@@ -1,9 +0,0 @@
-{
-  "compilerOptions": {
-    "module": "CommonJS",
-    "target": "ES2020",
-    "esModuleInterop": true,
-    "outDir": "dist"
-  },
-  "include": ["src"]
-}