@avleon/cli 0.0.45 → 0.0.47

package/dist/create.js

@@ -147,7 +147,8 @@ async function askForFeatures() {
             choices: [
                 { name: 'OpenAPI / Swagger docs', value: 'openapi', checked: true },
                 { name: 'CORS support', value: 'cors', checked: false },
-                { name: 'TypeORM database', value: 'typeorm', checked: false },
+                { name: 'TypeORM', value: 'typeorm', checked: false },
+                { name: 'Knex', value: 'knex', checked: false },
                 { name: 'Scalar UI (replaces Swagger UI)', value: 'scalar', checked: false },
             ],
         },
@@ -187,83 +188,84 @@ async function writeFile(filePath, content, label) {
 }
 // ─── Templates ────────────────────────────────────────────────────────────────
 function homeServiceTemplate() {
-    return `
-import { AppService } from '@avleon/core';
-
-@AppService
-export class HomeService {
-    sayHello() {
-        return { message: 'Hello World!' };
-    }
-}
+    return `
+import { AppService } from '@avleon/core';
+
+@AppService
+export class HomeService {
+    sayHello() {
+        return { message: 'Hello World!' };
+    }
+}
 `;
 }
 function homeControllerTemplate() {
-    return `
-import { ApiController, Get } from '@avleon/core';
-import { HomeService } from '../services/home.service';
-
-@ApiController('/')
-export class HomeController {
-    constructor(private readonly homeService: HomeService) {}
-
-    @Get()
-    sayHello() {
-        return this.homeService.sayHello();
-    }
-}
+    return `
+import { ApiController, Get } from '@avleon/core';
+import { HomeService } from '../services/home.service';
+
+@ApiController('/')
+export class HomeController {
+    constructor(private readonly homeService: HomeService) {}
+
+    @Get()
+    sayHello() {
+        return this.homeService.sayHello();
+    }
+}
 `;
 }
 function homeControllerTestTemplate() {
-    return `
-import { AvleonTest } from '@avleon/core';
-import { HomeController } from './home.controller';
-
-describe('HomeController', () => {
-    let controller!: HomeController;
-
-    beforeAll(() => {
-        controller = AvleonTest.getController(HomeController);
-    });
-
-    it('should be defined', () => {
-        expect(controller).toBeDefined();
-    });
-
-    it('should have sayHello method', () => {
-        expect(typeof controller.sayHello).toBe('function');
-    });
-
-    it('should return hello message', () => {
-        expect(controller.sayHello()).toEqual({ message: 'Hello World!' });
-    });
-});
+    return `
+import { AvleonTest } from '@avleon/core';
+import { HomeController } from './home.controller';
+
+describe('HomeController', () => {
+    let controller!: HomeController;
+
+    beforeAll(() => {
+        controller = AvleonTest.getController(HomeController);
+    });
+
+    it('should be defined', () => {
+        expect(controller).toBeDefined();
+    });
+
+    it('should have sayHello method', () => {
+        expect(typeof controller.sayHello).toBe('function');
+    });
+
+    it('should return hello message', () => {
+        expect(controller.sayHello()).toEqual({ message: 'Hello World!' });
+    });
+});
 `;
 }
 function openApiConfigTemplate(fname, useScalar) {
-    return `
-import { AppConfig, Environment, IConfig } from '@avleon/core';
-
-@AppConfig
-export class OpenApiConfig implements IConfig {
-    config(env: Environment) {
-        return {
-            info: {
-                title: '${(0, lodash_1.capitalize)(fname)} API',
-                version: '0.0.1',
-                description: 'API documentation for ${(0, lodash_1.capitalize)(fname)}',
-            },
-            ${useScalar ? "provider: 'scalar'," : ''}
-            routePrefix: '/docs',
-        };
-    }
-}
+    return `
+import { AppConfig, AvleonConfig, Environment, OpenApiUiOptions } from '@avleon/core';
+
+@AppConfig
+export class OpenApiConfig extends AvleonConfig<OpenApiUiOptions> {
+    config(env: Environment): OpenApiUiOptions {
+        return {
+            info: {
+                title: '${(0, lodash_1.capitalize)(fname)} API',
+                version: '0.0.1',
+                description: 'API documentation for ${(0, lodash_1.capitalize)(fname)}',
+            },
+            ${useScalar ? "provider: 'scalar'," : ''}
+            routePrefix: '/docs',
+        };
+    }
+}
 `;
 }
 function appTemplate(features) {
     const hasOpenApi = features.includes('openapi');
     const hasCors = features.includes('cors');
     const hasTypeorm = features.includes('typeorm');
+    const hasKnex = features.includes('knex');
     const imports = [`import { Avleon } from '@avleon/core';`];
     imports.push(`import { HomeController } from './controllers/home.controller';`);
     if (hasOpenApi) {
@@ -280,8 +282,13 @@ function appTemplate(features) {
         body.push('');
     }
     if (hasTypeorm) {
-        body.push(`// TODO: configure datasource in src/config/database.config.ts`);
-        body.push(`// app.useDatasource(AppDataSource);`);
+        body.push(`// TODO: pass your TypeORM DataSourceOptions (or an @AppConfig class)`);
+        body.push(`// await app.useTypeORM({ type: 'postgres', url: process.env.DATABASE_URL, entities: [] });`);
+        body.push('');
+    }
+    if (hasKnex) {
+        body.push(`// TODO: pass your Knex config (or an @AppConfig class)`);
+        body.push(`// await app.useKnex({ client: 'pg', connection: process.env.DATABASE_URL });`);
         body.push('');
     }
     body.push(`app.useControllers([HomeController]);`);
@@ -290,14 +297,17 @@ function appTemplate(features) {
     return `${imports.join('\n')}\n\n${body.join('\n')}\n`;
 }
 function serveTemplate() {
-    return `
-import app from './app';
-
-async function start() {
-    await app.run(); // default port: 4000
-}
-
-start();
+    return `
+import { Environment, inject } from '@avleon/core';
+import app from './app';
+
+async function start() {
+    const env = inject(Environment);
+    const port = env.get<number>('PORT') || 4000;
+    await app.run(port);
+}
+
+start();
 `;
 }
 function packageJsonTemplate(fname, features) {
@@ -318,6 +328,10 @@ function packageJsonTemplate(fname, features) {
         deps['typeorm'] = resolveDepVersion('typeorm', '^0.3.20');
         deps['pg'] = resolveDepVersion('pg', '^8.11.0');
     }
+    if (features.includes('knex')) {
+        deps['knex'] = resolveDepVersion('knex', '^3.1.0');
+        deps['pg'] = resolveDepVersion('pg', '^8.11.0');
+    }
     if (features.includes('scalar')) {
         deps['@scalar/fastify-api-reference'] = resolveDepVersion('@scalar/fastify-api-reference', '^1.0.0');
     }
@@ -399,35 +413,35 @@ function envTemplate() {
 }
 function readmeTemplate(fname, pm) {
     const runCmd = pm === 'npm' ? 'npm run start:dev' : `${pm} start:dev`;
-    return `# ${(0, lodash_1.capitalize)(fname)}
-
-Built with [Avleon](https://github.com/xtareq/avleon).
-
-## Getting Started
-
-\`\`\`bash
-${runCmd}
-\`\`\`
-
-## Scripts
-
-| Script | Description |
-|--------|-------------|
-| \`start:dev\` | Start development server with hot reload |
-| \`build\`     | Compile TypeScript to JavaScript |
-| \`start\`     | Start production server |
-| \`test\`      | Run unit tests |
-
-## Project Structure
-
-\`\`\`
-src/
-├── controllers/   # Route controllers
-├── services/      # Business logic
-├── config/        # App configuration
-├── app.ts         # App setup
-└── serve.ts       # Entry point
-\`\`\`
+    return `# ${(0, lodash_1.capitalize)(fname)}
+
+Built with [Avleon](https://github.com/xtareq/avleon).
+
+## Getting Started
+
+\`\`\`bash
+${runCmd}
+\`\`\`
+
+## Scripts
+
+| Script | Description |
+|--------|-------------|
+| \`start:dev\` | Start development server with hot reload |
+| \`build\`     | Compile TypeScript to JavaScript |
+| \`start\`     | Start production server |
+| \`test\`      | Run unit tests |
+
+## Project Structure
+
+\`\`\`
+src/
+├── controllers/   # Route controllers
+├── services/      # Business logic
+├── config/        # App configuration
+├── app.ts         # App setup
+└── serve.ts       # Entry point
+\`\`\`
 `;
 }
 // ─── Main ─────────────────────────────────────────────────────────────────────

package/dist/helpers/path-helper.js

@@ -5,9 +5,24 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.pathHelper = void 0;
 const path_1 = __importDefault(require("path"));
-// export const __filename = fileURLToPath(process.argv[1])
-// export const __dirname = path.dirname(__filename)
-/*  */
+const fs_1 = require("fs");
+/**
+ * Resolve the package root (the directory holding `stubs/`) by walking up from
+ * this file. Compiled output lives under `dist/`, at a depth that differs per
+ * file, so anchoring on a fixed number of `..` segments is not reliable.
+ */
+function packageRoot() {
+    let dir = __dirname;
+    for (let i = 0; i < 5; i++) {
+        if ((0, fs_1.existsSync)(path_1.default.join(dir, 'stubs')))
+            return dir;
+        const parent = path_1.default.dirname(dir);
+        if (parent === dir)
+            break;
+        dir = parent;
+    }
+    return path_1.default.join(__dirname, '../..');
+}
 exports.pathHelper = {
     appSoucePath(p) {
         return path_1.default.join(process.cwd(), p ? './src/' + p : './src/');
@@ -16,6 +31,6 @@ exports.pathHelper = {
         return path_1.default.join(process.cwd(), p ? './test/' + p : './test/');
     },
     stubPath(p) {
-        return path_1.default.join(__dirname, p ? '../../stubs/' + p : '../../stubs/');
+        return path_1.default.join(packageRoot(), 'stubs', p ?? '');
     },
 };

package/dist/service.js

@@ -20,10 +20,10 @@ function lower(str) {
 }
 const servicesStubs = {
     basic: path_helper_1.pathHelper.stubPath('services/basic-service.stub'),
-    rest: path_helper_1.pathHelper.stubPath('services/basic-service.stub'),
+    rest: path_helper_1.pathHelper.stubPath('services/rest-service.stub'),
     ormRest: path_helper_1.pathHelper.stubPath('services/orm-rest-service.stub')
 };
-async function createService(name, options = { force: false, resource: false, prefix: true, rest: false, model: null, root: null }, p) {
+async function createService(name, options = { force: false, resource: false, prefix: true, rest: false, model: null, root: null, orm: false }, p) {
     if (!name) {
         throw new Error("Service name not found. use --name or npx avleon make:service HomeService");
     }
@@ -32,17 +32,13 @@ async function createService(name, options = { force: false, resource: false, pr
     }
     // determine stub for generate
     let stubPath = servicesStubs.basic;
-    if (options.rest) {
-        stubPath = servicesStubs.rest;
-        if (options.model) {
-            stubPath = servicesStubs.ormRest;
-        }
+    if (options.rest || options.resource) {
+        stubPath = options.orm ? servicesStubs.ormRest : servicesStubs.rest;
     }
     const rootPath = options.root ? 'src/' + options.root + '/' : 'src/services/';
-    if (name.split("/").length > 1) {
-        if (!(0, fs_1.existsSync)(path_1.default.join(rootPath, name.split("/").splice(-1, 1).join("/")))) {
-            await promises_1.default.mkdir(path_1.default.join(rootPath, name.replace('/' + file_helper_1.fh.filenameFromPath(name), '')), { recursive: true });
-        }
+    const outDir = path_1.default.join(rootPath, (0, file_helper_1.getFilePathWithoutName)(name));
+    if (!(0, fs_1.existsSync)(outDir)) {
+        await promises_1.default.mkdir(outDir, { recursive: true });
     }
     const content = await promises_1.default.readFile(stubPath, 'utf8');
     const names = (0, file_helper_1.resolveNames)(file_helper_1.fh.filenameFromPath(name), 'Service');
@@ -55,8 +51,8 @@ async function createService(name, options = { force: false, resource: false, pr
             .replaceAll('{Model}', capitalize(options.model))
             .replaceAll('{model}', lower(options.model));
     }
-    await promises_1.default.writeFile(path_1.default.join(rootPath, (0, file_helper_1.getFilePathWithoutName)(name) + "/" + (0, lodash_1.kebabCase)(className) + '.service.ts'), replacedContent, 'utf8');
-    console.log("Service created succssessfully!");
+    await promises_1.default.writeFile(path_1.default.join(outDir, (0, lodash_1.kebabCase)(className) + '.service.ts'), replacedContent, 'utf8');
+    console.log("Service created successfully!");
 }
 async function createRestService(name, model) {
     let stubPath = path_helper_1.pathHelper.stubPath('services/rest-service.stub');

package/package.json

@@ -1,61 +1,62 @@
-{
-  "name": "@avleon/cli",
-  "version": "0.0.45",
-  "description": "CLI for scaffolding and running Avleon applications",
-  "author": "Tareq Hossain",
-  "license": "ISC",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "bin": {
-    "avleon": "./dist/cli.js"
-  },
-  "files": [
-    "dist",
-    "README.md"
-  ],
-  "scripts": {
-    "build": "rimraf dist && tsc",
-    "clean": "rimraf dist",
-    "prepublishOnly": "npm run build",
-    "watch": "tsc-watch --onSuccess \"echo Build complete\""
-  },
-  "keywords": [
-    "cli",
-    "avleon",
-    "backend",
-    "typescript"
-  ],
-  "dependencies": {
-    "@avleon/core": "*",
-    "@swc/core": "^1.13.5",
-    "chokidar": "^4.0.3",
-    "chalk": "^5.4.1",
-    "cli-table3": "^0.6.5",
-    "fs-extra": "^11.2.0",
-    "inquirer": "^12.6.0",
-    "lodash": "^4.17.21",
-    "prettier": "^3.3.3",
-    "rimraf": "^6.0.1"
-  },
-  "devDependencies": {
-    "@swc/cli": "^0.7.8",
-    "@types/fs-extra": "^11.0.4",
-    "@types/lodash": "^4.17.16",
-    "@types/node": "^22.9.3",
-    "concurrently": "^9.2.1",
-    "nodemon": "^3.1.7",
-    "tsc-watch": "^6.2.1",
-    "tsup": "^8.4.0",
-    "typescript": "^5.7.2"
-  },
-  "peerDependencies": {
-    "@avleon/core": ">=0.0.38"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/avleonjs/avleon-cli"
-  },
-  "publishConfig": {
-    "access": "public"
-  }
-}
+{
+  "name": "@avleon/cli",
+  "version": "0.0.47",
+  "description": "CLI for scaffolding and running Avleon applications",
+  "author": "Tareq Hossain",
+  "license": "ISC",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "avleon": "./dist/cli.js"
+  },
+  "files": [
+    "dist",
+    "stubs",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "rimraf dist && tsc",
+    "clean": "rimraf dist",
+    "prepublishOnly": "npm run build",
+    "watch": "tsc-watch --onSuccess \"echo Build complete\""
+  },
+  "keywords": [
+    "cli",
+    "avleon",
+    "backend",
+    "typescript"
+  ],
+  "dependencies": {
+    "@avleon/core": "*",
+    "@swc/core": "^1.13.5",
+    "chokidar": "^4.0.3",
+    "chalk": "^5.4.1",
+    "cli-table3": "^0.6.5",
+    "fs-extra": "^11.2.0",
+    "inquirer": "^12.6.0",
+    "lodash": "^4.17.21",
+    "prettier": "^3.3.3",
+    "rimraf": "^6.0.1"
+  },
+  "devDependencies": {
+    "@swc/cli": "^0.7.8",
+    "@types/fs-extra": "^11.0.4",
+    "@types/lodash": "^4.17.16",
+    "@types/node": "^22.9.3",
+    "concurrently": "^9.2.1",
+    "nodemon": "^3.1.7",
+    "tsc-watch": "^6.2.1",
+    "tsup": "^8.4.0",
+    "typescript": "^5.7.2"
+  },
+  "peerDependencies": {
+    "@avleon/core": ">=0.0.38"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/avleonjs/avleon-cli"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/readme.md

@@ -1,66 +1,116 @@
-
-### ⚠️ WARNING: NOT FOR PRODUCTION USE
-
-> **🚧 This project is in active development.**
->
-> It is **not stable** and **not ready** for live environments.  
-> Use **only for testing, experimentation, or internal evaluation**.
->
-> ####❗ Risks of using this in production:
->
-> - 🔄 Breaking changes may be introduced at any time
-> - 🧪 Features are experimental and may be unstable
-> - 🔐 Security has not been audited
-> - 💥 Potential for data loss or critical errors
->
-> **Please do not deploy this in production environments.**
-
-# Avleon CLI - v0.0.37
-
-### Create Application
-```sh
-npx @avleon/cli new my_api
-```
-### Create Controller 
-```sh
-npx avleon make:controller product
-# or shorthand
-npx avleon m:c product
-# for resource controller with -r flag
-npx avleon m:c product -m product -r
-```
-
-### Create Model/Entity
-```sh
-# basic model
-npx avleon make:model product
-# typeorm model
-npx avleon m:m product --orm
-```
-
-### Create Service
-```sh
-# basic service
-npx avleon make:service product
-# resource service with built-in collection
-npx avleon make:service product -m product -r
-# resource service with typeorm collection
-npx avleon make:service product -m product -r --orm
-```
-
-### Create Middleware
-```sh
-npx avleon make:config product
-```
-
-### Create Config
-```sh
-npx avleon make:config product
-```
-
-### Create authoriztion (Experimental)
-```sh
-npx avleon make:auth jwt
-```
-
-
+### ⚠️ WARNING: NOT FOR PRODUCTION USE
+
+> **🚧 This project is in active development.**
+>
+> It is **not stable** and **not ready** for live environments.  
+> Use **only for testing, experimentation, or internal evaluation**.
+>
+> #### ❗ Risks of using this in production:
+>
+> - 🔄 Breaking changes may be introduced at any time
+> - 🧪 Features are experimental and may be unstable
+> - 🔐 Security has not been audited
+> - 💥 Potential for data loss or critical errors
+>
+> **Please do not deploy this in production environments.**
+
+# Avleon CLI
+
+Scaffold and run [Avleon](https://github.com/avleonjs/avleon-core) applications.
+
+## Create an Application
+
+```sh
+npx @avleon/cli new my_api
+```
+
+You are prompted for a package manager and for optional features (OpenAPI,
+CORS, TypeORM, Knex, Scalar UI). The generated project uses `@avleon/core`'s
+`Avleon.createApplication()` and is ready to run:
+
+```sh
+cd my_api
+npm run start:dev
+```
+
+## Commands
+
+| Command | Alias | Options | Description |
+|---------|-------|---------|-------------|
+| `new` | | `--minimal`, `-m` | Create a new application |
+| `serve` | | | Start the dev server with watch + rebuild |
+| `build` | | | Compile with `tsconfig.build.json` |
+| `make:model` | `m:m` | `-f`, `--orm` | Create a model / TypeORM entity |
+| `make:controller` | `m:c` | `-f`, `-r`, `-m <model>`, `-rt <dir>`, `--orm`, `--base-path` | Create a controller |
+| `make:service` | `m:s` | `-f`, `-r`, `-m <model>`, `-rt <dir>`, `--orm` | Create a service |
+| `make:config` | `m:cnf` | `-f` | Create a config class |
+| `make:middleware` | `m:mlwr` | `-f` | Create a middleware |
+
+`-f` / `--force` overwrites an existing file. `-r` / `--resource` generates a
+full REST skeleton.
+
+### Controller
+
+```sh
+npx avleon make:controller product
+# shorthand
+npx avleon m:c product
+
+# REST controller — also generates the matching service
+npx avleon m:c product -m product -r
+
+# REST controller backed by a TypeORM repository
+npx avleon m:c product -m product -r --orm
+```
+
+With `-m`, the generated controller delegates to `src/services/<model>.service.ts`,
+which is created alongside it.
+
+### Model / Entity
+
+```sh
+# plain class
+npx avleon make:model product
+
+# TypeORM entity
+npx avleon m:m product --orm
+```
+
+### Service
+
+```sh
+# basic service
+npx avleon make:service product
+
+# resource service backed by an in-memory Collection
+npx avleon make:service product -m product -r
+
+# resource service backed by a TypeORM repository
+npx avleon make:service product -m product -r --orm
+```
+
+### Middleware
+
+```sh
+npx avleon make:middleware auth
+```
+
+Generates a class extending `AvleonMiddleware` with an `invoke(req, res)` method.
+
+### Config
+
+```sh
+npx avleon make:config jwt
+```
+
+Generates a class extending `AvleonConfig`, registered via `@AppConfig`.
+
+## Development Server
+
+```sh
+npx avleon serve
+```
+
+Compiles `src/` with SWC into `dist/`, starts the entry point, and restarts on
+change. The entry file is taken from `avleon.entry` in `package.json`, falling
+back to `main`.