SuperAPI AI 工具集

codemod

写作与研究

查看项目

更新于 10-16 03:46

技能介绍

用途:这是一份面向 AI 智能体与 LLM 的 Codemod(JSSG、ast-grep、工作流)最佳实践指南,包含 48 条规则、11 个类别,按影响程度排序,用于指导自动化重构与代码生成。

适用时机:用 JSSG 或 ast-grep 编写新 codemod;为迁移设计工作流配置;调试模式匹配或 AST 遍历问题;评审 codemod 代码的性能与安全性;为转换验证搭建测试夹具。

主要能力(规则类别与优先级):AST 理解(CRITICAL,ast-)、模式效率(CRITICAL,pattern-)、解析策略(CRITICAL,parse-)、节点遍历(HIGH,traverse-)、语义分析(HIGH,semantic-)、编辑操作(MEDIUM-HIGH,edit-)、工作流设计(MEDIUM-HIGH,workflow-)、测试策略(MEDIUM,test-)、状态管理(MEDIUM,state-)、安全与能力(LOW-MEDIUM,security-)、包结构(LOW,pkg-)。

代表性要点:写模式前先用 AST Explorer 探索;区分具名与匿名节点,用 kind 约束提高精确度;优先使用元变量做灵活匹配并保证模式幂等;按文件类型选择解析器,用 parseAsync 处理嵌入式语言;用 find() 取单匹配、findAll() 取多匹配,单次遍历收集多模式;编辑前批量提交并保留格式、正确处理重叠区间;用输入/预期夹具对做测试,先在文件子集上验证;用状态支持可恢复迁移,长期运行记录进度日志;最小化声明能力、运行第三方 codemod 前先审查。

使用方式:按需阅读各参考文件获取详细解释与代码示例,包括章节定义、规则模板;完整展开版见 AGENTS.md。

限制:资料未提供具体安装命令、收费方式、平台支持与性能数据,暂未提供。