@avleon/cli 0.0.46 → 0.4.0

package/readme.md

@@ -1,66 +1,155 @@
-
-### ⚠️ 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 <name>` | | `-m`, `-f`, `-y`, `--pm <npm\|yarn\|pnpm>`, `--features <list>`, `--skip-install` | Create a new application |
+| `serve` | | `--entry <file>`, `--no-type-check`, `--debounce <ms>` | Dev server: SWC compile, run, reload on change |
+| `build` | | `-p <tsconfig>` | Compile with `tsconfig.build.json` and copy assets |
+| `start` | | `--entry <file>` | Run the compiled app with `NODE_ENV=production` |
+| `doctor` | | | Check Node.js, `@avleon/core`, `reflect-metadata` and decorator settings |
+| `route:list` | `routes` | `--json`, `--static` | List the app's routes |
+| `make:model` | `m:m` | `-f`, `--orm`, `--root <dir>` | Create a model / TypeORM entity |
+| `make:controller` | `m:c` | `-f`, `-r`, `-m <model>`, `--orm`, `--root <dir>`, `--base-path` | Create a controller |
+| `make:service` | `m:s` | `-f`, `-r`, `-m <model>`, `--orm`, `--root <dir>` | Create a service |
+| `make:config` | `m:cnf` | `-f`, `--root <dir>` | Create an `@AppConfig` class |
+| `make:middleware` | `m:mlwr` | `-f`, `--root <dir>` | Create a middleware |
+| `make:dto` | `m:dto` | `-f`, `--root <dir>` | Create a class-validator DTO |
+
+`-f` / `--force` overwrites an existing file. `-r` / `--resource` generates a
+full REST skeleton. `--root <dir>` (also `-rt`) writes under `src/<dir>`
+instead of the default folder. Names may be nested, e.g. `admin/User`.
+Run `avleon <command> --help` for details.
+
+Generated controllers must be registered in your app with
+`app.useControllers([...])`.
+
+### 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 to sources, assets or `.env*` files. The entry file is taken from
+`--entry`, `avleon.entry` in `package.json`, `main`, then `dist/serve.js`,
+`server.js`, `main.js` or `index.js`.
+
+Type errors are reported by a parallel `tsc --noEmit --watch` (disable with
+`--no-type-check`) and never block a reload. Syntax errors stop the app until
+they are fixed, so stale code never keeps serving.
+
+## Build and Run
+
+```sh
+npx avleon build   # tsc with tsconfig.build.json, then copy non-TS assets
+npx avleon start   # node dist/serve.js with NODE_ENV=production
+```
+
+## Routes
+
+```sh
+npx avleon route:list          # compile and read Avleon's route metadata
+npx avleon route:list --static # scan decorators in the source, no dependencies
+npx avleon routes --json
+```
+
+## Doctor
+
+```sh
+npx avleon doctor
+```
+
+Checks the Node.js version, that `@avleon/core` matches the CLI's version,
+that `reflect-metadata` is installed, and that `experimentalDecorators` and
+`emitDecoratorMetadata` are enabled. Exits non-zero if a check fails.

package/stubs/config/config.stub

@@ -0,0 +1,9 @@
+import { AppConfig, AvleonConfig, Environment } from '@avleon/core';
+
+@AppConfig
+export class {ClassName} extends AvleonConfig {
+  config(env: Environment) {
+    // Return this config's values, e.g. { secret: env.get('JWT_SECRET') }.
+    return {};
+  }
+}

package/stubs/controllers/basic-controller.stub

@@ -1,12 +1,9 @@
-import { ApiController, Get, HttpResponse } from '@avleon/core';
-
-
-@ApiController('/{controller}s')
-export class {Controller}Controller{
-
-  @Get()
-  index(){
-    return "{controller} ok";
-  }
-
-}
+import { ApiController, Get } from '@avleon/core';
+
+@ApiController('/{route}')
+export class {ClassName} {
+  @Get()
+  index() {
+    return { message: '{ClassName} works' };
+  }
+}

package/stubs/controllers/resource-controller.stub

