GitHub-Issues

简介

此插件旨在提供一个方便的方法来在Sublime Text中编写和更新问题。而不是打开外部浏览器，这个插件会打开一个新的缓冲区，允许用户使用Markdown本地在Sublime Text中编写/修改问题内容。

最初灵感来自于github-issues.vim。

功能

• 在Sublime Text中创建/发布/更新/打开/关闭GitHub问题。

• 浏览/导航任何公共仓库和用户的私有仓库的问题列表。

• 自动完成问题标题、标签和问题参与者。

• 使用Markdown作为问题默认语法，同时用户也可以选择其他语法。

安装

在Package Control频道中搜索GitHubIssue。安装后，您需要重新启动Sublime Text。

配置

设置

• 打开首选项 -> 软件包设置 -> Github Issue

• 打开设置 - 用户

• 设置 - 默认中有一个示例配置

• 有十个选项可供选择

{
    "token": "",
    "username": "",
    "password": "",
    "debug": 0,
    "syntax": "Packages/Markdown/Markdown.sublime-syntax",
    "wrap_width": 80,
    "draw_centered": true,
    "split_line_width": 0,
    "issue_title_completion": true,
    "user_completion": true,
    "label_completion": true,
    "commit_completion": true,
    "commit_completion_trigger": "&",
    "disable_vintageous": true
}

身份验证

Token是指GitHub访问令牌，您可以从此链接获取一个。

注意！为了有一个可用的Token，在生成Token时选择以下范围会比较安全：

• admin:org_hook,

• admin:public_key,

• admin:repo_hook,

• gist,

• notifications,

• repo

如果您发现上述列表中没有一项范围，插件也可以正常运行，请提交一个问题。在测试后，我会修改范围列表。

另外，您也可以使用密码（不建议，因为用户名和密码将以纯文本形式存储在配置文件中）。程序首先会查看是否设置了Token，如果没有Token，则会查看密码选项。

总结来说，用户名始终是必需的，密码和令牌是可选的，但至少要提供其中一个。

自定义

• “语法”是您在问题查看中首选的Markdown语法。

• “wrap_width”与preference.sublime-settings中的“wrap_width”相同，但限制在问题视图中，默认值80。

• “draw_centered”与preferences.sublime-settings中的“draw_centered”相同，但也限制在问题视图中，默认值：False。

• “split_line_width”是分割线的宽度。默认值是0，表示与wrap_width相同。

自动完成

GitHubIssue提供了一系列自动完成选项

• “issue_title_completion”、“user_completion”和“label_completion”是自动完成标志

• “issue_title_completion”自动完成其他问题标题，使用户能够轻松引用它们；

• “user_completion”自动完成问题参与者，使用户能够轻松@他们；

• “label_completion”自动完成标签（仅可在“##Label :”行中，通过@触发）。

• “commit_completion”：您输入提交信息时，会自动完成提交SHA。默认“true”。

• “commit_completion_trigger”是提交自动完成的触发器，默认值“&”。

杂项

• “debug”是标志，如果设置为1，则插件将打印每个步骤并在Sublime控制台中输出。通常应设置为0。

• “disable_local_repositories”：通常，GitHub Issue会使用git命令自动发现侧边栏上的github repos。如果不希望GitHub Issue这样做，请将该标志设置为true。默认值是false。

• “disable_vintageous”：如果将其设置为true，则问题列表也将显示在正常模式下。

安装此插件后，最好重启Sublime Text以使插件生效。

命令和快捷键

命令

所有命令均可通过命令面板运行，请查看Command Palette.sublime-commands并输入GithubIssue以获取更多有关可用命令的构想。

[
    {
        "caption": "GitHub Issue: Show Open Issues",
        "args": {"per_page": 30},
        "command": "show_github_issue_list"
    },
    {
        "caption": "GitHub Issue: Show All Issues",
        "args": {"state": "all", "per_page": 30},
        "command": "show_github_issue_list"
    },
    {
        "caption": "GitHub Issue: Show Issue",
        "args": {},
        "command": "show_github_issue"
    },
    {
        "caption": "GitHub Issue: Create Issue",
        "args": {},
        "command": "new_github_issue"
    },
    {
        "caption": "GitHub Issue: post/update Issue",
        "args": {},
        "command": "post_or_update_issue"
    },
    {
        "caption": "GitHub Issue: close/reopen Issue",
        "args": {},
        "command": "update_and_close_or_reopen_issue"
    },
]

快捷键

您可以定义自己的快捷键，但为方便起见，已预先定义了一些快捷键。

• 在问题列表视图中，按Enter可打开特定问题，按右/左箭头转到问题页面上下。

• 在问题列表视图中，按Ctrl + 右/左箭头可转到问题列表的最后一页/第一页。

• 在问题列表视图中，按Ctrl + r刷新打开的问题列表，按Ctrl + Shift + r刷新所有问题列表。

• 在问题视图中，按Super+S(Windows中为Ctrl+S)以同步当前问题或评论与GitHub

• 在问题视图中，您可以按Ctrl + shift + u切换打开/关闭问题。

插图

• 显示问题列表：

• 创建一个问题：

• 更新一个问题：

• 添加注释：

• 删除注释：

• 修改注释：

• 标签自动完成，如果标签不存在，则会自动创建。

• 提交、问题引用和其他参与者的自动完成。

变更日志

• 0.0.1：第一个公开版本，只有显示列表工作。

• 0.1.0：所有基本功能都工作。

• 1.0.0：添加消息、依赖，并准备加入Package Control通道。

• 1.1.0：添加特性，用户可以直接输入仓库信息并编写问题/评论。

• 1.2.0：添加日志系统并解决CRLF问题。

• 1.3.0：添加问题语法自定义和调整光标位置。

• 1.5.0：添加问题列表分页和页面查看控制。

• 1.6.0：添加基本标签支持。

• 2.0.0：添加自动完成支持。

• 2.1.0：添加问题标题保护并添加命令“post_or_update_issue”。

• 2.2.0：各种小改进。

• 2.3.0：添加提交自动完成。

• 2.5.0：重构。

• 2.6.0：在问题视图中添加链接列表结构，添加刷新列表选项，重新格式化问题和评论标题行。