Grammarly for VS Code 安装和配置指南

1. 项目基础介绍和主要编程语言

项目基础介绍

Grammarly for VS Code 是一个为 Visual Studio Code 编辑器开发的扩展，旨在提供实时的语法检查和写作建议。该项目基于 Grammarly 的 SDK，帮助开发者在编写代码时提高文本的质量和准确性。

主要编程语言

该项目主要使用以下编程语言：

• TypeScript
• JavaScript
• HTML

2. 项目使用的关键技术和框架

关键技术和框架

• Grammarly SDK: 提供语法检查和写作建议的核心功能。
• VS Code Extension API: 用于开发和集成 VS Code 扩展。
• pnpm: 项目使用的包管理工具，用于安装和管理依赖。
• tree-sitter: 用于解析和处理代码的语法树。

3. 项目安装和配置的准备工作和详细安装步骤

准备工作

在开始安装之前，请确保您的开发环境满足以下要求：

• 已安装 Visual Studio Code (VS Code)。
• 已安装 Node.js 和 npm。
• 已安装 pnpm（可以通过 npm install -g pnpm 安装）。

详细安装步骤

步骤 1: 克隆项目仓库

首先，从 GitHub 克隆项目仓库到本地：

git clone https://github.com/znck/grammarly.git
cd grammarly

步骤 2: 安装依赖

使用 pnpm 安装项目所需的依赖：

pnpm install

步骤 3: 构建项目

运行构建脚本以生成项目文件：

pnpm run build

步骤 4: 安装 VS Code 扩展

在 VS Code 中，打开扩展视图（可以通过 Ctrl+Shift+X 或 Cmd+Shift+X 快捷键打开），然后点击“从 VSIX 安装”按钮，选择生成的 .vsix 文件进行安装。

步骤 5: 配置扩展

安装完成后，您可以在 VS Code 的设置中配置 Grammarly 扩展。例如，您可以设置语言偏好、启用或禁用某些功能等。

添加新语言支持

如果您希望为项目添加对新语言的支持，请按照以下步骤操作：

1. 在 extension/package.json 文件中，添加 "onLanguage:<language name>" 到 activationEvents。
2. 安装 tree-sitter 语法包（通常命名为 tree-sitter-<language name>）。
3. 在 scripts/build-wasm.mjs 脚本中添加新语言的构建配置。
4. 在 parsers 目录下创建新语言的转换器，参考 LanguageHTML.ts 文件。

获取帮助

如果您在使用过程中遇到问题或需要反馈，可以通过项目仓库的讨论区（Discussions）提问或分享您的反馈。

---

通过以上步骤，您应该能够成功安装和配置 Grammarly for VS Code 扩展，并开始享受实时的语法检查和写作建议。