gislacks

概述

这是一个适用于Sublime Text 3的插件，可以将文件提交到Gist和Slack。

描述

我喜欢使用Sublime Text进行脚本开发。当探讨脚本开发时，我经常使用Slack。当我将脚本提交到Slack时，我会将其保存到Gist作为备份。我在浏览器上手动做了这件事。也就是说，我想在我讨论Slack上的脚本时保存脚本的修订版本。有一天，我希望这个过程可以自动运行。所以，我创建了这个插件，以及gislack的CLI工具。

我最初是为自己创建并使用这个的，最近，我想这可能对其他开发者也有帮助。所以我发布了它。如果你觉得这个有用，我会很高兴。

通过这种方式，为Google Apps Script（GAS）的开发本地环境变得更加方便。

特性

1. 同时提交文件到Gist和Slack。

2. 上传、获取和更新Gist的文件。

3. 上传和获取Slack的文件。

4. 从客户端ID和客户端密钥检索Gist和Slack的访问令牌。

演示

这是一个使用Sublime Text将用CoffeeScript编写的GAS提交到Gist和Slack的演示。你可以确认上传到gist的脚本版本会增加。Google Apps Script是通过ggsrun运行的。

如何安装

此插件由以下两个工具构建。

1. 安装gislacks

这是一个Sublime Text 3的插件。

此插件发布在https://packagecontrol.sublime.net.cn/packages/gislacks。

1. 启动Sublime Text
2. 首选项 -> 包管理器 -> 包管理器：安装包
3. 选择gislacks

如果你想安装仓库目录，可以使用以下流程。

1. 通过ctrl+shift+p（Windows，Linux）或cmd+shift+p（OS X）打开包管理器
2. 在Package Control中选择“添加仓库”。
3. 输入https://github.com/tanaikech/gislacks。这是GitHub上的gislacks仓库。
4. 在Package Control中选择“安装包”。
5. 找到gislacks并选择它。这样，gislacks就被安装在您的Sublime Text 3上了。

2. 安装gislack

这是一个CLI工具，是Sublime Text与Gist、Slack之间的接口。

从发布页面下载gislack的可执行文件，并将其导入带路径的目录。

或

使用go get。

$ go get -u github.com/tanaikech/gislack

如果您想在您的PC上编译此工具，请也获取一个库https://github.com/tanaikech/getcode。

获取客户ID和客户密钥

为了使用gislacks插件，首先，请从GitHub和Slack获取客户ID和客户密钥。

1. Gist（GitHub）

1. 登录GitHub。
2. 打开开发者应用页面。https://github.com/settings/developers
3. 点击注册新应用按钮。
4. 输入应用名称、主页URL、应用描述、授权回调URL。授权回调URL是http://localhost:8080。
5. 信息输入完成后，点击“注册应用”。
6. 复制客户ID和客户密钥。

2. Slack

1. 登录Slack。
2. 打开您的应用页面。https://api.slack.com/apps
3. 点击创建新应用按钮。
4. 输入应用名称和开发Slack团队。
5. 信息输入完成后，点击“创建应用”。
6. 点击左侧的OAuth & Permissions或“添加功能”下的权限。
7. 点击添加新的重定向URL。
8. 输入新的重定向URL为http://localhost:8080。
9. 点击“保存URL”
10. 点击左侧的基本信息。
11. 在应用凭据处复制客户ID和客户密钥。当你看到客户密钥时，请点击显示按钮。

用法

1. gislacks.sublime-settings

首先，请在“首选项”->“包设置”->“gislacks”->“设置-用户”中修改gislacks.sublime-settings。然后请通过“文件”->“打开文件夹”打开您的工作文件夹。工作文件夹用作从Gist和Slack保存文件的存储位置。

// gislack default settings.
//
{
    // Path of gislack which is an execution file made by golang.
    // If gislack is put in defined path, it is not necessary to set this.
    "gislack_path": "",

    // Path of gislack.cfg. If you want to use gislack.cfg at except for current working directory, please use this.
    // If gislack.cfg is put in current working directory, it is not necessary to set this.
    // This path is used with the highest priority.
    "gislack_cfgpath": "",

    // This parameter is used for submitting to Gist. When you want to submit a file to Gist as public,
    // please modify this parameter to "true". Default is false. So your file is submitted as private.
    "gist_public": false,

    // Channel on Slack. This is a channel name you want to submit.
    // For channel name, the top `#` is not required.
    "slack_channel": "general",
}

2. 授权

