create-hest-app 0.1.0

package/templates/base_scalar/src/modules/users/dto/user.dto.ts

@@ -0,0 +1,64 @@
+import {
+  IsEmail,
+  IsNumber,
+  IsOptional,
+  IsString,
+  Length,
+  Max,
+  Min,
+} from '@hestjs/validation';
+
+/**
+ * 创建用户 DTO
+ */
+export class CreateUserDto {
+  @IsString({
+    minLength: 2,
+    maxLength: 50,
+    message: '用户名长度必须在2-50字符之间',
+  })
+  name!: string;
+
+  @IsEmail({ message: '请输入有效的邮箱地址' })
+  email!: string;
+
+  @IsNumber({ message: '年龄必须是数字' })
+  @Min(0, { message: '年龄不能小于0' })
+  @Max(120, { message: '年龄不能大于120' })
+  age!: number;
+
+  @IsString({ message: '密码必须是字符串' })
+  @Length(8, 100, { message: '密码长度必须在8-100字符之间' })
+  password!: string;
+
+  @IsOptional()
+  @IsString({ message: '个人简介必须是字符串' })
+  bio?: string;
+}
+
+/**
+ * 更新用户 DTO
+ */
+export class UpdateUserDto {
+  @IsOptional()
+  @IsString({
+    minLength: 2,
+    maxLength: 50,
+    message: '用户名长度必须在2-50字符之间',
+  })
+  name?: string;
+
+  @IsOptional()
+  @IsEmail({ message: '请输入有效的邮箱地址' })
+  email?: string;
+
+  @IsOptional()
+  @IsNumber({ message: '年龄必须是数字' })
+  @Min(0, { message: '年龄不能小于0' })
+  @Max(120, { message: '年龄不能大于120' })
+  age?: number;
+
+  @IsOptional()
+  @IsString({ message: '个人简介必须是字符串' })
+  bio?: string;
+}

package/templates/base_scalar/src/modules/users/entities/user.entity.ts

@@ -0,0 +1,9 @@
+// 定义用户类型
+export interface User {
+  id: number;
+  name: string;
+  email: string;
+  age: number;
+  password?: string;
+  bio?: string;
+}

package/templates/base_scalar/src/modules/users/users.controller.ts

@@ -0,0 +1,68 @@
+import type { HestContext } from '@hestjs/core';
+import { Context, Controller, Get, Post } from '@hestjs/core';
+import { Body } from '@hestjs/validation';
+import { CreateUserDto, UpdateUserDto } from './dto/user.dto';
+import { UsersService } from './users.service';
+
+/**
+ * 用户控制器 - 展示验证功能
+ */
+@Controller('/users')
+export class UsersController {
+  constructor(private readonly usersService: UsersService) {}
+
+  @Get('/')
+  async getAllUsers() {
+    return {
+      success: true,
+      data: this.usersService.findAll(),
+      message: 'Users retrieved successfully',
+    };
+  }
+
+  @Get('/:id')
+  async getUser(@Context() c: HestContext) {
+    const id = parseInt(c.req.param('id'));
+    const user = this.usersService.findOne(id);
+
+    if (!user) {
+      return c.json(
+        {
+          success: false,
+          message: 'User not found',
+        },
+        404,
+      );
+    }
+
+    return {
+      success: true,
+      data: user,
+      message: 'User retrieved successfully',
+    };
+  }
+
+  @Post('/')
+  async createUser(@Body(CreateUserDto) createUserDto: CreateUserDto) {
+    const newUser = this.usersService.create(createUserDto);
+    return {
+      success: true,
+      data: newUser,
+      message: 'User created successfully',
+    };
+  }
+
+  @Post('/:id')
+  async updateUser(
+    @Context() c: HestContext,
+    @Body(UpdateUserDto) updateUserDto: UpdateUserDto,
+  ) {
+    const id = parseInt(c.req.param('id'));
+    const updatedUser = this.usersService.update(id, updateUserDto);
+    return {
+      success: true,
+      data: updatedUser,
+      message: 'User updated successfully',
+    };
+  }
+}

