hubot 9.0.2 → 9.1.1

package/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2011-2017 GitHub Inc.
+Copyright (c) 2011-2023 GitHub Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

package/README.md

@@ -1,3 +1,5 @@
+![Pipeline Status](https://github.com/hubotio/hubot/actions/workflows/pipeline.yml/badge.svg)
+
 ![Build Status: MacOS](https://github.com/hubotio/hubot/actions/workflows/nodejs-macos.yml/badge.svg)
 ![Build Status: Ubuntu](https://github.com/hubotio/hubot/actions/workflows/nodejs-ubuntu.yml/badge.svg)
 ![Build Status: Window](https://github.com/hubotio/hubot/actions/workflows/nodejs-windows.yml/badge.svg)
@@ -5,16 +7,26 @@
 # Hubot
 
 Hubot is a framework to build chat bots, modeled after GitHub's Campfire bot of the same name, hubot.
-He's pretty cool. He's [extendable with scripts](http://hubot.github.com/docs/#scripts) and can work
-on [many different chat services](https://hubot.github.com/docs/adapters/).
+He's pretty cool. He's [extendable with scripts](https://hubotio.github.io/hubot/docs#scripts) and can work
+on [many different chat services](https://hubotio.github.io/hubot/adapters.html).
 
 This repository provides a library that's distributed by `npm` that you
-use for building your own bots.  See the [documentation](http://hubot.github.com/docs)
+use for building your own bots.  See the [documentation](https://hubotio.github.io/hubot/docs.html)
 for details on getting up and running with your very own robot friend.
 
 In most cases, you'll probably never have to hack on this repo directly if you
 are building your own bot. But if you do, check out [CONTRIBUTING.md](CONTRIBUTING.md)
 
+# Create your own Hubot instance
+
+This will create a directory called `myhubot` in the current working directory.
+
+```sh
+npx hubot --create myhubot --adapter @hubot-friends/hubot-slack
+```
+
+Review `scripts/example.mjs`. Create more scripts in the `scripts` folder.
+
 ## License
 
 See the [LICENSE](LICENSE.md) file for license rights and limitations (MIT).

package/bin/hubot.js

@@ -6,6 +6,7 @@ const pathResolve = require('path').resolve
 const OptParse = require('optparse')
 
 const Hubot = require('..')
+const create = require('../src/GenHubot.js')
 
 const switches = [
   ['-a', '--adapter HUBOT_ADAPTER', 'The Adapter to use, e.g. "shell" (to load the default hubot shell adapter)'],
@@ -86,14 +87,11 @@ Parser.on((opt, value) => {
 Parser.parse(process.argv)
 
 if (options.create) {
-  console.error("'hubot --create' is deprecated. Use the yeoman generator instead:")
-  console.error('    npm install -g yo generator-hubot')
-  console.error(`    mkdir -p ${options.path}`)
-  console.error(`    cd ${options.path}`)
-  console.error('    yo hubot')
-  console.error('See https://github.com/github/hubot/blob/main/docs/index.md for more details on getting started.')
-  process.exit(1)
+  options.hubotInstallationPath = process.env.HUBOT_INSTALLATION_PATH ?? 'hubot'
+  create(options.path, options)
+  process.exit(0)
 }
+
 if (options.file) {
   options.adapter = options.file.split('/').pop().split('.')[0]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hubot",
-  "version": "9.0.2",
+  "version": "9.1.1",
   "author": "hubot",
   "keywords": [
     "github",
@@ -24,7 +24,6 @@
     "pino": "^8.11.0"
   },
   "devDependencies": {
-    "semantic-release": "^21.0.1",
     "standard": "^17.1.0"
   },
   "engines": {
@@ -37,10 +36,13 @@
   },
   "scripts": {
     "start": "bin/hubot",
+    "gen": "bin/hubot --create myhubot",
     "pretest": "standard",
     "test": "node --test",
     "test:smoke": "node src/**/*.js",
-    "test:e2e": "bin/e2e-test.sh"
+    "test:e2e": "bin/e2e-test.sh",
+    "build:local": "npx @hubot-friends/sfab --folder ./docs --destination ./_site --verbose --serve /hubot/ --watch-path ./docs --scripts ./sfab-hooks",
+    "build": "npx @hubot-friends/sfab --folder ./docs --destination ./_site --verbose --scripts ./sfab-hooks"
   },
   "release": {
     "branches": [

package/sfab-hooks/SfabHook.mjs

@@ -0,0 +1,11 @@
+export default () => {
+  return {
+    model (file, model) {
+      return {
+        base: {
+          href: '/hubot/'
+        }
+      }
+    }
+  }
+}

package/src/GenHubot.js

@@ -0,0 +1,88 @@
+const { spawnSync } = require('child_process')
+const File = require('fs')
+const path = require('path')
+
+function runCommands (hubotDirectory, options) {
+  options.hubotInstallationPath = options?.hubotInstallationPath ?? 'hubot'
+  console.log('creating hubot directory', hubotDirectory)
+  try {
+    spawnSync('mkdir', [hubotDirectory])
+  } catch (error) {
+    console.log(`${hubotDirectory} exists, continuing to the next operation.`)
+  }
+  const envFilePath = path.resolve(process.cwd(), '.env')
+  process.chdir(hubotDirectory)
+
+  spawnSync('npm', ['init', '-y'])
+  spawnSync('npm', ['i', options.hubotInstallationPath].concat(options.adapter, 'hubot-help', 'hubot-rules', 'hubot-diagnostics'))
+  spawnSync('mkdir', ['scripts'])
+  spawnSync('touch', ['external-scripts.json'])
+
+  const externalScriptsPath = path.resolve('./', 'external-scripts.json')
+  let escripts = File.readFileSync(externalScriptsPath, 'utf8')
+  if (escripts.length === 0) escripts = '[]'
+  const externalScripts = JSON.parse(escripts)
+  externalScripts.push('hubot-help')
+  externalScripts.push('hubot-rules')
+  externalScripts.push('hubot-diagnostics')
+
+  File.writeFileSync(externalScriptsPath, JSON.stringify(externalScripts, null, 2))
+
+  File.writeFileSync('./scripts/example.mjs', `// Description:
+//   Test script
+//
+// Commands:
+//   hubot helo - Responds with Hello World!.
+//
+// Notes:
+//   This is a test script.
+//
+
+export default (robot) => {
+  robot.respond(/helo/, async res => {
+    await res.send('Hello World!')
+  })
+}`)
+
+  const packageJsonPath = path.resolve(process.cwd(), 'package.json')
+  const packageJson = JSON.parse(File.readFileSync(packageJsonPath, 'utf8'))
+
+  packageJson.scripts = {
+    start: 'hubot'
+  }
+  if (options.adapter) {
+    packageJson.scripts.start += ` --adapter ${options.adapter}`
+  }
+
+  File.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2))
+  console.log('package.json updated successfully.')
+  const hubotEnvFilePath = path.resolve('.env')
+
+  try {
+    File.accessSync(envFilePath)
+    File.copyFileSync(envFilePath, hubotEnvFilePath)
+    console.log('.env file copied successfully.')
+
+    const envContent = File.readFileSync(hubotEnvFilePath, 'utf8')
+    const envLines = envContent.split('\n')
+
+    for (const line of envLines) {
+      const trimmedLine = line.trim()
+
+      if (trimmedLine && !trimmedLine.startsWith('#')) {
+        const [key, ...values] = trimmedLine.split('=')
+        const value = values.join('=')
+        process.env[key] = value
+      }
+    }
+  } catch (error) {
+    console.log('.env file not found, continuing to the next operation.')
+  }
+}
+module.exports = (hubotDirectory, options) => {
+  try {
+    runCommands(hubotDirectory, options)
+  } catch (error) {
+    console.error('An error occurred:', error)
+  }
+}

package/src/robot.js

@@ -37,6 +37,7 @@ class Robot {
     this.brain = new Brain(this)
     this.alias = alias
     this.adapter = null
+    this.shouldEnableHttpd = httpd ?? true
     this.datastore = null
     this.Response = Response
     this.commands = []
@@ -55,18 +56,13 @@ class Robot {
     this.globalHttpOptions = {}
 
     this.parseVersion()
-    if (httpd) {
-      this.setupExpress()
-    } else {
-      this.setupNullRouter()
-    }
-
     this.adapterName = adapter ?? 'shell'
     this.errorHandlers = []
 
     this.on('error', (err, res) => {
       return this.invokeErrorHandlers(err, res)
     })
+    this.on('listening', this.herokuKeepalive.bind(this))
   }
 
   // Public: Adds a custom Listener with the provided matcher, options, and
@@ -407,8 +403,8 @@ class Robot {
 
   // Setup the Express server's defaults.
   //
-  // Returns nothing.
-  setupExpress () {
+  // Returns Server.
+  async setupExpress () {
     const user = process.env.EXPRESS_USER
     const pass = process.env.EXPRESS_PASSWORD
     const stat = process.env.EXPRESS_STATIC
@@ -444,27 +440,18 @@ class Robot {
     if (stat) {
       app.use(express.static(stat))
     }
-
-    try {
-      this.server = app.listen(port, address)
-      this.router = app
-    } catch (error) {
-      this.logger.error(`Error trying to start HTTP server: ${error}\n${error.stack}`)
-      throw error
-    }
-
-    let herokuUrl = process.env.HEROKU_URL
-
-    if (herokuUrl) {
-      if (!/\/$/.test(herokuUrl)) {
-        herokuUrl += '/'
-      }
-      this.pingIntervalId = setInterval(() => {
-        HttpClient.create(`${herokuUrl}hubot/ping`).post()((_err, res, body) => {
-          this.logger.info('keep alive ping!')
+    const p = new Promise((resolve, reject) => {
+      try {
+        this.server = app.listen(port, address, () => {
+          this.router = app
+          this.emit('listening', this.server)
+          resolve(this.server)
         })
-      }, 5 * 60 * 1000)
-    }
+      } catch (err) {
+        reject(err)
+      }
+    })
+    return p
   }
 
   // Setup an empty router object
@@ -645,6 +632,11 @@ class Robot {
   //
   // Returns whatever the adapter returns.
   async run () {
+    if (this.shouldEnableHttpd) {
+      await this.setupExpress()
+    } else {
+      this.setupNullRouter()
+    }
     this.emit('running')
 
     return await this.adapter.run()
@@ -712,6 +704,20 @@ class Robot {
 
     return HttpClient.create(url, httpOptions).header('User-Agent', `Hubot/${this.version}`)
   }
+
+  herokuKeepalive (server) {
+    let herokuUrl = process.env.HEROKU_URL
+    if (herokuUrl) {
+      if (!/\/$/.test(herokuUrl)) {
+        herokuUrl += '/'
+      }
+      this.pingIntervalId = setInterval(() => {
+        HttpClient.create(`${herokuUrl}hubot/ping`).post()((_err, res, body) => {
+          this.logger.info('keep alive ping!')
+        })
+      }, 5 * 60 * 1000)
+    }
+  }
 }
 
 module.exports = Robot