Protocol Launcher 系列：一键唤起 VSCodium 智能 IDE

在介绍了 Codex 的一键配置后，今天我们将介绍 Protocol Launcher 如何与 VSCodium 深度联动，让你在自由开源的编辑器中获得同样流畅的深度链接体验。

作为追求开源精神的开发者，你可能经常遇到这些场景：

• 在开源项目文档中提供一个「在 VSCodium 中打开」的链接，方便用户直接参与贡献。
• 在内部平台点击链接，直接在本地打开某个特定的代码文件进行审查。
• 通过远程开发功能，快速连接到服务器的代码环境进行调试。

现在，通过 Protocol Launcher ，你可以摆脱手动拼接复杂的 vscodium:// 协议链接，以类型安全的方式实现这些功能。

---

VSCodium 与深度链接

VSCodium 是一个由社区驱动、完全自由的 Microsoft VS Code 二进制发行版。它基于 MIT 许可构建，默认关闭了所有遥测功能，并移除了 Microsoft 的专有定制。对于注重隐私和开源自由的开发者来说，VSCodium 是最佳选择。

VSCodium 提供了强大的深度链接支持，允许从网页或第三方应用直接触发打开文件、文件夹、扩展等操作。然而，手动拼接这些链接通常需要处理各种参数格式，缺乏类型提示，容易出错。

---

核心能力：全面的深度集成

Protocol Launcher 为 VSCodium 专门提供了 protocol-launcher/vscodium 模块，支持以下核心功能：

1. 一键打开编辑器：直接唤起 VSCodium 主界面。
2. 打开本地文件：支持指定文件路径、行号和列号，精确定位代码位置。
3. 打开文件夹：快速在 VSCodium 中打开指定目录。
4. 远程开发支持：支持 SSH 远程开发、WSL 和开发容器三种模式。
5. 克隆项目：一键唤起 Git 克隆流程。
6. 打开扩展：快速定位到指定扩展的详情页面。
7. 打开设置：直接跳转到特定设置项。

---

快速上手

首先，确保你的项目中已安装：

npm install protocol-launcher

在代码中你可以根据场景选择两种导入方式：

• 按需加载（通过子路径导入），支持 Tree Shaking，体积更小。
• 全量导入（从根包导入），写法更简单，但会引入所有已支持应用的逻辑。

// ✅ 推荐：按需加载 VSCodium 模块
import { open, openFile, openFolder } from 'protocol-launcher/vscodium'

// 也可以从根包导入，但会包含所有应用模块
// import { vscodium } from 'protocol-launcher'

场景一：一键打开编辑器 (open)

这是最基础的功能，直接唤起 VSCodium 主界面：

import { open } from 'protocol-launcher/vscodium'

const url = open()
// => 'vscodium://'

场景二：打开本地文件 (openFile)

如果你想让用户快速查看某个特定的代码文件，可以指定文件路径和光标位置：

import { openFile } from 'protocol-launcher/vscodium'

const url = openFile({
  path: '/etc/hosts',     // 文件路径
  line: 10,               // 可选：行号
  column: 5,              // 可选：列号
  openInNewWindow: true,  // 可选：是否在新窗口打开
})
// => 'vscodium://file/etc/hosts:10:5?windowId=_blank'

场景三：打开文件夹 (openFolder)

快速在 VSCodium 中打开指定目录：

import { openFolder } from 'protocol-launcher/vscodium'

const url = openFolder({
  path: '/path/to/project',    // 文件夹路径
  openInNewWindow: true,       // 可选：是否在新窗口打开
})
// => 'vscodium://file/path/to/project?windowId=_blank'

场景四：远程开发 (openRemote)

VSCodium 支持三种远程开发模式，满足不同开发场景需求：

import { openRemote } from 'protocol-launcher/vscodium'

// SSH 远程开发
const sshUrl = openRemote({
  type: 'ssh-remote',
  host: 'root@192.168.1.100:22',
  path: '/code/my-project',
})
// => 'vscodium://vscode-remote/ssh-remote+root@192.168.1.100:22/code/my-project'

// WSL 开发
const wslUrl = openRemote({
  type: 'wsl',
  host: 'Ubuntu-22.04',
  path: '/home/ubuntu/project',
})

// 开发容器
const devContainerUrl = openRemote({
  type: 'dev-container',
  host: 'my-project-container',
  path: '/workspace',
})

场景五：克隆项目 (cloneProject)

直接唤起 VSCodium 的 Git 克隆功能：

import { cloneProject } from 'protocol-launcher/vscodium'

const url = cloneProject({
  repo: 'https://github.com/zhensherlock/protocol-launcher',
})
// => 'vscodium://vscode.git/clone?url=https%3A%2F%2Fgithub.com%2Fzhensherlock%2Fprotocol-launcher'

场景六：打开扩展 (openExtension)

快速定位到指定扩展的详情页面：

import { openExtension } from 'protocol-launcher/vscodium'

const url = openExtension({
  id: 'esbenp.prettier-vscode',
})
// => 'vscodium:extension/esbenp.prettier-vscode'

场景七：打开设置 (openSettings)

直接跳转到特定设置项，方便用户快速配置：

import { openSettings } from 'protocol-launcher/vscodium'

// 打开默认设置页面
const defaultSettings = openSettings()
// => 'vscodium://settings'

// 打开特定设置项
const specificSettings = openSettings({
  path: 'terminal.integrated.suggest.enabled',
})
// => 'vscodium://settings/terminal.integrated.suggest.enabled'

---

为什么选择 Protocol Launcher？

1. 类型安全与参数提示：TypeScript 的智能补全确保你提供了正确的参数，并提醒你可选的配置项。
2. 自动编码处理：内部自动处理 URL 编码逻辑，确保生成的链接在唤起应用时不会出错。
3. 一致的跨平台体验：通过封装复杂的协议逻辑，你可以专注于业务功能的实现，而不用担心不同操作系统下的差异。
4. 极致的按需加载 ：采用了模块化设计，支持按需加载以最小化包体积：
   • 推荐方式 ：使用子路径导入（如 import { openFile } from 'protocol-launcher/vscodium'），这样构建工具只会打包相关的代码。
   • 全量方式 ：也可以从根包导入（如 import { vscodium } from 'protocol-launcher'），建议生产环境始终使用按需加载。

---

结语

通过 Protocol Launcher，你可以将 VSCodium 的强大功能与你的应用深度集成。无论是在开源项目的文档中，还是企业内部的代码管理平台，它都是连接 Web 与本地 VSCodium 编辑器最优雅的桥梁。选择 VSCodium，选择自由与隐私；选择 Protocol Launcher，选择高效与便捷。

---

🔗 相关链接

• Protocol Launcher 官网: https://protocol-launcher.huayi-data.com/
• VSCodium 模块文档: VSCodium | Protocol Launcher