package/templates/base_scalar/src/modules/users/users.module.ts

@@ -0,0 +1,10 @@
+import { Module } from '@hestjs/core';
+import { UsersController } from './users.controller';
+import { UsersService } from './users.service';
+
+@Module({
+  controllers: [UsersController],
+  providers: [UsersService],
+  exports: [UsersService],
+})
+export class UsersModule {}

package/templates/base_scalar/src/modules/users/users.service.ts

@@ -0,0 +1,55 @@
+import { Injectable } from '@hestjs/core';
+import type { User } from './entities/user.entity';
+import type { CreateUserDto, UpdateUserDto } from './dto/user.dto';
+
+/**
+ * 用户服务
+ */
+@Injectable()
+export class UsersService {
+  private users: User[] = [
+    { id: 1, name: 'John Doe', email: 'john@example.com', age: 30 },
+    { id: 2, name: 'Jane Smith', email: 'jane@example.com', age: 25 },
+  ];
+
+  findAll(): User[] {
+    return this.users;
+  }
+
+  findOne(id: number): User | undefined {
+    return this.users.find(user => user.id === id);
+  }
+
+  create(createUserDto: CreateUserDto): Omit<User, 'password'> {
+    const newUser: User = {
+      id: this.users.length + 1,
+      ...createUserDto,
+    };
+    this.users.push(newUser);
+
+    // 不返回密码
+    const { password: _password, ...userWithoutPassword } = newUser;
+    return userWithoutPassword;
+  }
+
+  update(id: number, updateUserDto: UpdateUserDto): User {
+    const userIndex = this.users.findIndex(user => user.id === id);
+    if (userIndex === -1) {
+      throw new Error('User not found');
+    }
+
+    this.users[userIndex] = { ...this.users[userIndex], ...updateUserDto };
+    return this.users[userIndex];
+  }
+
+  remove(id: number): User {
+    const userIndex = this.users.findIndex(user => user.id === id);
+    if (userIndex === -1) {
+      throw new Error('User not found');
+    }
+
+    const deletedUser = this.users[userIndex];
+    this.users.splice(userIndex, 1);
+    return deletedUser;
+  }
+}

package/templates/base_scalar/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "extends": "@hestjs/typescript-config/base.json",
+  "compilerOptions": {
+    "strict": true,
+    "jsx": "react-jsx",
+    "jsxImportSource": "hono/jsx",
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "target": "ES2022",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "outDir": "./dist",
+    "declaration": true,
+    "sourceMap": true,
+    "paths": {
+      "@/*": ["./src/*"]
+    }
+  }
+}

package/templates/cqrs/.prettierrc

@@ -0,0 +1,33 @@
+{
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "quoteProps": "as-needed",
+  "tabWidth": 2,
+  "printWidth": 80,
+  "bracketSpacing": true,
+  "arrowParens": "avoid",
+  "endOfLine": "lf",
+  "useTabs": false,
+  "overrides": [
+    {
+      "files": "*.json",
+      "options": {
+        "singleQuote": false
+      }
+    },
+    {
+      "files": "*.md",
+      "options": {
+        "proseWrap": "preserve"
+      }
+    },
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "options": {
+        "singleQuote": true,
+        "semi": true
+      }
+    }
+  ]
+}

package/templates/cqrs/.vscode/extensions.json

