跳到主要内容

Rule

简介

Rule 是 CodeSouler 提供的一个规则管理功能，允许用户创建和管理自定义规则文件。通过这个功能，您可以定义项目特定的编码规范、开发指南和最佳实践，确保团队成员遵循统一的开发标准。

1. 创建 Rule 文件​

创建步骤 请按照以下步骤创建 Rule 文件：

  1. 在 CodeSouler 设置页面中，选择 Rules 选项。
  2. 点击 "Add new rule" 按钮创建新的规则文件。
  3. 为规则文件指定一个有意义的名称。
  4. 使用 Markdown 格式编写规则内容，支持标题、列表、代码块等标准 Markdown 语法。

img

2. 使用 Rule​

使用步骤 请按照以下步骤使用 Rule：

  1. 在 CodeSouler 对话框中输入 +Rules 命令。
  2. 系统会显示当前项目中所有可用的规则文件列表。
  3. 从列表中选择您需要应用的规则。
  4. 选中的规则将被添加到对话上下文中，AI 助手将根据这些规则提供建议和指导。

img

3. Rule 的高级配置​

3.1 Cursor Rule 兼容性​

  • CodeSouler Rules 完全兼容 Cursor Rule 的 .mdc 文件格式
  • 您可以直接使用现有的 Cursor Rule 文件，无需额外转换

3.2 Always 模式​

  • 将 alwaysApply 设置为 true 启用 Always 模式
  • 在此模式下，chat 和 agent 每次对话都会自动将全局 rule 作为上下文
  • 适用于需要始终遵循的核心开发规范

img

3.3 AgentRequested 模式​

  • 将 alwaysApply 设置为 true
  • 在 description 字段中详细描述规则文档的作用和使用场景
  • Agent 会根据 description 智能判断是否采纳规则文件的规则
  • 适用于特定场景下的开发规范

img

4. 最佳实践​

建议 为了更有效地使用 Rule 功能，我们建议：

  1. 为不同类型的规则创建独立的规则文件，如代码风格、安全规范、性能优化等。

  2. 在规则描述中提供具体的示例和说明，帮助团队成员更好地理解和执行。

  3. 定期更新规则内容，确保与最新的开发实践保持一致。

  4. 使用 Markdown 的代码块功能来展示具体的代码示例和反例。

  5. 为规则添加清晰的优先级和适用范围说明。

  6. 在团队中建立规则审查和更新机制，确保规则的有效性和实用性。