npm 包 @scott113341/github-to-omnifocus 使用教程

前言

作为一名前端工程师，我们经常需要处理 GitHub 上的任务，比如代码审查、维护 issue 列表等等。但若没有一个好的任务管理工具，很容易就会被任务搞得一塌糊涂。Omnifocus 是一个非常实用的任务管理工具，而 @scott113341/github-to-omnifocus 这个 npm 包可以将 GitHub 上的任务自动导入到 Omnifocus 中，极大提升了我们的工作效率。在本篇文章中，我们将介绍这个 npm 包的详细使用教程。

安装

使用 npm 进行安装：

npm install -g @scott113341/github-to-omnifocus

使用

配置 OAuth Token

首先，我们需要配置 GitHub 的 OAuth Token，具体操作如下：

1. 打开 GitHub Settings - Developer settings - Personal access tokens 页面
2. 点击 "Generate new token" 按钮，按指引授权 API 权限
3. 将生成的 Token 复制到剪切板中

配置 Omnifocus 配置文件

接下来，我们需要配置 Omnifocus 的配置文件，具体操作如下：

1. 在 Omnifocus 中新建一个任务，并将该任务拖拽到桌面，自动创建 omnifocus.ofocus 文件
2. 进入 .ofocus 文件所在的文件夹，新建一个 omnifocus.json 文件，输入以下信息：

{
    "appName": "Omnifocus",
    "clientIdentifier": "com.example.github-to-omnifocus",
    "versionOfClientIdentifier": "1",
    "documentId": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}

其中 documentId 为 .ofocus 文件的 UUID，可以通过以下方式获取：

1. 在 Omnifocus 中选中 .ofocus 文件
2. 点击菜单栏的 "Omnifocus" -> "Show backup folder"，进入 .ofocus 文件所在的文件夹
3. 双击 .ofocus 文件，Omnifocus 打开该文件并显示 UUID

运行命令

命令语法：

github-to-omnifocus [options] <repository> [repository...]

参数说明：

1. <repository>：GitHub 仓库地址，支持多个仓库
2. -t <token>：GitHub OAuth Token，如果未提供则使用环境变量 GITHUB_TOKEN
3. -h, --help：显示帮助

示例：

github-to-omnifocus -t [GITHUB_OAUTH_TOKEN] https://github.com/xxx/yyy

效果展示

成功运行命令后，我们可以在 Omnifocus 的 inbox 中看到导入的任务：

My Project
├── xxx/yyy #123: 我是任务标题 [github://issue/123]
└── xxx/yyy #124: 我是任务标题 [github://issue/124]

其中 My Project 为 Omnifocus 中的 Project，github://issue/123 为任务链接，可以点击跳转到对应的 issue。

总结

本文介绍了如何使用 @scott113341/github-to-omnifocus 这个 npm 包，将 GitHub 上的任务自动导入到 Omnifocus 中，极大提高了我们的工作效率。如果你经常在 GitHub 工作，又希望能够更好地管理您的任务，这个工具无疑是不可或缺的。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055b7e81e8991b448d90a0