什么是 hubot-bikeshed？
hubot-bikeshed 是一个基于 Hubot 的 npm 包，它可以为你自动处理 Git commit message 和 GitHub PR 中针对代码风格的评论，自动生成代码规范，使得代码风格更加统一。
安装 hubot-bikeshed
使用 npm 包管理器进行安装：
npm install --save hubot-bikeshed
或者在 package.json 文件中添加依赖：
"dependencies": {
"hubot-bikeshed": "^1.0.0"
}配置与运行 hubot-bikeshed
配置
- 创建
.bikeshedrc文件，用于配置规则：
-- -------------------- ---- -------
-
-------- -
-
------- ------- ------- ------- ------
-------------- ------- ---- --- ------ ------- ------- ------ ---- --------- ---------
---------- ------------------
------- ------
---------- ------- ------- ------- ------ ----- ---- --------- --------
--
-
------- ------- ------- ---- ---- --------
-------------- ------- ---- --- ------ ------- ---- -- ------- -- -- -------------
---------- --------
------- ----
---------- ------- ------- ---- ------ -- ------- -- -- ------------
-
-
-- 配置 .env 文件，包含以下变量：
HUBOT_BIKESHED_ENABLED=true // 启用代码规范检查 HUBOT_BIKESHED_GITHUB_TOKEN=<Token> // GitHub 认证 Token HUBOT_GITHUB_USER=octocat // GitHub 用户名 HUBOT_GITHUB_REPO=Hello-World // GitHub 仓库名
运行
将以下内容添加到 external-scripts.json 文件中：
["hubot-bikeshed"]
并运行 Hubot：
$ bin/hubot
使用示例
生成代码规范文件
在 Hubot 聊天室内输入以下命令：
hubot bikeshed generate
这将为你生成代码规范文件，包含了所有配置文件中的规则。
手动触发代码规范检查
你可以手动触发代码规范检查，只需要在 PR 信息中添加 “bikeshed” 指令即可：
@octocat bikeshed
当 PR 信息中包含 “bikeshed” 指令，或者代码合并时，hubot-bikeshed 会自动对代码风格进行检查，并根据规则对各项代码元素进行赋分，并将结果反馈给你。
总结
通过对 npm 包 hubot-bikeshed 的学习，我们可以了解到其基于 Hubot 机器人来进行代码风格的检查，并可帮助用户简单有效地自动生成代码规范文件。如果我们在开发项目过程中，能够合理使用 hubot-bikeshed，就可以避免一些疏忽导致代码风格不规范的问题，从而提高代码质量。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6006735c890c4f7277583fd4