orbit

Mô tả

CLI tool cho Orbit framework để scaffolding projects và generate components.

Cài đặt

bun add -g orbit
# hoặc
npx orbit

Commands

1. Tạo Project mới

orbit new my-app
orbit new my-app --template api
orbit new my-app --template graphql
orbit new my-app --template microservice

2. Generate Components

# Controller
orbit generate controller user
orbit g co user

# Service
orbit generate service user
orbit g s user

# Module
orbit generate module user
orbit g mo user

# Guard
orbit generate guard auth
orbit g gu auth

# Pipe
orbit generate pipe validation
orbit g pi validation

# Interceptor
orbit generate interceptor logging
orbit g in logging

# Middleware
orbit generate middleware cors
orbit g mi cors

# Filter
orbit generate filter http-exception
orbit g f http-exception

# Resource (CRUD)
orbit generate resource user
orbit g res user

3. Development Server

orbit dev
orbit dev --port 3000
orbit dev --watch

4. Build

orbit build
orbit build --minify
orbit build --target bun

5. Test

orbit test
orbit test --watch
orbit test --coverage

Auto-import

CLI tự động update module imports khi generate:

// Trước
@Module({
  controllers: [],
  providers: [],
})
class AppModule {}

// Sau generate controller user
@Module({
  controllers: [UserController],  // Auto-imported
  providers: [],
})
class AppModule {}

Project Structure

my-app/
├── src/
│   ├── main.ts
│   ├── app.module.ts
│   ├── app.controller.ts
│   ├── app.service.ts
│   └── users/
│       ├── users.module.ts
│       ├── users.controller.ts
│       ├── users.service.ts
│       └── dto/
│           └── create-user.dto.ts
├── test/
│   └── app.e2e-spec.ts
├── package.json
├── tsconfig.json
└── bunfig.toml

Options

# Generate với spec file
orbit g co user --spec

# Generate không có spec
orbit g co user --no-spec

# Dry run (không tạo file)
orbit g co user --dry-run

# Flat structure (không tạo folder)
orbit g co user --flat