技术文档中心

Appearance

第三部分：高阶技巧与隐藏玩法 ​

一键式重构 ​

功能介绍 ​

Trae 的一键式重构功能允许你利用 AI 的全量编辑能力，对代码进行大规模的重构和目录结构调整。

适用场景 ​

  • 目录结构调整：重新组织项目的目录结构
  • 代码架构优化：优化代码的架构和设计模式
  • 技术栈迁移：从一个技术栈迁移到另一个技术栈
  • 代码风格统一：统一整个项目的代码风格

实施步骤 ​

  1. 分析现状：使用 @Codebase 让 Trae 理解整个项目结构
  2. 定义目标：明确重构的目标和要求
  3. 生成计划：让 Trae 生成详细的重构计划
  4. 执行重构：使用 Builder 模式执行重构
  5. 验证结果：运行测试确保重构后的代码正常工作

示例提示词 ​

@Codebase

请对整个项目进行重构，目标是：
1. 将 src/components 目录下的组件按功能模块进行分类
2. 提取重复的逻辑到 src/utils 目录
3. 统一使用 TypeScript 类型定义
4. 确保所有测试通过

请先生成重构计划，然后执行重构。

重构技巧 ​

  • 分阶段进行：将大型重构分解为多个小阶段
  • 备份代码：在重构前备份原始代码
  • 测试驱动：确保重构后的代码通过所有测试
  • 增量验证：每完成一个阶段就验证一次

单元测试驱动开发 (TDD) ​

功能介绍 ​

Trae 可以根据 README.md 或需求文档直接生成测试用例，并帮助你实现通过这些测试的代码。

工作流程 ​

  1. 分析需求：让 Trae 分析 README.md 或需求文档
  2. 生成测试：根据需求生成单元测试用例
  3. 实现代码：编写通过测试的代码
  4. 验证测试：运行测试确保代码符合要求

示例提示词 ​

@Files README.md

请根据 README.md 中的需求，为项目生成完整的单元测试用例，然后实现通过这些测试的代码。

需求概述：
- 实现一个用户管理系统
- 支持用户注册、登录、查询和删除功能
- 使用 RESTful API 设计
- 数据存储使用 MongoDB

请先生成测试用例，然后实现代码。

TDD 技巧 ​

  • 测试先行：先编写测试用例，再实现代码
  • 边界条件：测试边界条件和异常情况
  • 代码覆盖率：确保测试覆盖主要功能和路径
  • 持续集成：将测试集成到 CI/CD 流程中

Prompt 预设（.traerules） ​

功能介绍 ​

.traerules 文件是 Trae 的配置文件，用于规定 AI 必须遵循的编码规范、命名约定和架构原则。

文件位置 ​

在项目根目录下创建 .traerules 文件。

配置内容 ​

1. 编码风格 ​

  • 缩进：指定缩进方式和大小
  • 命名规范：变量、函数、类的命名规范
  • 代码格式：代码的格式化规则

2. 架构原则 ​

  • 设计模式：推荐使用的设计模式
  • 代码组织：代码的组织方式和结构
  • 依赖管理：依赖的管理方式

3. 输出格式 ​

  • 注释风格：注释的风格和要求
  • 文档格式：文档的格式和要求
  • 测试要求：测试的要求和规范

通用 .traerules 模板 ​

yaml
# 编码风格
codeStyle:
  indentation: 2 spaces
  naming:
    variables: camelCase
    functions: camelCase
    classes: PascalCase
    constants: UPPER_SNAKE_CASE
  formatting:
    semicolons: true
    singleQuotes: true
    trailingCommas: all
    bracketSpacing: true

# 架构原则
architecture:
  designPatterns:
    - SOLID
    - Dependency Injection
    - Factory Pattern
  codeOrganization:
    - Component-based architecture
    - Separation of concerns
    - Single responsibility principle
  dependencyManagement:
    - Use package.json for dependencies
    - Avoid circular dependencies

# 输出格式
output:
  comments:
    required: true
    style: JSDoc
  documentation:
    required: true
    format: Markdown
  testing:
    required: true
    framework: Jest

# 语言和框架
language:
  default: TypeScript
  versions:
    node: 16+
    typescript: 5.0+

# 框架偏好
frameworks:
  frontend: React
  backend: Node.js
  database: MongoDB

# 禁止使用
ban:
  patterns:
    - eval
    - var
    - console.log (in production code)
  libraries:
    - jQuery
    - lodash (use native methods instead)

# 性能要求
performance:
  avoidMemoryLeaks: true
  optimizeRendering: true
  minimizeBundleSize: true

# 安全要求
security:
  avoidXSS: true
  preventSQLInjection: true
  useHTTPS: true

使用方法 ​

  1. 创建文件：在项目根目录创建 .traerules 文件
  2. 配置规则：根据项目需求配置规则
  3. 应用规则：Trae 会自动读取并应用这些规则
  4. 验证效果：检查生成的代码是否符合规则

规则优先级 ​

  • 项目级规则：项目根目录的 .traerules 文件
  • 目录级规则：特定目录下的 .traerules 文件（优先级更高）
  • 默认规则：Trae 的默认规则（优先级最低）

通过这些高阶技巧和隐藏玩法，你可以充分发挥 Trae 的能力，提高开发效率和代码质量。