@@ -0,0 +1,45 @@
+import { ApiController, Get, Post, Put, Delete, Param, Query, Body, HttpExceptions } from '@avleon/core';
+import { {ServiceClass} } from '{serviceImport}';
+
+@ApiController('/{route}')
+export class {ClassName} {
+  constructor(private readonly {serviceVar}: {ServiceClass}) {}
+
+  @Get()
+  async index(@Query() query?: any) {
+    if (query && query.page) {
+      return this.{serviceVar}.paginate(Number(query.page));
+    }
+    return this.{serviceVar}.findAll();
+  }
+
+  @Get('/:id')
+  async findOne(@Param('id') id: number) {
+    const {modelVar} = await this.{serviceVar}.findByPk(Number(id));
+    if (!{modelVar}) throw HttpExceptions.notFound('{Model} not found.');
+    return {modelVar};
+  }
+
+  @Post()
+  async create(@Body() body: any) {
+    return this.{serviceVar}.create(body);
+  }
+
+  @Put('/:id')
+  async update(@Param('id') id: number, @Body() updateBody: any) {
+    const {modelVar} = await this.{serviceVar}.findByPk(Number(id));
+    if (!{modelVar}) throw HttpExceptions.notFound('{Model} not found.');
+    const isUpdated = await this.{serviceVar}.update(Number(id), updateBody);
+    if (!isUpdated) throw HttpExceptions.internalError("Can't update {Model}");
+    return { message: 'Updated successfully' };
+  }
+
+  @Delete('/:id')
+  async delete(@Param('id') id: number) {
+    const {modelVar} = await this.{serviceVar}.findByPk(Number(id));
+    if (!{modelVar}) throw HttpExceptions.notFound('{Model} not found.');
+    const isDeleted = await this.{serviceVar}.delete(Number(id));
+    if (!isDeleted) throw HttpExceptions.internalError("Can't delete {Model}");
+    return { message: 'Deleted successfully' };
+  }
+}

package/stubs/controllers/rest-controller.stub

@@ -1,34 +1,29 @@
-import { ApiController, Get, Post, Delete, Param, Query, Body, HttpExceptions } from '@avleon/core';
-
-@ApiController('/{controller}s')
-export class {Controller}Controller{
-
-  
-
-  @Get()
-  async index(@Query() query?:any){
-    throw new Error("Method not implemented.");
-  }
-
-  @Get('/:id')
-  async findOne(@Param('id') id:number){
-    throw new Error("Method not implemented.");
-  }
-
-  @Post()
-  async create(@Body() body:any){
-    throw new Error("Method not implemented.");
-  }
-
-  @Post('/:id')
-  async update(@Param('id') id:number, updateBody:any){
-
-    throw new Error("Method not implemented.");
-  }
-
-  @Delete('/:id')
-  async delete(@Param('id') id:number){
-    throw new Error("Method not implemented.");
-  }
-
-}
+import { ApiController, Get, Post, Put, Delete, Param, Query, Body } from '@avleon/core';
+
+@ApiController('/{route}')
+export class {ClassName} {
+  @Get()
+  async index(@Query() query?: any) {
+    throw new Error('Method not implemented.');
+  }
+
+  @Get('/:id')
+  async findOne(@Param('id') id: number) {
+    throw new Error('Method not implemented.');
+  }
+
+  @Post()
+  async create(@Body() body: any) {
+    throw new Error('Method not implemented.');
+  }
+
+  @Put('/:id')
+  async update(@Param('id') id: number, @Body() updateBody: any) {
+    throw new Error('Method not implemented.');
+  }
+
+  @Delete('/:id')
+  async delete(@Param('id') id: number) {
+    throw new Error('Method not implemented.');
+  }
+}

package/stubs/dtos/dto.stub

@@ -0,0 +1,11 @@
+import { IsNotEmpty, IsOptional, IsString } from 'class-validator';
+
+export class {ClassName} {
+  @IsString()
+  @IsNotEmpty()
+  name!: string;
+
+  @IsString()
+  @IsOptional()
+  description?: string;
+}

package/stubs/middlewares/middleware.stub

@@ -0,0 +1,9 @@
+import { AppMiddleware, AvleonMiddleware, IRequest, IResponse } from '@avleon/core';
+
+@AppMiddleware
+export class {ClassName} extends AvleonMiddleware {
+  async invoke(req: IRequest, res?: IResponse) {
+    // your logic goes here
+    return req;
+  }
+}

package/stubs/models/basic-model.stub

@@ -1,6 +1,4 @@
-
-
-export class {Model}{
-  id: number;
-  name: string;
-}
+export class {Model} {
+  id!: number;
+  name!: string;
+}

package/stubs/models/entity-model.stub

@@ -1,23 +1,16 @@
-
-import {Entity, PrimaryGeneratedColumn, Column, CreateDateColumn, UpdateDateColumn}  from 'typeorm';
-
-@Entity({name:"{Model}"})
-export class {Model}{
-  
-  @PrimaryGeneratedColumn()
-  id:number;
-
-
-  // your fields
-
-  // @Column()
-  // name:string
-
-
-  @CreateDateColumn()
-  createdAt: Date;
-
-
-  @UpdateDateColumn()
-  updatedAt: Date;
-}
+import { Entity, PrimaryGeneratedColumn, Column, CreateDateColumn, UpdateDateColumn } from 'typeorm';
+
+@Entity({ name: '{table}' })
+export class {Model} {
+  @PrimaryGeneratedColumn()
+  id!: number;
+
+  @Column()
+  name!: string;
+
+  @CreateDateColumn()
+  createdAt!: Date;
+
+  @UpdateDateColumn()
+  updatedAt!: Date;
+}

