Sublime GitHub

这是一个 Sublime Text 文本编辑器（包括版本 2 和 3）的插件，提供了一些实用命令来操作 GitHub，包括创建和浏览 gist、在 GitHub 上打开和编辑文件，以及显示责任和提交历史视图。

安装

您可以通过 Sublime Package Control 插件进行安装。只需在命令面板中打开“Package Control: Install Package”，搜索“sublime-github”。插件应该会自动被识别。如果没有，重新启动 Sublime Text。

使用方法

首次运行其中一个命令时，它会要求您输入 GitHub 用户名和密码，以便创建 GitHub API 访问令牌，该令牌将保存在 Sublime GitHub 用户设置文件中。您的用户名和密码不会被存储在任何地方，但如果您更愿意自己生成访问令牌，请参阅下文“生成您自己的访问令牌”部分。

以下命令在命令面板中可用：

• GitHub: 切换账户

  切换到另一个 GitHub 账户（参见下文“添加额外账户”）

• GitHub: 从选择创建私密 gist

  从当前选择的文本创建私密 gist（如果未选择任何内容，则为活动编辑器的文本内容）。

• GitHub: 从选择创建公开 gist

  从当前选择的文本创建公开 gist（如果未选择任何内容，则为活动编辑器的文本内容）。

• GitHub: 将 gist 复制到剪贴板

  显示一个快速选择面板，列出所有您的 gist，选择其中一个将复制该 gist 的内容到您的剪贴板。

• GitHub: 将星标 gist 复制到剪贴板

  显示一个快速选择面板，仅列出您的星标 gist，选择其中一个将复制该 gist 的内容到您的剪贴板。

• GitHub: 在编辑器中打开 gist

  显示一个快速选择面板，列出您所有的 Gist，选择一个将打开一个新编辑器标签页，显示该 Gist 的内容。

• GitHub：在编辑器中打开星标 Gist

  显示一个快速选择面板，仅列出您星标的 Gist，选择一个将打开一个新编辑器标签页，显示该 Gist 的内容。

• GitHub：在浏览器中打开 Gist

  显示一个快速选择面板，列出您所有的 Gist，选择一个将在您的默认网页浏览器中打开该 Gist。

• GitHub：在浏览器中打开星标 Gist

  显示一个快速选择面板，仅列出您星标的 Gist，选择一个将在您的默认网页浏览器中打开该 Gist。

• GitHub：更新 Gist

  更新当前编辑器中打开的 Gist。

以下命令需要 Git 插件，可以通过软件包管理器获取。安装后，请重新启动 Sublime Text。

注意：这些命令使用当前检出分支生成 GitHub URL。每个命令还有一个相应的版本，例如 GitHub：责任归属（默认分支），该版本始终使用插件设置中配置的默认分支，而不管本地检出哪个分支。默认分支设置为 main，并且可以通过编辑首选项 > 包设置 > GitHub 中的 default_branch 设置来更改。除了 GitHub：编辑 之外的所有命令还有一个相应的“永久链接”版本，例如 GitHub：责任归属（永久链接），该版本使用当前分支上最近的提交（更多信息请参阅 链接）。

• GitHub：在浏览器中打开远程 URL

  在浏览器中打开当前文件在仓库中的位置。如果您选择了任何行，它们将在浏览器中突出显示。默认协议是 'https'。默认远程是 ''（没有远程）。如果需要更改这些，请在您的 GitHub.sublime-settings 文件中为您的特定账户设置。

• GitHub：复制远程 URL 到剪切板

  将当前文件在仓库中的位置的 URL 放入剪切板。如果您选择了任何行，它们将包含在 URL 中，并在浏览器中打开时突出显示。

• GitHub：责任归属

  在浏览器中打开当前文件的 GitHub 责任归属视图。如果您选择了任何行，它们将在浏览器中突出显示。

• GitHub：历史

  在浏览器中打开当前文件的 GitHub 提交历史视图。

• GitHub：查看

  是 GitHub：在浏览器中打开远程 URL 的别名

• GitHub：编辑

  在 GitHub 上打开当前文件以进行编辑。我不确定您为什么要这样做，但这很容易添加。

