简介
Hubot 是目前最流行的聊天机器人框架，它支持多种途径的交互方式，比如 Slack、HipChat、Telegram 等。hubot-source 是一个用于从 Git 仓库中读取数据并在 Hubot 机器人中显示的库，可以方便开发者将文本数据发布到 Git 仓库中，并通过 Hubot 机器人进行访问和查询。
安装
在 Node.js 环境下，安装 hubot-source 包可以使用 npm 命令进行安装：
$ npm install hubot-source --save
或者使用 yarn 命令进行安装：
$ yarn add hubot-source
使用
配置
在 Hubot 机器人的运行环境中，配置一个名为 HUBOT_SOURCE_DIR 的环境变量，它指定了 Git 仓库在本地的存储路径。
另外还可以配置一个名为 HUBOT_SOURCE_GIT_URL 的环境变量，它指定了 Git 仓库的远程地址。如果没有设置该环境变量，则默认将会从 HUBOT_SOURCE_DIR 目录下的远程 origin 获取数据。
例如，在 shell 脚本中设置 HUBOT_SOURCE_DIR 和 HUBOT_SOURCE_GIT_URL 环境变量：
export HUBOT_SOURCE_DIR=/data/hubot-source export HUBOT_SOURCE_GIT_URL=https://github.com/example/hubot-source.git
操作
hubot-source 提供了 Hubot 机器人与 Git 仓库进行交互的一些命令。这些命令包括：
- source add：在 Git 仓库中添加一条数据，并在 Hubot 机器人中指定名称
- source del：从 Git 仓库中删除一个已有的数据，并在 Hubot 机器人中指定名称
- source get：从 Git 仓库中获取一条已有的数据，并在 Hubot 机器人中显示它的内容
- source list：列出 Git 仓库中所有已有的数据，并在 Hubot 机器人中显示它们的名称
这些命令可以通过 robot.respond 进行监听，例如:
-- -------------------- ---- -------
-------------- - --------------- -
--------------------- --- ----------- ------------- -
--- ----- - -------------
--- ------- - -------------
--- ------ - --------------------
--------------------
---
--------------------- --- ------ ------------- -
--- ----- - -------------
--- ------ - --------------------
-------------
---
--------------------- --- ------ ------------- -
--- ----- - -------------
--- ------ - --------------------
------------------------ ----- -
-- ----- -
---------------
- ---- -
---------------
-
---
---
--------------------- ------ ------------- -
--- ----- - -------------
--- ------- - -------------------
--- ------- - --------- --
--- ---- - - -- - - --------------- ---- -
------- -- ---------------- - -- --
-
------------------
---
-在命令监听函数中，可以通过调用 robot.source 和 robot.sourceList 来获取相应的数据源。接下来的操作就是通过 Git API 来对数据源进行操作了。
示例
假设我们已经配置好了 Git 仓库的相关信息，下面演示一个简单的例子：将一个名为 greeting 的问候语添加到 Git 仓库中，并通过 Hubot 机器人进行访问。
首先，添加一条问候语到 Git 仓库中：
hubot source add greeting=hello!
然后，通过 Hubot 机器人访问这条问候语：
hubot source get greeting
输出结果为:
hello!
最后，删除这条问候语：
hubot source del greeting
总结
通过使用 hubot-source 包，我们可以将一些文本数据存储到 Git 仓库中，并通过 Hubot 机器人进行查询和访问。在实际开发中，我们可以将一些常用的数据（比如常用的链接、说明文档等）存储到 Git 仓库中，从而方便地获取和管理这些数据。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055cef81e8991b448da8bf