用途
migration-guidance 是一个用于维护 Effect 库 v3 到 v4 迁移指引的技能。当 v3 的公共模块或 API 发生重命名、移动、删除、替换,或其在 v4 中的契约出现实质性变化时,使用本技能更新迁移说明。
需要注意的是,仅存在于 v4、在 v3 中没有对应物的 API,并不自动需要添加注解。
主要能力
- 覆盖所有受影响的 v3 符号,确保没有遗漏。
- 在添加或修改注解 YAML 之前,先阅读 annotations.md。
- 对照实现与测试,验证每一个建议的替换项。
- 在检查或重新生成参考文档、或 API 变更已存在于已提交的 ref 中时,阅读 generation.md;否则报告生成被推迟。
- 当输出已生成时,检查其中是否存在无关变动和过时引用。
使用方式
- 识别本次变更中所有受影响的 v3 公共模块或 API。
- 阅读 annotations.md,再添加或修改注解 YAML。
- 对照实现与测试,验证每个建议的替换项。
- 判断 API 变更是否存在于已提交的 ref 中:若是,阅读 generation.md 并执行检查或重新生成;若否,明确报告生成被推迟。
- 若已生成输出,检查是否存在无关变动和过时引用。
适用场景
- 修改 v3 公共 API 到 v4 的映射方式。
- 编辑迁移注解。
- 重新生成 migration/v3-to-v4.md。
完成标准
任务完成的标志是:
- 所有受影响的 v3 符号均已处理;
- 注解替换已验证;
- 当变更位于已提交的 ref 中时,检查与生成均成功;
- 每一处生成差异都有解释。
对于未提交的 API 变更,需明确报告被推迟的检查。
限制
资料未提供该技能的具体安装命令、支持的平台、收费方式或价格信息。