@fastcar/cli 0.1.1 → 0.1.3

package/skills/fastcar-framework/SKILL.md

@@ -1,11 +1,11 @@
 ---
 name: fastcar-framework
-description: FastCar 是一个基于 TypeScript 的 Node.js 企业级应用开发框架，采用 IoC（控制反转）设计思想，提供模块化、可扩展的架构支持。Use when working with FastCar framework for: (1) Creating IoC-based Node.js applications, (2) Using dependency injection with decorators (@Component, @Service, @Autowired), (3) Building web APIs with @fastcar/koa, (4) Database operations with MySQL/MongoDB/Redis, (5) Setting up scheduled tasks or worker pools, (6) Managing application lifecycle and configuration, (7) Selecting and configuring project templates (web, rpc, cos, static, microservices), (8) Writing application.yml for different templates.
+description: FastCar 是一个基于 TypeScript 的 Node.js 企业级应用开发框架，采用 IoC（控制反转）设计思想。Use when working with FastCar framework for: (1) Creating IoC-based Node.js applications, (2) Using dependency injection with decorators (@Component, @Service, @Autowired), (3) Building web APIs with @fastcar/koa, (4) Database operations with MySQL/MongoDB/Redis, (5) Setting up scheduled tasks or worker pools, (6) Managing application lifecycle and configuration.
 ---
 
 # FastCar Framework
 
-FastCar 是基于 TypeScript 的 Node.js 企业级应用开发框架，灵感来源于 Spring Boot，采用 IoC（控制反转）设计思想。
+FastCar 是基于 TypeScript 的 Node.js 企业级应用开发框架，采用 IoC（控制反转）设计思想。
 
 ## 核心概念
 
@@ -15,32 +15,41 @@ FastCar 是基于 TypeScript 的 Node.js 企业级应用开发框架，灵感来
 |--------|------|------|
 | `@Application` | 入口应用类 | `@Application class App {}` |
 | `@Component` | 通用组件 | `@Component class UtilService {}` |
-| `@Service` | 服务层 | `@Service class UserService {}` |
-| `@Controller` | 控制器层 | `@Controller class UserController {}` |
-| `@Repository` | 数据访问层 | `@Repository class UserRepository {}` |
-| `@Autowired` | 依赖注入 | `@Autowired private userService!: UserService;` |
+| `@Service` | 服务层 | `@Service class BizService {}` |
+| `@Controller` | 控制器层 | `@Controller class ApiController {}` |
+| `@Repository` | 数据访问层 | `@Repository class DataRepository {}` |
+| `@Autowired` | 依赖注入 | `@Autowired private service!: BizService;` |
 
 ### 基础应用结构
 
 ```typescript
 import { FastCarApplication } from "@fastcar/core";
-import { Application, Autowired, Component, Service } from "@fastcar/core/annotation";
+import { Application, Autowired, Component, Service, Controller } from "@fastcar/core/annotation";
 
 @Service
-class UserService {
-  getUsers() { return [{ id: 1, name: "Alice" }]; }
+class BizService {
+  getData() {
+    return [{ id: 1, name: "示例" }];
+  }
 }
 
 @Controller
-class UserController {
-  @Autowired private userService!: UserService;
-  getUsers() { return this.userService.getUsers(); }
+class ApiController {
+  @Autowired
+  private service!: BizService;
+  
+  getData() {
+    return this.service.getData();
+  }
 }
 
 @Application
 class App {
   app!: FastCarApplication;
-  async start() { console.log("应用启动成功!"); }
+  
+  async start() {
+    console.log("应用启动成功!");
+  }
 }
 
 const app = new App();
@@ -51,44 +60,167 @@ app.start();
 
 ### Web 开发 (@fastcar/koa)
 
+**路由装饰器使用方式：**
+
 ```typescript