作为下一步操作，请使用每个客户ID和客户密钥从Gist（GitHub）和Slack获取访问令牌。

如果您想使用此插件获取每个访问令牌，请参考这里。

通过终端授权

1. 启动您的终端。
2. 运行以下代码。请为GitHub和Slack运行以下命令。

对于Gist（GitHub）

$ gislack auth -gi [client ID of GitHub] -gs [client secret of Github]

对于Slack

$ gislack auth -si [client ID of Slack] -ss [client secret of Slack]

上述流程与GitHub和Slack相同。

• 运行上述代码后，浏览器将启动并等待登录GitHub（或Slack）。
• 请登录GitHub（或Slack）。
• 打开授权页面。如果出现授权按钮，请进行授权。如果看不到按钮，将打开一个包含授权码的页面。
• 授权码可以自动检索。并且您的终端上会显示Done。
  • 如果您的浏览器没有启动或者在授权等待30秒后，它将变成输入工作队列。这是手动模式。请复制显示的URL并将其粘贴到您的浏览器中，然后在GitHub（或Slack）上登录。浏览器上将显示授权码。请在输入工作队列期间将授权码复制并粘贴到您的终端中。如果您在浏览器中找不到授权码，请检查您的浏览器URL。
• 当您的终端上显示Done时，授权完成，并在您当前所在的目录中创建了一个gislack.cfg文件。（如果您将cfgdirectory设置为选项，则将在cfgdirectory设置的目录中创建一个gislack.cfg文件。）
• 为gislack.cfg设置的目录优先级如下。
  1. 选项 --cfgdirectory=##### 或 -cfgdir #####。
  2. 环境变量：GISLACK_CFG_PATH（例如，您可以将以下内容写入.bashrc中：export GISLACK_CFG_PATH=#####。）
  3. 当前工作目录。

从GitHub和Slack检索的访问令牌没有时间限制。因此，授权过程只需要进行一次。

恭喜！在这里，使用gislacks的准备已完成。

3. 如何使用gislacks插件从Sublime Text提交文件

以下说明适用于使用gislacks插件的Sublime Text 3。 为了防止误用快捷键，不能在Sublime Text中使用删除命令。

如果以下快捷键复制到您的环境中，请修改Default (Windows).sublime-keymap、Default (OSX).sublime-keymap或Default (Linux).sublime-keymap。

• **1*：当您将文件提交到两者时。完成第一次提交后，文件名将从原始名称更改为包含gist ID的名称。此插件将使用此gist ID更新gist。请不要担心。原始文件不会被删除。
• **2*：在Sublime Text中，无法将多个文件上传为gist。如果您想将多个文件作为gist上传，请使用终端上的gislack。
• **3*：在Sublime Text中，无法打开包含多个文件的gist。如果您想要获取包含多个文件的gist，请使用终端上的gislack。

如果您想在终端上提交您的文件，您可以使用CLI工具的gislack。

其他演示

获取Gist并更新它

通过ctrl + alt + t（Windows、Linux）或cmd + option + t（OS X）打开gists列表。当您从中选择一个时，所选的gist将在Sublime Text中打开。修改文件后，通过ctrl + alt + y（Windows、Linux）或cmd + option + y（OS X）使用修改后的文件更新所选的gist。

此演示的流程如下。

1. 检索一个Gist。
2. 检索另一个Gist。
3. 运行Gist。
4. 修改检索到的Gist。
5. 运行修改后的Gist。
6. 上传修改后的Gist。
7. 从Gist的历史中检索一个版本。
8. 运行检索到的Gist。

获取Slack文件

通过 ctrl + alt + i（Windows，Linux）或 cmd + option + i（OS X）打开Slack文件列表。选择其中一个时，选定的文件将在Sublime Text中打开。对于Slack，文件无法更新。

此演示的流程如下。

1. 从Slack中检索文件。
2. 运行文件
3. 上传文件。

参考文献

APIs

• Gist API 文档 https://developer.github.com/v3/gists/
• Slack API 文档 https://api.slack.com/methods

通过JSON控制 gislack

gislack 可以通过JSON数据来控制。这样可以用 gislack 除了Sublime Text以外的应用程序。JSON参数可以在 https://github.com/tanaikech/gislack 的 handler.go 文件中的 useJSON() 方法中看到。

更新历史

• v1.0.0（2017年6月22日）

  初始发布。

• v1.0.1（2017年6月22日）

  修改了快捷键绑定。

• v1.0.2（2017年6月23日）

  增加了将文件提交到Gist的公开选项。

TOP