Hubot 生成器使用指南

Hubot 生成器使用指南

generator-hubotHubot generator for Yeoman项目地址:https://gitcode.com/gh_mirrors/ge/generator-hubot

1. 项目的目录结构及介绍

generator-hubot/
├── generators/
│   └── app/
│       ├── templates/
│       │   ├── bin/
│       │   │   └── hubot
│       │   ├── scripts/
│       │   │   └── example.coffee
│       │   ├── .gitignore
│       │   ├── .npmignore
│       │   ├── external-scripts.json
│       │   ├── hubot-scripts.json
│       │   ├── package.json
│       │   └── README.md
│       ├── index.js
│       └── package.json
├── test/
│   └── app.js
├── .gitattributes
├── .gitignore
├── .yo-rc.json
├── LICENSE
├── README.md
├── package-lock.json
└── package.json

目录结构介绍

• generators/app/: 包含生成器的主要逻辑和模板文件。
  • templates/: 包含生成的 Hubot 项目的模板文件。
    • bin/: 包含启动 Hubot 的脚本。
    • scripts/: 包含示例脚本。
    • .gitignore: Git 忽略文件。
    • .npmignore: npm 忽略文件。
    • external-scripts.json: 外部脚本配置文件。
    • hubot-scripts.json: Hubot 脚本配置文件。
    • package.json: npm 包配置文件。
    • README.md: 项目说明文档。
  • index.js: 生成器的主逻辑文件。
  • package.json: 生成器的 npm 包配置文件。
• test/: 包含生成器的测试文件。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件。
• .yo-rc.json: Yeoman 配置文件。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• package-lock.json: npm 锁定文件。
• package.json: 项目的 npm 包配置文件。

2. 项目的启动文件介绍

在 generators/app/templates/bin/ 目录下，有一个名为 hubot 的启动文件。这个文件是用来启动 Hubot 实例的脚本。

启动文件内容

#!/bin/sh

set -e

if [ -z "$HUBOT_SLACK_TOKEN" ]; then
  echo "Missing HUBOT_SLACK_TOKEN environment variable"
  exit 1
fi

exec node_modules/.bin/hubot --adapter slack

启动文件介绍

• #!/bin/sh: 指定脚本解释器为 sh。
• set -e: 如果命令执行失败，脚本会立即退出。
• if [ -z "$HUBOT_SLACK_TOKEN" ]; then: 检查是否设置了 HUBOT_SLACK_TOKEN 环境变量。
• echo "Missing HUBOT_SLACK_TOKEN environment variable": 如果没有设置，输出错误信息。
• exit 1: 如果没有设置，脚本退出。
• exec node_modules/.bin/hubot --adapter slack: 使用 hubot 命令启动 Hubot，并指定使用 Slack 适配器。

3. 项目的配置文件介绍

package.json

package.json 文件位于 generators/app/templates/ 目录下，是 npm 包的配置文件。

{
  "name": "hubot",
  "version": "1.0.0",
  "private": true,
  "description": "A simple helpful robot for your Company",
  "main": "index.js",
  "scripts": {
    "start": "bin/hubot --adapter slack"
  },
  "dependencies": {
    "hubot": "^3.3.2",
    "hubot-slack": "^4.7.1"
  }
}

配置文件介绍

• name: 项目名称。
• version: 项目版本。
• private: 标记项目为私有。
• description: 项目描述。
• main:

generator-hubotHubot generator for Yeoman项目地址:https://gitcode.com/gh_mirrors/ge/generator-hubot