package/stubs/project/app-minimal.stub

@@ -0,0 +1,7 @@
+import { Avleon } from '@avleon/core';
+
+const app = Avleon.createApplication();
+
+app.mapGet('/', () => ({ message: 'Hello World!' }));
+
+export default app;

package/stubs/project/app.stub

@@ -0,0 +1,8 @@
+import { Avleon } from '@avleon/core';
+import { HomeController } from './controllers/home.controller';
+{Imports}
+const app = Avleon.createApplication();
+{Setup}
+app.useControllers([HomeController]);
+
+export default app;

package/stubs/project/env.stub

@@ -0,0 +1,3 @@
+# Core treats an unset NODE_ENV as production.
+NODE_ENV=development
+PORT=4000

package/stubs/project/gitignore.stub

@@ -0,0 +1,5 @@
+node_modules/
+dist/
+.env
+.env.local
+coverage/

package/stubs/project/home.controller.spec.stub

@@ -0,0 +1,19 @@
+import { beforeAll, describe, expect, it } from 'vitest';
+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 return hello message', () => {
+    expect(controller.sayHello()).toEqual({ message: 'Hello World!' });
+  });
+});

package/stubs/project/home.controller.stub

@@ -0,0 +1,12 @@
+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();
+  }
+}

package/stubs/project/home.service.stub

@@ -0,0 +1,8 @@
+import { AppService } from '@avleon/core';
+
+@AppService
+export class HomeService {
+  sayHello() {
+    return { message: 'Hello World!' };
+  }
+}

package/stubs/project/openapi.config.stub

@@ -0,0 +1,15 @@
+import { AppConfig, AvleonConfig, Environment, OpenApiUiOptions } from '@avleon/core';
+
+@AppConfig
+export class OpenApiConfig extends AvleonConfig<OpenApiUiOptions> {
+  config(env: Environment): OpenApiUiOptions {
+    return {
+      info: {
+        title: '{AppTitle} API',
+        version: '0.0.1',
+        description: 'API documentation for {AppTitle}',
+      },{Provider}
+      routePrefix: '/docs',
+    };
+  }
+}

package/stubs/project/readme.stub

@@ -0,0 +1,26 @@
+# {AppTitle}
+
+Built with [Avleon](https://github.com/avleonjs/avleon-core).
+
+## Getting Started
+
+```bash
+{InstallCmd}
+{DevCmd}
+```
+
+## Scripts
+
+| Script | Description |
+|--------|-------------|
+| `start:dev` | Start the development server with reload (`avleon serve`) |
+| `build`     | Compile TypeScript to `dist/` (`avleon build`) |
+| `start`     | Run the compiled app in production (`avleon start`) |
+{TestRow}
+## Project Structure
+
+```
+src/
+{Tree}├── app.ts         # App setup
+└── serve.ts       # Entry point
+```

package/stubs/project/serve.stub

@@ -0,0 +1,10 @@
+import { Environment, inject } from '@avleon/core';
+import app from './app';
+
+async function serve() {
+  const env = inject(Environment);
+  const port = Number(env.get('PORT')) || 4000;
+  await app.run(port);
+}
+
+serve();

package/stubs/project/tsconfig.build.stub

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": ["node_modules", "coverage", "test", "dist", "**/*.spec.ts", "**/*.test.ts"]
+}

package/stubs/project/tsconfig.stub

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "CommonJS",
+    "moduleResolution": "node",
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "outDir": "./dist",
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "forceConsistentCasingInFileNames": true,
+    "skipLibCheck": true,
+    "sourceMap": true,
+    "strict": false
+  },
+  "include": ["avleon-env.d.ts", "src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}

package/stubs/project/vitest-e2e.config.stub

@@ -0,0 +1,10 @@
+import swc from 'unplugin-swc';
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  plugins: [swc.vite()],
+  test: {
+    environment: 'node',
+    include: ['test/**/*.e2e-spec.ts'],
+  },
+});

package/stubs/project/vitest.config.stub

@@ -0,0 +1,17 @@
+import swc from 'unplugin-swc';
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  // SWC emits the decorator metadata that Avleon's dependency injection
+  // and validation rely on; Vitest's default transform (esbuild) does not.
+  plugins: [swc.vite()],
+  test: {
+    environment: 'node',
+    include: ['src/**/*.spec.ts'],
+    coverage: {
+      include: ['src/**/*.ts'],
+      exclude: ['src/**/*.spec.ts'],
+      reportsDirectory: 'coverage',
+    },
+  },
+});

package/stubs/services/basic-service.stub

@@ -1,9 +1,8 @@
-import { AppService } from '@avleon/core';
-
-@AppService
-export class {Service} {
-  
-  sayHello(){
-    return "Hello World!";
-  }
-}
+import { AppService } from '@avleon/core';
+
+@AppService
+export class {ClassName} {
+  sayHello() {
+    return 'Hello World!';
+  }
+}