Refactor Assistant 是一款面向代码质量改进的命令行重构建议工具。它的核心用途是:在你把代码交给他人评审之前,先让工具帮你检查一遍。只需指向一个文件,就能获得具体的重构建议,并以彩色 diff 的形式展示。该工具强调“一条命令、零配置、开箱即用”。
主要能力:
- 分析代码,发现可改进之处;
- 以彩色 diff 展示建议的修改;
- 关注可读性与代码模式;
- 支持自动应用修改;
- 分析维度包括可读性、重复代码、现代模式、性能以及类型安全。
使用方式: 该工具通过 npx 运行,无需安装。推荐使用 Node.js 18 及以上版本,并需要设置 OPENAI_API_KEY 环境变量。
快速开始: npx ai-refactor src/utils.ts
使用示例:
查看建议
npx ai-refactor src/utils.ts
直接应用修改
npx ai-refactor src/utils.ts --apply
聚焦特定方面
npx ai-refactor src/api.ts --focus "error handling"
查看帮助
npx ai-refactor --help
工作原理:读取你的文件,发送给 GPT-4o-mini 进行分析,然后以 diff 形式展示重构建议。
适用场景:
- 代码评审前的准备;
- 清理旧代码;
- 学习更好的代码模式;
- 技术债冲刺。
最佳实践建议:
- 应用前先审查,确认建议是否合理;
- 先提交代码,保证有一个干净的对比基线;
- 一次只聚焦一件事,不要一次性重构全部;
- 运行后执行测试,确保没有破坏功能。
限制与说明:
- 需要 OPENAI_API_KEY 环境变量;
- 分析依赖将代码发送至 GPT-4o-mini,需注意代码外发相关风险;
- 该工具是 LXGIC Dev Toolkit 的一部分,该工具集包含 110 多个免费开发者工具,官方称免费层无付费墙、无需注册、无需 API 密钥;
- 采用 MIT 许可证,官方称永久免费。
该工具由 LXGIC Studios 构建。相关链接:GitHub 仓库 github.com/lxgicstudios/refactor-suggest,Twitter @lxgicstudios。