@@ -0,0 +1,79 @@
+{
+  "recommendations": [
+    // Cline
+    "saoudrizwan.claude-dev",
+
+    // Code Runner
+    "formulahendry.code-runner",
+
+    // Color Highlight
+    "naumovs.color-highlight",
+
+    // Draw Folder Structure
+    "jmkrivocapich.drawfolderstructure",
+
+    // ESLint
+    "dbaeumer.vscode-eslint",
+
+    // Git Graph
+    "mhutchie.git-graph",
+
+    // GitHub Copilot
+    "GitHub.copilot",
+
+    // GitHub Copilot Chat
+    "GitHub.copilot-chat",
+
+    // Github Actions
+    "github.vscode-github-actions",
+
+    // i18n Ally
+    "lokalise.i18n-ally",
+
+    // Iconify IntelliSense
+    "antfu.iconify",
+
+    // Indenticator
+    "SirTori.indenticator",
+
+    // Jest
+    "Orta.vscode-jest",
+
+    // Lingma - Alibaba
+    "Alibaba-Cloud.tongyi-lingma",
+
+    // Monorepo Workspace
+    "folke.vscode-monorepo-workspace",
+
+    // Prettier
+    "esbenp.prettier-vscode",
+
+    // Pretty TypeScript Errors
+    "YoavBls.pretty-ts-errors",
+
+    // Prisma
+    "Prisma.prisma",
+
+    // ,Todo Tree
+    "Gruntfuggly.todo-tree",
+
+    // Git Tags
+    "howardzuo.vscode-git-tags",
+
+    // JSON Comments
+    "wxzhang.json-comments",
+
+    // Markdown 相关
+    "kortina.vscode-markdown-notes",
+    "bierner.markdown-mermaid",
+    "DavidAnson.vscode-markdownlint",
+    "yzhang.markdown-all-in-one",
+    "zaaack.markdown-editor",
+
+    // 半透明背景
+    "illixion.vscode-vibrancy-continued",
+
+    // tailwindcss
+    "bradlc.vscode-tailwindcss"
+  ]
+}

package/templates/cqrs/.vscode/settings.json

@@ -0,0 +1,70 @@
+{
+  "prettier.enable": true,
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.formatOnSave": true,
+  "[typescript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[javascript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+
+  // i18n-ally
+  "i18n-ally.enabledParsers": ["json"],
+  "i18n-ally.displayLanguage": "zh-CN",
+  "i18n-ally.localesPaths": ["i18n", "public/messages", "script/i18n"],
+  "i18n-ally.keystyle": "nested",
+
+  // 文件嵌套
+  "explorer.fileNesting.enabled": true,
+  "explorer.fileNesting.expand": true,
+  "explorer.fileNesting.patterns": {
+    "*.ts": "${basename}.md, ${basename}.d.ts, ${basename}.test.ts, ${basename}.spec.ts, ${basename}.stories.ts, ${basename}.stories.tsx",
+    "*.tsx": "${basename}.md, ${basename}.d.ts, ${basename}.test.tsx, ${basename}.spec.tsx, ${basename}.stories.ts, ${basename}.stories.tsx",
+    "*.js": "${basename}.md, ${basename}.d.ts, ${basename}.test.js, ${basename}.spec.js, ${basename}.stories.js, ${basename}.stories.jsx",
+    "*.jsx": "${basename}.md, ${basename}.d.ts, ${basename}.test.jsx, ${basename}.spec.jsx, ${basename}.stories.js, ${basename}.stories.jsx",
+    "*.env": ".env.local, .env.development, .env.production, .env.test",
+    "package.json": "package-lock.json, yarn.lock, pnpm-lock.yaml, .gitignore, .prettierrc, eslint.config.mjs, i18n.ts, components.json, postcss.config.mjs, tsconfig.json, eslint.config.ts, .prettierignore, bun.lock, .dockerignore",
+    "eslint.config.mjs": "eslint.config.cjs, eslint.config.jsx, eslint.config.ts, eslint.config.tsx",
+    "tsconfig.json": "tsconfig.cjs.json, tsconfig.jsx.json, tsconfig.ts.json, tsconfig.tsx.json",
+    "tailwind.config.mjs": "tailwind.config.cjs, tailwind.config.jsx, tailwind.config.ts, tailwind.config.tsx",
+    "next.config.ts": "next.config.cjs, next.config.jsx, next.config.tsx, next-env.d.ts"
+  },
+
+  // ESLint 配置
+  "eslint.enable": true,
+  "eslint.validate": [
+    "javascript",
+    "javascriptreact",
+    "typescript",
+    "typescriptreact"
+  ],
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit",
+    "source.organizeImports": "explicit"
+  },
+  "eslint.alwaysShowStatus": true,
+
+  // TypeScript 配置
+  "typescript.preferences.importModuleSpecifier": "relative",
+  "typescript.suggest.autoImports": true,
+
+  // 额外的文件排除
+  "files.exclude": {
+    "**/.git": true,
+    "**/.svn": true,
+    "**/.hg": true,
+    "**/CVS": true,
+    "**/.DS_Store": true,
+    "**/Thumbs.db": true
+    // "**/node_modules": true,
+    // "**/.next": true
+  },
+  "search.exclude": {
+    "**/node_modules": true,
+    "**/bower_components": true,
+    "**/*.code-search": true,
+    "**/.next": true,
+    "**/dist": true
+  }
+}

