VSCode AI 代码优化助手
项目简介
这是一个VSCode插件,用于帮助开发者优化他们的代码。用户可以选择一段代码,然后从预设的四个优化方向中选择一个,AI将根据所选方向对代码进行优化并返回优化后的结果。
安装
从 VSCode 插件市场安装
- 打开 VSCode
- 点击左侧活动栏上的扩展图标
- 搜索 "AI 代码优化助手"
- 点击安装
从 VSIX 文件安装
- 下载最新的
.vsix 文件从 Releases
- 打开 VSCode
- 点击左侧活动栏上的扩展图标
- 点击 "..." 菜单,选择 "从 VSIX 安装..."
- 选择下载的
.vsix 文件
功能特点
- 选择代码段进行优化
- 四种优化方向可选:性能优化、代码可读性优化、安全性优化、内存优化
- 智能分析代码上下文,提供更精准的优化建议
- 直观展示优化前后的代码对比
- 一键应用优化后的代码
- 可自定义上下文分析范围
使用方法
- 在VSCode中打开任意代码文件
- 选择要优化的代码段
- 右键点击,从上下文菜单中选择"AI代码优化助手"或使用快捷键
Ctrl+Shift+O (Windows/Linux)或Cmd+Shift+O (Mac)
- 从弹出的优化方向中选择一种
- 等待AI优化完成
- 在显示的对比视图中查看优化前后的代码差异
- 点击"应用优化"按钮将优化后的代码应用到原文件中
配置选项
在 VSCode 设置中,你可以自定义以下选项:
- API URL (
aiCodeOptimizer.apiUrl ): AI 服务的 API 地址
- API 密钥 (
aiCodeOptimizer.apiKey ): 用于访问 AI 服务的密钥
- 上下文行数 (
aiCodeOptimizer.contextLines ): 发送给 AI 的代码上下文行数(默认为 15 行)
- 数值范围:0-50
- 增加上下文行数可以帮助 AI 更好地理解代码结构和逻辑关系
- 但过多的上下文可能会增加请求大小和处理时间
优化方向说明
- 性能优化:提高代码执行速度和效率,减少不必要的计算,优化算法复杂度
- 代码可读性优化:改进命名、添加注释、调整格式,使代码更容易理解和维护
- 安全性优化:修复潜在的安全漏洞,加强输入验证,防止常见的攻击如注入、XSS等
- 内存优化:减少内存使用,防止内存泄漏,优化数据结构
技术实现
- VSCode扩展API
- WebView面板用于展示代码对比
- 集成AI服务用于代码优化
- 差异比较工具用于展示代码变化
项目结构
src/extension.ts :插件主入口
src/codeOptimizer.ts :代码优化逻辑
src/webviewPanel.ts :WebView面板管理
src/optimizationProviders/ :四种优化方向的实现
media/ :WebView界面的静态资源
开发指南
环境准备
- 安装 Node.js (推荐使用 v14 或更高版本)
- 安装 Visual Studio Code
- 克隆此仓库:
git clone https://github.com/yourusername/ai-code-optimizer.git
- 进入项目目录:
cd ai-code-optimizer
- 安装依赖:
npm install
开发
- 打开 VSCode:
code .
- 按 F5 启动调试,这将在新的 VSCode 窗口中加载扩展
- 在新窗口中打开任意代码文件,选择代码段,右键点击并选择 "AI 代码优化"
构建
# 开发构建
npm run compile
# 生产构建
npm run package
生产构建将在 dist 目录生成打包好的文件。
创建 VSIX 包
可以使用 VSCode 扩展工具 vsce 创建 VSIX 包:
# 全局安装 vsce
npm install -g vsce
# 创建 VSIX 包
vsce package
这将在项目根目录创建一个 .vsix 文件,可以用于分发和安装。
开发计划
- [x] 项目框架搭建
- [x] 实现代码选择功能
- [x] 实现优化方向选择UI
- [x] 集成AI服务
- [x] 实现代码对比界面
- [x] 实现优化结果应用功能
- [ ] 添加单元测试
- [ ] 实现自定义优化方向功能
- [ ] 添加优化历史记录功能
- [ ] 支持批量代码优化
- [ ] 测试与bug修复
- [ ] 发布到VSCode插件市场
贡献指南
欢迎提交问题报告和功能建议。如果您想贡献代码,请遵循以下步骤:
- Fork本仓库
- 创建您的特性分支
- 提交您的更改
- 推送到您的分支
- 创建一个新的Pull Request
| |