ClipRoam VS Code 扩展
在编辑器标签页中使用ClipRoam,共用登录、历史、设置与同步业务。需要连接已部署的ClipRoam Server。
使用
安装 VSIX 后,点击窗口标题栏或编辑器标题栏中的ClipRoam图标,或在命令面板运行 ClipRoam: Open Clipboard History,填写服务器地址并登录。重复打开会回到已有的ClipRoam标签页。
- 添加选中文本:选中编辑器文本,右键选择
ClipRoam: Add Selection to History,也可从命令面板运行对应命令。文本先暂存在扩展本地,登录进入主界面后自动加入当前账号的上传队列,无需等待登录验证完成再操作。
- 使用历史文本:在ClipRoam历史中复制文本,再回到编辑器粘贴。主界面与其他客户端一致,不显示编辑器专属工具栏。
- 读取剪贴板:使用历史界面的“读取当前剪贴板”操作。
- 下载图片和文件:点击“下载”,单个图片或文件会打开保存框;文件夹或多文件会打开目录选择框,确认后写入所选位置。取消选择不会开始下载。
登录和缓存沿用共享客户端的 Webview IndexedDB。关闭标签页后同步停止,重新打开会恢复保存的连接设置并验证会话。尚未导入的选中文本保存在 VS Code 扩展本地存储中,关闭面板或重启后仍保留;进入主界面时沿用分享导入流程处理,成功后清除,失败后保留重试。
首版支持桌面 VS Code,使用本地 UI 扩展宿主;没有浏览器版扩展入口。仅支持文本剪贴板,不监听系统复制,不提供全局快捷键;图片和文件可以查看、下载并保存到本机,系统图片/文件复制暂不支持。
构建和调试
在仓库根目录执行:
pnpm install
pnpm build:vscode
pnpm package:vscode
VSIX 位于 apps/vscode/dist/cliproam.vsix。在 VS Code 扩展菜单中选择“从 VSIX 安装”。开发时选择仓库的 Launch VS Code Extension 调试配置,按 F5 启动扩展开发宿主。
扩展通过受限消息桥调用 VS Code 文本剪贴板、文本编辑器和外部链接 API。Webview 仅允许加载打包资源,HTTP/WebSocket 连接用于访问用户配置的服务器。
| |