在介绍了 Coda 的集成后,今天我们将目光转向移动端------介绍如何通过 Protocol Launcher 与 CodeHub 联动,让 iOS 设备上的 GitHub 协作变得更加高效。
作为移动开发者或经常需要在外处理代码事务的你,可能遇到过这些场景:
- 在手机上看到一段精彩代码,想快速创建 Gist 分享给同事。
- 收到 GitHub 通知后,希望一键跳转到 CodeHub 查看仓库详情。
- 在 Safari 浏览 GitHub 页面时,想直接唤起 CodeHub 获得更好的阅读体验。
现在,通过 Protocol Launcher,你可以轻松生成 CodeHub 深度链接,以类型安全的方式提升移动端协作效率。
CodeHub 与深度链接
CodeHub 是一款专为 iOS 设备设计的 GitHub 客户端,提供了优雅的仓库浏览、代码阅读和 Gist 管理功能。它支持通过 codehub:// 协议从外部应用唤起,并提供了创建 Gist 的 x-callback-url API。
然而,手动拼接这些协议链接需要处理参数编码和正确的 URL 格式,且缺乏类型提示,容易出错。
核心能力:一键唤起与快速创建 Gist
Protocol Launcher 为 CodeHub 专门提供了 protocol-launcher/codehub 模块,支持以下核心功能:
- 一键打开应用:直接从网页或第三方应用唤起 CodeHub。
- 创建 GitHub Gist:支持指定描述、公开状态和文件内容,快速创建代码片段。
- 自动处理协议逻辑:内部自动处理参数编码规则,确保生成的链接 100% 可用。
快速上手
首先,确保你的项目中已安装:
bash
npm install protocol-launcher
在代码中你可以根据场景选择两种导入方式:
- 按需加载(通过子路径导入),支持 Tree Shaking,体积更小;
- 全量导入(从根包导入),写法更简单,但会引入所有已支持应用的逻辑。
typescript
// ✅ 推荐:按需加载 CodeHub 模块
import { open, createGist } from 'protocol-launcher/codehub'
// 也可以从根包导入,但会包含所有应用模块
// import { codehub } from 'protocol-launcher'
场景一:一键打开 CodeHub (open)
这是最简单的使用场景。你可以引导用户直接在 iOS 设备上打开 CodeHub 应用:
typescript
import { open } from 'protocol-launcher/codehub'
const url = open()
场景二:快速创建 Gist (createGist)
如果你想让用户快速创建 GitHub Gist 代码片段:
typescript
import { createGist } from 'protocol-launcher/codehub'
const url = createGist({
description: 'Hello from Protocol Launcher', // Gist 描述
public: true, // 是否公开
files: {
'hello.txt': 'Hello, World!',
'codehub.txt': 'CodeHub is awesome!',
},
})
生成的 URL 将自动包含所有参数,用户点击后会在 CodeHub 中打开创建 Gist 的界面,并预填充你提供的内容。
参数详解
createGist 参数说明
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
description |
string |
否 | '' |
Gist 的描述信息 |
public |
boolean |
否 | false |
是否为公开 Gist |
files |
Record<string, string> |
否 | {} |
文件内容,键为文件名,值为文件内容 |
使用示例
typescript
// 创建私有 Gist
createGist({
description: '我的私有代码片段',
public: false,
files: {
'config.json': JSON.stringify({ key: 'value' }),
},
})
// 创建多文件公开 Gist
createGist({
description: 'Protocol Launcher 示例',
public: true,
files: {
'readme.md': '# Hello World',
'index.js': 'console.log("Hello")',
'styles.css': 'body { margin: 0; }',
},
})
// 创建空 Gist(打开创建界面让用户手动填写)
createGist({})
为什么选择 Protocol Launcher?
- 自动编码与参数处理 :CodeHub 的协议对参数格式有特定要求。库内部会自动处理所有的编码逻辑,确保生成的 URL 在唤起应用时绝不乱码。
- 类型安全与智能提示:TypeScript 的类型定义会确保你提供了正确的参数格式,并提供智能补全提示。
- 一致的用户体验:通过封装复杂的协议逻辑,你可以专注于业务功能的实现,而不用担心不同场景下协议触发的细微差异。
- 极致的按需加载 (Tree Shaking) :采用了模块化设计,支持按需加载以最小化包体积:
- 推荐方式 :使用子路径导入(如
import { createGist } from 'protocol-launcher/codehub'),这样构建工具只会打包相关的代码。 - 全量方式 :也可以从根包导入(如
import { codehub } from 'protocol-launcher'),建议生产环境始终使用按需加载。
- 推荐方式 :使用子路径导入(如
- 移动端友好:专为 iOS 设备优化,完美适配 Safari、Chrome 等移动浏览器的协议唤起机制。
实战演示:在博客中添加「创建 Gist」按钮
假设你正在写技术博客,想让读者能够快速分享你的代码示例:
typescript
// 生成分享链接
const shareUrl = createGist({
description: 'Protocol Launcher 代码示例',
public: true,
files: {
'example.ts': `
import { createGist } from 'protocol-launcher/codehub'
const url = createGist({
description: 'Hello',
files: { 'hello.txt': 'World' },
})
console.log(url)
`.trim(),
},
})
// 在页面中添加按钮
// <a href="${shareUrl}" class="gist-button">在 CodeHub 中创建 Gist</a>
读者点击按钮后,会自动跳转到 CodeHub 并预填充代码内容,只需点击保存即可完成分享。
结语
通过 Protocol Launcher,你可以极大提升移动端 GitHub 协作的效率。无论是在技术博客中提供代码分享功能,还是在内部文档中添加快速创建代码片段的入口,它都是连接 Web 与 CodeHub 最优雅的桥梁。
对于经常在移动场景下工作的开发者来说,这套方案能够让代码协作变得更加流畅和高效。
🔗 相关链接
- Protocol Launcher 官网:https://protocol-launcher.huayi-data.com/
- CodeHub 模块文档:CodeHub | Protocol Launcher