package/templates/cqrs/README.md

@@ -0,0 +1,234 @@
+# @hestjs/cqrs
+
+HestJS CQRS - Command Query Responsibility Segregation module for HestJS
+
+## 安装
+
+```bash
+npm install @hestjs/cqrs
+```
+
+## 基本用法
+
+### 1. 初始化CQRS模块
+
+```typescript
+import { CqrsModule } from "@hestjs/cqrs";
+
+// 基本初始化
+CqrsModule.forRoot();
+
+// 或者使用选项
+CqrsModule.forRoot({
+  // 自定义配置
+});
+```
+
+### 2. 创建Command
+
+```typescript
+import { Command } from "@hestjs/cqrs";
+
+export class CreateUserCommand extends Command<string> {
+  constructor(
+    public readonly name: string,
+    public readonly email: string
+  ) {
+    super();
+  }
+}
+```
+
+### 3. 创建Command Handler
+
+```typescript
+import { CommandHandler, ICommandHandler } from "@hestjs/cqrs";
+import { CreateUserCommand } from "./create-user.command";
+
+@CommandHandler(CreateUserCommand)
+export class CreateUserHandler
+  implements ICommandHandler<CreateUserCommand, string>
+{
+  async execute(command: CreateUserCommand): Promise<string> {
+    // 处理命令逻辑
+    console.log(`Creating user: ${command.name} (${command.email})`);
+    return "user-id-123";
+  }
+}
+```
+
+### 4. 创建Query
+
+```typescript
+import { Query, IQueryResult } from "@hestjs/cqrs";
+
+export class GetUserQuery extends Query<GetUserResult> {
+  constructor(public readonly userId: string) {
+    super();
+  }
+}
+
+export class GetUserResult implements IQueryResult {
+  constructor(
+    public readonly id: string,
+    public readonly name: string,
+    public readonly email: string
+  ) {}
+}
+```
+
+### 5. 创建Query Handler
+
+```typescript
+import { QueryHandler, IQueryHandler } from "@hestjs/cqrs";
+import { GetUserQuery, GetUserResult } from "./get-user.query";
+
+@QueryHandler(GetUserQuery)
+export class GetUserHandler
+  implements IQueryHandler<GetUserQuery, GetUserResult>
+{
+  async execute(query: GetUserQuery): Promise<GetUserResult> {
+    // 查询逻辑
+    return new GetUserResult(query.userId, "John Doe", "john@example.com");
+  }
+}
+```
+
+### 6. 创建Event
+
+```typescript
+import { Event } from "@hestjs/cqrs";
+
+export class UserCreatedEvent extends Event {
+  constructor(
+    public readonly userId: string,
+    public readonly name: string,
+    public readonly email: string
+  ) {
+    super(userId);
+  }
+}
+```
+
+### 7. 创建Event Handler
+
+```typescript
+import { EventsHandler, IEventHandler } from "@hestjs/cqrs";
+import { UserCreatedEvent } from "./user-created.event";
+
+@EventsHandler(UserCreatedEvent)
+export class UserCreatedHandler implements IEventHandler<UserCreatedEvent> {
+  async handle(event: UserCreatedEvent): Promise<void> {
+    // 处理事件逻辑
+    console.log(`User created: ${event.name} (${event.email})`);
+  }
+}
+```
+
+### 8. 在控制器中使用
+
+```typescript
+import { Controller, Post } from "@hestjs/core";
+import { CommandBus, QueryBus, EventBus } from "@hestjs/cqrs";
+import { CreateUserCommand } from "./commands/create-user.command";
+import { GetUserQuery } from "./queries/get-user.query";
+import { UserCreatedEvent } from "./events/user-created.event";
+
+@Controller("/users")
+export class UserController {
+  constructor(
+    private readonly commandBus: CommandBus,
+    private readonly queryBus: QueryBus,
+    private readonly eventBus: EventBus
+  ) {}
+
+  @Post()
+  async createUser(data: { name: string; email: string }) {
+    const command = new CreateUserCommand(data.name, data.email);
+    const userId = await this.commandBus.execute(command);
+
+    // 发布事件
+    const event = new UserCreatedEvent(userId, data.name, data.email);
+    await this.eventBus.publish(event);
+
+    return { userId };
+  }
+
+  @Get("/:id")
+  async getUser(id: string) {
+    const query = new GetUserQuery(id);
+    return await this.queryBus.execute(query);
+  }
+}
+```
+
+### 9. 注册处理器
+
+```typescript
+import { CqrsModule } from "@hestjs/cqrs";
+import { CreateUserHandler } from "./handlers/create-user.handler";
+import { GetUserHandler } from "./handlers/get-user.handler";
+import { UserCreatedHandler } from "./handlers/user-created.handler";
+
+// 初始化CQRS模块
+CqrsModule.forRoot();
+
+// 获取CQRS模块实例
+const cqrsModule = CqrsModule.getInstance();
+
+// 注册处理器
+cqrsModule.registerHandler(CreateUserHandler);
+cqrsModule.registerHandler(GetUserHandler);
+cqrsModule.registerHandler(UserCreatedHandler);
+
+// 启动应用时调用
+await cqrsModule.onApplicationBootstrap();
+```
+
+### 10. Saga (长期运行的流程)
+
+```typescript
+import { Saga, ICommand } from "@hestjs/cqrs";
+import { UserCreatedEvent } from "./events/user-created.event";
+import { SendWelcomeEmailCommand } from "./commands/send-welcome-email.command";
+
+@Saga()
+export class UserSaga {
+  // 当用户创建事件发生时，发送欢迎邮件
+  async onUserCreatedEvent(event: UserCreatedEvent): Promise<ICommand[]> {
+    return [new SendWelcomeEmailCommand(event.userId, event.email)];
+  }
+}
+```
+
+## API 参考
+
+### 装饰器
+
+- `@CommandHandler(command)` - 标记命令处理器
+- `@QueryHandler(query)` - 标记查询处理器
+- `@EventsHandler(...events)` - 标记事件处理器
+- `@Saga()` - 标记Saga
+
+### 基类
+
+- `Command<T>` - 命令基类，T为返回类型
+- `Query<T>` - 查询基类，T为结果类型
+- `Event` - 事件基类
+
+### 总线
+
+- `CommandBus` - 命令总线
+- `QueryBus` - 查询总线
+- `EventBus` - 事件总线
+
+### 接口
+
+- `ICommandHandler<TCommand, TResult>` - 命令处理器接口
+- `IQueryHandler<TQuery, TResult>` - 查询处理器接口
+- `IEventHandler<TEvent>` - 事件处理器接口
+- `ISaga<TEvent>` - Saga接口
+
+## 许可证
+
+MIT

package/templates/cqrs/eslint.config.ts

@@ -0,0 +1,26 @@
+import wfConfig from '@hestjs/eslint-config';
+
+export default [
+  ...wfConfig,
+  {
+    files: ['**/*.ts', '**/*.tsx'],
+    rules: {
+      'no-console': 'error', // Demo 应用允许使用 console 进行调试
+    },
+  },
+  {
+    // 忽略构建产物和临时文件
+    ignores: [
+      'node_modules/**',
+      'dist/**',
+      'build/**',
+      '*.d.ts',
+      '.bun/**',
+      'bun.lockb',
+      // shadcn 目录
+      'src/components/ui/**',
+      // scripts 目录
+      'scripts/**',
+    ],
+  },
+];