SuperAPI AI 工具集

trellis-before-dev

编程与开发

查看项目

更新于 10-16 09:38

技能介绍

用途

trellis-before-dev 用于在开始开发任务之前,读取并注入项目专属的编码规范。其核心目标是让开发者在编写任何代码之前,先了解项目既定的编码标准与模式,从而保证实现符合项目约定。

主要能力

  • 发现项目中的包及其规范层级。
  • 根据任务定位适用的规范:包括正在修改的包(例如 cli/、docs-site/)以及工作类型(后端、前端、单元测试、文档等)。
  • 读取相关模块的规范索引。
  • 遵循索引中的“Pre-Development Checklist”(开发前检查清单)。
  • 读取检查清单中列出的、与任务相关的具体指南文件(例如 error-handling.md、conventions.md、mock-strategies.md)。
  • 始终读取共享指南。

使用方式

该技能要求执行以下步骤:

  1. 发现包及其规范层级:
python3 ./.trellis/scripts/get_context.py --mode packages
  1. 根据以下两点确定适用的规范:

    • 正在修改哪个包(例如 cli/、docs-site/)
    • 工作类型(后端、前端、单元测试、文档等)
  2. 读取每个相关模块的规范索引:

cat .trellis/spec/<package>/<layer>/index.md
  1. 遵循索引中的“Pre-Development Checklist”部分。

  2. 读取开发前检查清单中列出的、与任务相关的具体指南文件。索引本身不是目标——它指向实际的指南文件(例如 error-handling.md、conventions.md、mock-strategies.md)。阅读这些文件以理解编码标准和模式。

  3. 始终读取共享指南:

cat .trellis/spec/guides/index.md
  1. 理解需要遵循的编码标准和模式,然后继续开发计划。

该步骤在编写任何代码之前是强制性的。

适用场景

适用于在遵循 .trellis/spec/ 规范体系的项目中开始任何开发任务之前,需要先了解项目专属编码规范的场景。

限制

关于该技能的具体收费、价格、平台支持范围、实际效果等信息,资料中暂未提供。