添加其他账户

如果您有多个 GitHub 账户或拥有私有 GitHub 安装，您可以为其他账户添加并随时切换它们。

转到 GitHub 用户设置文件（首选项 -> 包设置 -> GitHub -> 设置 - 用户），并在 accounts 字典中添加另一个条目。如果这是另一个 GitHub 账户，复制默认 GitHub 条目的 base_uri（如果您没有看到它，可以从首选项 -> 包设置 -> GitHub -> 设置 - 默认获取，或参考以下示例），只需给这个账户一个不同的名称。如果您正在添加私有 GitHub 安装，则 base_uri 将是您的私有 GitHub 的基本 URL，加上 “/api/v3”。例如

"accounts":
{
    "GitHub":
    {
        "base_uri": "https://api.github.com",
        "github_token": "..."
    },
    "YourCo":
    {
        "base_uri": "https://github.yourco.com/api/v3",
        "github_token": ""
    }
}

无需担心设置 github_token—在切换账户后（Shift-Cmd-P，“GitHub：切换账户”）将为您自动设置。

快捷键绑定

您可以在首选项 -> 键绑定 -> 用户中添加自己的键盘快捷键。例如

[
    { "keys": ["ctrl+super+g", "ctrl+super+n"], "command": "public_gist_from_selection" },
    { "keys": ["ctrl+super+g", "ctrl+super+p","super+n"], "command": "private_gist_from_selection" },
    { "keys": ["ctrl+super+g", "ctrl+super+o"], "command": "open_gist_in_editor" },
    { "keys": ["ctrl+super+g", "ctrl+super+c"], "command": "open_gist_url" }
]

(请注意，ctrl+super+g (^⌘G) 与 Sublime Text 的快速查找全部冲突，所以请相应调整。) 可用的命令可以在 https://github.com/bgreenlee/sublime-github/blob/master/Github.sublime-commands 查看。

问题

• Linux 系统需要安装 curl 二进制文件（在以下之一：/usr/local/sbin，/usr/local/bin，/usr/sbin，/usr/bin，/sbin 或 /bin）。

• 根据您拥有的 gists 的数量，首次获取 gists 列表可能会有相当长的延迟。后续请求将被缓存，应该会快一些（尽管 GitHub API 的 ETags 当前不正确；一旦修复，应该可以加快速度）。在此期间，如果有些 gists 您经常打开，请到 GitHub 上打开它们并“Star”，然后通过“打开/复制 Starred Gist”命令访问。

• 在 Linux 中，当在编辑器中打开 gists 时设置文件类型以进行语法高亮不起作用。这个功能需要付出很大努力才能实现，所以如果您迫切希望有这个功能，可以提出一个 issue。

生成您的自己的访问令牌

如果您觉得不舒服地将 GitHub 用户名和密码提供给插件，您可以自己生成一个 GitHub API 访问令牌。只需打开一个终端窗口/shell（在 macOS、Linux 或 Cygwin 上），然后运行

curl -u username -d '{"scopes":["gist"], "note": "sublime-github"}' https://api.github.com/authorizations

其中 username 是您的 GitHub 用户名。您首先会要求输入密码。然后您将得到一个包含 40 位“令牌”值（例如 6423ba8429a152ff4a7279d1e8f4674029d3ef87）的响应。转到 Sublime Text 2 -> Preferences -> Package Settings -> GitHub -> Settings - User，并将令牌插入其中。它应该看起来像

{
    "github_token": "6423ba8429a152ff4a7279d1e8f4674029d3ef87"
}

重启 Sublime。

这样就完成了！

配置代理

如果您在代理后面，可以为每个账户配置代理。

请注意，直到 urllib3 的一个 bug 修复为止，要使用代理，您还必须强制 curl 模式（显然需要 curl）。

例如

"accounts":
{
    "GitHub":
    {
        "base_uri": "https://api.github.com",
        "https_proxy": "...",
        "force_curl": true
    }
}

bug 和功能请求

http://github.com/bgreenlee/sublime-github/issues

版权

版权所有 © 2011+ Brad Greenlee。详情见 LICENSE。