Code Clippy VSCode 扩展开源项目教程

1. 项目介绍

Code Clippy 是一个基于 VSCode 的代码建议扩展，它旨在提供一个开源版本的代码建议功能，类似于 GitHub Copilot。该扩展利用 Huggingface 的 Inference API，从 StackOverflow 等平台提取代码片段，为开发者提供实时的代码建议。Code Clippy 的目标是创建一个完全开放源代码的代码建议系统，包括扩展、模型以及训练模型所使用的数据。

2. 项目快速启动

环境准备

在开始之前，确保已安装以下软件：

• Visual Studio Code
• Node.js 和 npm（测试版本：Node.js 10.19.0 和 npm 7.13.0）

克隆项目

首先，克隆项目到本地：

git clone https://github.com/CodedotAl/code-clippy-vscode.git
cd code-clippy-vscode

安装依赖

接着，安装项目依赖：

npm install

配置 Huggingface API Key

在开始使用前，需要获取 Huggingface 的 API Key。登录你的 Huggingface 账户，复制 API Key，并在启动扩展时输入。

启动扩展

打开 Visual Studio Code，按下 F5 键以在调试模式下启动扩展。在新打开的 VSCode 窗口中，打开任意文件开始编码，根据提示输入 Huggingface API Key。

接受建议时按下 Tab 键，循环查看不同建议时按下 Alt + [ 或 Alt + ]。

注意事项

• 启动模型可能需要一些时间（约20秒），请耐心等待。
• 确保在设置中启用了 editor.inlineSuggest.enabled 选项。
• Huggingface 的免费层级每月请求有限，仅作为演示使用。

3. 应用案例和最佳实践

代码建议使用

在使用 Code Clippy 时，建议：

• 保持代码简洁，避免过长的建议，因为模型可能会开始“虚构”变量和方法。
• 在代码编写过程中，适时接受建议，可以提高编码效率。

模型选择

默认模型可能不是最佳选择，可以尝试使用 EleutherAI/gpt-neo-1.3B 或 EleutherAI/gpt-neo-2.7B 模型，它们可能会提供更好的建议，但速度较慢。

4. 典型生态项目

Code Clippy 是一个开源项目，它依赖于以下几个典型的生态项目：

• Huggingface: 提供模型部署和推理服务。
• Visual Studio Code: 作为代码编辑器和扩展平台。
• Node.js 和 npm: 用于本地开发和依赖管理。

通过上述介绍，开发者可以快速上手 Code Clippy 项目，并在实际开发中遵循最佳实践，提高编码效率。