介绍
hubot-ignore 是一个用于 Hubot [1] 的 npm 包,它允许用户在聊天室中快速屏蔽不想看到的消息。用户可以直接输入关键词或者使用正则表达式来过滤消息。
本文将会介绍 hubot-ignore 的安装、配置及使用方法,并提供一些示例代码以便读者更好的理解。
安装
首先需要全局安装 Yeoman 和 generator-hubot:
npm install -g yo generator-hubot
然后在一个空的目录中生成一个新的 Hubot:
mkdir myhubot cd myhubot yo hubot
此时会出现一些询问,按照提示一步步进行即可。
安装完毕后,在项目目录下运行以下命令安装 npm 包 hubot-ignore:
npm install hubot-ignore --save
配置
在 Hubot 的 external-scripts.json
文件中添加 hubot-ignore:
[ "hubot-ignore" ]
hubot-ignore 的默认配置为:
"ignore": []
可以在启动 Hubot 时添加环境变量 HUBOT_IGNORE
,以更改默认配置。
使用方法
hubot-ignore 提供两种过滤方式:关键词和正则表达式。
关键词
用户可以通过发送以下命令来添加、删除或查看关键词:
Hubot ignore add <word> - 添加一个关键词 Hubot ignore del <word> - 删除一个关键词 Hubot ignore list - 查看所有关键词
正则表达式
用户可以通过以下格式来添加、删除或查看正则表达式:
Hubot ignore regex add <regex> - 添加一个正则表达式 Hubot ignore regex del <regex> - 删除一个正则表达式 Hubot ignore regex list - 查看所有正则表达式
示例代码
以下是一个实际应用的示例代码,它让 Hubot 从聊天室中过滤出所有和“Hello”有关的消息:
-- -------------------- ---- ------- -------------- - --------------- - ------------------- ------------- - --- ------- - ------------- -- ----------------------------- - ---------------------------- ------- ----------- - - --------- - ---- -- ------------------------- - ----------------- --- --- ------- - --- --
总结
通过本文,读者了解了 npm 包 hubot-ignore 的安装、配置及使用方法,并通过示例代码实际应用了这个包。希望此文能够对读者有所帮助,使其在实际应用中更好地使用 hubot-ignore。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600672673660cf7123b36583