-import { GET, POST, REQUEST, Body, Param } from "@fastcar/koa/annotation";
+import { GET, POST, REQUEST } from "@fastcar/koa/annotation";
 
-@Controller @REQUEST("/api/users")
-class UserController {
-  @GET async list() { return { data: [] }; }
-  @GET("/:id") async getById(@Param("id") id: string) { return { id }; }
-  @POST async create(@Body user: UserDTO) { return { created: true }; }
+@Controller
+@REQUEST("/api/items")
+class ItemController {
+  // GET 请求 - 无路径参数时必须有括号
+  @GET()
+  async list() {
+    return { data: [] };
+  }
+  
+  // GET 请求 - 有路径参数
+  @GET("/:id")
+  async getById(id: string) {
+    return { id };
+  }
+  
+  // POST 请求
+  @POST()
+  async create(body: ItemDTO) {
+    return { created: true };
+  }
 }
 ```
 
+**⚠️ 重要：FastCar 没有 `@Body`, `@Param`, `@Query` 装饰器**
+
+- 请求参数直接作为方法参数传入
+- GET 请求参数通过方法参数直接获取
+- POST 请求体通过 `body` 参数获取
+- 路径参数通过方法参数直接获取
+
 ### 数据库 (@fastcar/mysql)
 
-```typescript
-import { Repository, Table, Field, PrimaryKey, SqlSession } from "@fastcar/mysql/annotation";
+**实体定义：**
 
-@Table("users")
-class User {
-  @PrimaryKey @Field("id") id!: number;
-  @Field("name") name!: string;
+```typescript
+import { Table, Field, DBType, PrimaryKey, NotNull, Size } from "@fastcar/core/annotation";
+
+@Table("entities")
+class Entity {
+  @Field("id")
+  @DBType("int")
+  @PrimaryKey
+  id!: number;
+  
+  @Field("name")
+  @DBType("varchar")
+  @NotNull
+  @Size({ maxSize: 50 })
+  name!: string;
 }
+```
+
+**Mapper 定义：**
+
+```typescript
+import { Entity, Repository } from "@fastcar/core/annotation";
+import { MysqlMapper } from "@fastcar/mysql";
 
+@Entity(Entity)
 @Repository
-class UserRepository {
-  @SqlSession private session!: SqlSession;
-  async findById(id: number) { return this.session.findById(User, id); }
+class EntityMapper extends MysqlMapper<Entity> {}
+export default EntityMapper;
+```
+
+**Service 中使用：**
+
+```typescript
+import { Service, Autowired } from "@fastcar/core/annotation";
+import { OrderEnum } from "@fastcar/core/db";
+import EntityMapper from "./EntityMapper";
+
+@Service
+class EntityService {
+  @Autowired
+  private mapper!: EntityMapper;
+
+  async getList() {
+    return this.mapper.select({
+      where: { status: 1 },
+      orders: { createTime: OrderEnum.desc },
+      limit: 10
+    });
+  }
+
+  async getOne(id: number) {
+    return this.mapper.selectOne({ where: { id } });
+  }
+
+  async create(data: Entity) {
+    return this.mapper.saveOne(data);
+  }
+
+  async update(id: number, data: Partial<Entity>) {
+    return this.mapper.update({ where: { id }, row: data });
+  }
+
+  async delete(id: number) {
+    return this.mapper.delete({ where: { id } });
+  }
+}
+```
+
+### 表单验证 (@fastcar/core)
+
+```typescript
+import { ValidForm, NotNull, Size, Rule } from "@fastcar/core/annotation";
+
+class ItemDTO {
+  @NotNull
+  name!: string;
+  
+  @Size({ minSize: 1, maxSize: 150 })
+  value!: number;
+}
+
+@Controller
+@REQUEST("/api/items")
+class ItemController {
+  @GET()
+  async list(page: number = 1, pageSize: number = 10) {
+    return { page, pageSize, data: [] };
+  }
+
+  @ValidForm
+  @POST()
+  async create(@Rule() body: ItemDTO) {
+    const { name, value } = body;
+    return this.service.create({ name, value });
+  }
 }
 ```
 
+**表单验证规则：**
+
+| 装饰器 | 用途 | 示例 |
+|--------|------|------|
+| `@ValidForm` | 开启方法参数校验 | 放在方法上 |
+| `@Rule()` | 标记校验对象 | 放在 DTO 参数前 |
+| `@NotNull` | 参数不能为空 | 放在 DTO 字段上 |
+| `@Size({min, max})` | 大小限制 | 放在 DTO 字段上 |
+
 ### Redis (@fastcar/redis)
 
 ```typescript
+import { Service, Autowired } from "@fastcar/core/annotation";
 import { RedisClient } from "@fastcar/redis/annotation";
 
 @Service
 class CacheService {
-  @RedisClient private redis!: RedisClient;
-  async get(key: string) { return this.redis.get(key); }
+  @RedisClient
+  private redis!: RedisClient;
+  
+  async get(key: string) {
+    return this.redis.get(key);
+  }
+  
   async set(key: string, value: string, ttl?: number) {
     await this.redis.set(key, value, ttl);
   }
@@ -97,13 +229,24 @@ class CacheService {
 
 ### 定时任务 (@fastcar/timer)
 
+> **推荐使用 `@fastcar/timer/scheduling2` 模块**
+
 ```typescript
-import { Scheduled, Cron } from "@fastcar/timer/annotation";
+import { ScheduledInterval, ScheduledCron } from "@fastcar/timer/scheduling2";
 
 @Component
 class TaskService {
-  @Scheduled(60000) async intervalTask() { console.log("每分钟执行"); }
-  @Cron("0 0 * * * *") async hourlyTask() { console.log("每小时执行"); }
+  // 间隔执行（毫秒）
+  @ScheduledInterval({ fixedRate: 60000 })
+  async intervalTask() {
+    console.log("每分钟执行");
+  }
+  
+  // Cron 表达式
+  @ScheduledCron("0 0 * * * *")
+  async hourlyTask() {
+    console.log("每小时执行");
+  }
 }
 ```
 
@@ -114,7 +257,9 @@ import { WorkerPool, WorkerTask } from "@fastcar/workerpool/annotation";
 
 @Component
 class ComputeService {
-  @WorkerPool({ minWorkers: 2, maxWorkers: 4 }) private pool!: WorkerPool;
+  @WorkerPool({ minWorkers: 2, maxWorkers: 4 })
+  private pool!: WorkerPool;
+  
   @WorkerTask
   heavyComputation(data: number[]): number {
     return data.reduce((a, b) => a + b, 0);
@@ -124,42 +269,31 @@ class ComputeService {
 
 ## 项目模板速查
 
-### 模板选择指南
+FastCar CLI 提供 5 种项目模板：
 
 | 模板 | 适用场景 | 核心依赖 | 关键注解 |
 |------|---------|---------|---------|
 | web | RESTful API 服务 | @fastcar/koa, @fastcar/server | @EnableKoa |
 | static | 静态资源服务器 | @fastcar/koa, @fastcar/server | @EnableKoa + KoaStatic |
 | rpc | RPC 微服务通信 | @fastcar/rpc, @fastcar/server | @EnableRPC |
-| cos | 对象存储/文件上传/直播转码 | @fastcar/koa, @fastcar/cossdk, @fastcar/server | @EnableKoa |
-| microservices | 分布式多服务架构 | @fastcar/koa, @fastcar/rpc, @fastcar/server, @fastcar/timer | @EnableKoa / @EnableRPC（按服务模块） |
+| cos | 对象存储/文件上传 | @fastcar/koa, @fastcar/cossdk, @fastcar/server | @EnableKoa |
+| microservices | 分布式多服务架构 | @fastcar/koa, @fastcar/rpc, @fastcar/server, @fastcar/timer | @EnableKoa / @EnableRPC |
 
 ### 各模板入口示例
 
 **Web 模板**
 ```typescript
-import { FastCarApplication } from "@fastcar/core";
 import { Application } from "@fastcar/core/annotation";
 import { EnableKoa, KoaMiddleware } from "@fastcar/koa/annotation";
 import { ExceptionGlobalHandler, KoaBodyParser } from "@fastcar/koa";
 
-@Application @EnableKoa
+@Application
+@EnableKoa
 @KoaMiddleware(ExceptionGlobalHandler)
 @KoaMiddleware(KoaBodyParser)
-class APP { app!: FastCarApplication; }
-export default new APP();
-```
-
-**Static 模板**
-```typescript
-import { Application } from "@fastcar/core/annotation";
-import { EnableKoa, KoaMiddleware } from "@fastcar/koa/annotation";
-import { ExceptionGlobalHandler, KoaStatic } from "@fastcar/koa";
-
-@Application @EnableKoa
-@KoaMiddleware(ExceptionGlobalHandler)
-@KoaMiddleware(KoaStatic)
-class APP { app!: any; }
+class APP {
+  app!: FastCarApplication;
+}
 export default new APP();
 ```
 
@@ -168,68 +302,27 @@ export default new APP();
 import { Application } from "@fastcar/core/annotation";
 import { EnableRPC } from "@fastcar/rpc/annotation";
 
-@Application @EnableRPC
-class APP {}
-export default new APP();
-```
-
-**COS 模板**
-```typescript
-import { Application } from "@fastcar/core/annotation";
-import { EnableKoa, KoaMiddleware } from "@fastcar/koa/annotation";
-import { ExceptionGlobalHandler, KoaBody, KoaBodyParser, KoaCors } from "@fastcar/koa";
-
-@Application @EnableKoa
-@KoaMiddleware(ExceptionGlobalHandler, KoaBody, KoaBodyParser, KoaCors)
+@Application
+@EnableRPC
 class APP {}
 export default new APP();
 ```
 
 **Microservices 模板**
-微服务模板采用多服务架构，包含 `app-node.ts`（子进程启动多服务）和 `app-pm2.ts`（PM2 启动入口）。服务模块分为：
-- **center**：服务中心，提供服务注册与发现
-- **connector**：连接器服务，处理客户端连接
-- **chat**：聊天服务，处理实时消息
-- **web**：Web 服务，提供 HTTP 接口
-- **base**：基础服务，提供公共功能
-
-各服务模块内部根据职责使用 `@EnableKoa` 或 `@EnableRPC`。
+微服务模板包含多服务架构：center（服务中心）、connector（连接器）、message（消息服务）、web（Web服务）、base（基础服务）。
 
 ### 项目结构示例
 
-**Web / Static / RPC / COS 模板**
 ```
 template/
 ├── src/
 │   ├── controller/       # 控制器（web/cos）
-│   ├── middleware/       # 中间件（web/cos）
+│   ├── dto/              # DTO 类（表单验证）
+│   ├── service/          # 服务层
 │   ├── model/            # 数据模型
 │   └── app.ts            # 应用入口
 ├── resource/
 │   └── application.yml   # 配置文件
-├── target/               # 编译输出
-├── package.json
-├── tsconfig.json
-└── ecosystem.config.yml
-```
-
-**Microservices 模板**
-```
-template/
-├── src/
-│   ├── annotation/       # 注解定义
-│   ├── common/           # 公共代码
-│   ├── middleware/       # 中间件
-│   ├── servers/          # 服务目录（base/center/chat/connector/web）
-│   ├── types/            # 类型定义
-│   ├── utils/            # 工具函数
-│   ├── app-node.ts       # 单节点入口
-│   └── app-pm2.ts        # PM2 入口
-├── resource/
-│   ├── application.yml
-│   ├── application-dev.yml
-│   └── ecosystem.config.yml
-├── test/
 ├── package.json
 └── tsconfig.json
 ```
@@ -252,7 +345,7 @@ npm i @fastcar/core @fastcar/koa @fastcar/rpc @fastcar/server @fastcar/timer
 
 ## 配置管理
 
-配置文件放在 `resource/application.yml`。FastCar 支持按 `env` 加载多文件，例如 `application-dev.yml` 会与主配置合并。
+配置文件放在 `resource/application.yml`。支持按 `env` 加载多文件，例如 `application-dev.yml` 会与主配置合并。
 
 ### 基础配置示例
 
@@ -281,14 +374,15 @@ import { Configure, Value } from "@fastcar/core/annotation";
 
 @Configure
 class AppConfig {
-  @Value("server.port") port!: number;
-  @Value("mysql.host") dbHost!: string;
+  @Value("server.port")
+  port!: number;
+
+  @Value("mysql.host")
+  dbHost!: string;
 }
 ```
 
-### 各模板 application.yml 配置
-
-#### Web / Static / COS 通用配置
+### Web 模板 application.yml
 
 ```yaml
 application:
@@ -298,18 +392,13 @@ settings:
   koa:
     server:
       - { port: 8080, host: "0.0.0.0" }
-      # HTTPS: { port: 443, host: "0.0.0.0", protocol: https, ssl: { key: "./ssl/server.key", cert: "./ssl/server.pem" } }
-    koaStatic: { "public": "public" }  # 静态资源映射
+    koaStatic:
+      { "public": "public" }
     koaBodyParser:
       enableTypes: ["json", "form", "text"]
-      extendTypes: { text: ["text/xml", "application/xml"] }
 ```
 
-- `settings.koa.server`：服务器监听配置数组，支持 `http`/`https`/`http2`
-- `settings.koa.koaStatic`：静态资源访问映射，格式 `{ "别名": "路径" }`
-- `settings.koa.koaBodyParser`：请求体解析配置
-
-#### RPC 模板配置
+### RPC 模板配置
 
 ```yaml
 application:
@@ -319,54 +408,38 @@ settings:
   rpc:
     list:
       - id: "server-1"
-        type: "ws"              # 协议：ws / http / grpc / mqtt
+        type: "ws"
         server: { port: 1235 }
-        serviceType: "base"     # 服务类型分类
-        secure: { username: "user", password: "123456" }
+        serviceType: "base"
+        secure:
+          username: "user"
+          password: "password"
 ```
 
-- `settings.rpc.list`：RPC 服务端点数组
-- `type`：通信协议；`serviceType`：服务分组；`secure`：安全认证
-
-#### Microservices 模板配置
-
-主配置声明环境，详细集群配置放在 `application-dev.yml`：
+### Microservices 模板配置
 
 ```yaml
 settings:
-  hotterSysConfig: true  # 监听配置变更
   microservices:
-    center:              # 服务中心
-      token: "xxx"
+    center:
+      token: "your-token-here"
       servers:
         - host: "localhost"
-          clusters: 1    # 实例数
+          clusters: 1
           list:
             - type: "ws"
               server: { port: 60000 }
-              timeout: 0
-              connectionLimit: 1
-              retry: { retryCount: 3, retryInterval: 3000 }
-
-    connector:           # 连接器服务
-      token: "xxx"
+    connector:
+      token: "your-token-here"
       servers:
         - host: "localhost"
           clusters: 1
           list:
-            - front: true   # 面向客户端的前置节点
+            - front: true
               type: "ws"
               server: { port: 60100 }
-
-    chat: { ... }         # 聊天服务
-    web: { ... }          # Web 服务（支持 http/ws 混合）
 ```
 
-- `settings.microservices.<服务名>`：各微服务模块配置
-- `token`：服务间通信鉴权令牌；`clusters`：集群实例数（自动递增端口号）
-- `front: true`：标记为面向客户端的前置节点
-- `retry`：消息重试策略（retryCount/retryInterval/timeout/maxMsgNum/increase）
-
 ## 生命周期钩子
 
 ```typescript
@@ -374,27 +447,19 @@ import { ApplicationStart, ApplicationStop, ApplicationInit } from "@fastcar/cor
 
 @Component
 class LifecycleService {
-  @ApplicationStart async onStart() { console.log("应用启动"); }
-  @ApplicationStop async onStop() { console.log("应用停止"); }
-  @ApplicationInit async init() { console.log("初始化完成"); }
-}
-```
-
-## 表单验证
-
-```typescript
-import { ValidForm, NotNull, Size, Rule } from "@fastcar/core/annotation";
-
-class UserDTO {
-  @NotNull name!: string;
-  @Size({ minSize: 1, maxSize: 150 }) age!: number;
-}
-
-@Controller
-class UserController {
-  @ValidForm
-  createUser(@Rule() @NotNull user: UserDTO) {
-    return this.userService.create(user);
+  @ApplicationStart
+  async onStart() {
+    console.log("应用启动");
+  }
+  
+  @ApplicationStop
+  async onStop() {
+    console.log("应用停止");
+  }
+  
+  @ApplicationInit
+  async init() {
+    console.log("初始化完成");
   }
 }
 ```
@@ -446,39 +511,66 @@ TypeUtil.isClass(MyClass);       // true
 ```bash
 # Web 项目
 mkdir my-web-app && cd my-web-app
-fastcar-cli init web && npm install && npm run debug
-
-# Static 项目
-mkdir my-static-app && cd my-static-app
-fastcar-cli init static && npm install && npm run debug
+fastcar-cli init web
+npm install
+npm run debug
 
 # RPC 项目
 mkdir my-rpc-app && cd my-rpc-app
-fastcar-cli init rpc && npm install && npm run debug
-
-# COS 项目
-mkdir my-cos-app && cd my-cos-app
-fastcar-cli init cos && npm install && npm run debug
+fastcar-cli init rpc
+npm install
+npm run debug
 
 # Microservices 项目
 mkdir my-ms-app && cd my-ms-app
-fastcar-cli init microservices && npm install
-npm run start-node   # 单节点模式
-# 或 npm run start-pm2    # PM2 模式
+fastcar-cli init microservices
+npm install
+npm run start-node
 ```
 
-### 手动创建项目
+## 常见错误与注意事项
 
-```bash
-mkdir my-fastcar-app && cd my-fastcar-app
-npm init -y
-npm i @fastcar/core @fastcar/koa @fastcar/server
-npm i -D typescript ts-node @types/node
-npx tsc --init
-# 启用装饰器（tsconfig.json）: experimentalDecorators, emitDecoratorMetadata
+### 1. 路由装饰器必须有括号
+
+❌ **错误：**
+```typescript
+@GET
+async list() { }
 ```
 
-## 参考资源
+✅ **正确：**
+```typescript
+@GET()
+async list() { }
+```
+
+### 2. 不要使用不存在的装饰器
+
+❌ **错误：**
+```typescript
+import { Body, Param, Query } from "@fastcar/koa/annotation";
 
-- 详细 API 文档：[references/api-reference.md](references/api-reference.md)
-- 项目模板：[assets/project-template/](assets/project-template/)
+@GET("/:id")
+async getById(@Param("id") id: string) { }
+```
+
+✅ **正确：**
+```typescript
+@GET("/:id")
+async getById(id: string) { }
+```
+
+### 3. 表单验证使用 @ValidForm + @Rule
+
+❌ **错误：**
+```typescript
+@POST()
+async create(@Body body: ItemDTO) { }
+```
+
+✅ **正确：**
+```typescript
+@ValidForm
+@POST()
+async create(@Rule() body: ItemDTO) { }
+```