hubot 3.3.2 → 3.5.0

package/.github/workflows/nodejs-macos.yml

@@ -0,0 +1,26 @@
+name: Node.js (macOS) CI
+
+on:
+  push:
+    branches: [ "master" ]
+  schedule:
+    - cron:  '5 4 * * 0'
+
+jobs:
+  npm-test:
+
+    runs-on: macos-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm ci
+    - run: npm test

package/.github/workflows/nodejs-ubuntu.yml

@@ -0,0 +1,28 @@
+name: Node.js (Ubuntu) CI
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+  schedule:
+    - cron:  '5 4 * * 0'
+
+jobs:
+  npm-test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [14.x, 16.x, 18.x, latest]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm ci
+    - run: npm test

package/.github/workflows/nodejs-windows.yml

@@ -0,0 +1,26 @@
+name: Node.js (Windows) CI
+
+on:
+  push:
+    branches: [ "master" ]
+  schedule:
+    - cron:  '5 4 * * 0'
+
+jobs:
+  npm-test:
+
+    runs-on: windows-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm ci
+    - run: npm test

package/.github/workflows/release.yml

@@ -0,0 +1,36 @@
+name: Release
+on:
+  push:
+    branches:
+      - master
+permissions:
+  contents: read
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      issues: write
+      pull-requests: write
+      id-token: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: "lts/*"
+      - name: Install Dependencies
+        run: npm clean-install
+      - name: Verify the integrity of provenance attestations and registry signatures for installed dependencies
+        run: npm audit signatures
+      - name: Run Tests
+        run: npm test
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npx semantic-release

package/.node-version

@@ -0,0 +1 @@
+18.16.0

package/README.md

@@ -1,4 +1,6 @@
-[![Build Status](https://travis-ci.org/hubotio/hubot.svg?branch=master)](https://travis-ci.org/hubotio/hubot) [![Coverage Status](https://coveralls.io/repos/github/hubotio/hubot/badge.svg?branch=master)](https://coveralls.io/github/hubotio/hubot?branch=master)
+![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)
 
 # Hubot
 
@@ -13,8 +15,7 @@ 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)
 
-If you'd like to chat with Hubot users and developers, [join us on Slack](https://hubot-slackin.herokuapp.com/).
-
 ## License
 
 See the [LICENSE](LICENSE.md) file for license rights and limitations (MIT).
+`

package/bin/hubot

@@ -3,7 +3,7 @@
 # While all other files have been converted to JavaScript via https://github.com/github/hubot/pull/1347,
 # we left the `bin/hubot` file to remain in CoffeeScript in order prevent
 # breaking existing 3rd party adapters of which some are still written in
-# CoffeeScript themselves. We will depracate and eventually remove this file
+# CoffeeScript themselves. We will deprecate and eventually remove this file
 # in a future version of hubot
 
 require './hubot.js'

package/bin/hubot.js

@@ -23,7 +23,7 @@ const options = {
   adapter: process.env.HUBOT_ADAPTER || 'shell',
   alias: process.env.HUBOT_ALIAS || false,
   create: process.env.HUBOT_CREATE || false,
-  enableHttpd: process.env.HUBOT_HTTPD || true,
+  enableHttpd: process.env.HUBOT_HTTPD !== 'false',
   scripts: process.env.HUBOT_SCRIPTS || [],
   name: process.env.HUBOT_NAME || 'Hubot',
   path: process.env.HUBOT_PATH || '.',
@@ -80,10 +80,6 @@ Parser.on((opt, value) => {
 
 Parser.parse(process.argv)
 
-if (process.platform !== 'win32') {
-  process.on('SIGTERM', () => process.exit(0))
-}
-
 if (options.create) {
   console.error("'hubot --create' is deprecated. Use the yeoman generator instead:")
   console.error('    npm install -g yo generator-hubot')

package/docs/adapters/development.md

@@ -6,43 +6,40 @@ permalink: /docs/adapters/development/
 
 ## Adapter Basics
 
-All adapters inherit from the Adapter class in the `src/adapter.coffee` file.  If you're writing your adapter in CoffeeScript, require the primary version of the adapter:
-
-```coffee
-Adapter = require('hubot').Adapter
-```
+All adapters inherit from the Adapter class in the `src/adapter.js` file.
 
 If you're writing your adapter in ES2015, you must require the ES2015 entrypoint instead:
 
-```js
+```javascript
 const Adapter = require('hubot/es2015').Adapter;
 ```
 
 There are certain methods that you will want to override.  Here is a basic stub of what an extended Adapter class would look like:
 
-```coffee
-class Sample extends Adapter
-
-  constructor: ->
-    super
-    @robot.logger.info "Constructor"
-
-  send: (envelope, strings...) ->
-    @robot.logger.info "Send"
-
-  reply: (envelope, strings...) ->
-    @robot.logger.info "Reply"
-
-  run: ->
-    @robot.logger.info "Run"
-    @emit "connected"
-    user = new User 1001, name: 'Sample User'
-    message = new TextMessage user, 'Some Sample Message', 'MSG-001'
-    @robot.receive message
-
-
-exports.use = (robot) ->
-  new Sample robot
+```javascript
+const Adapter = require('../adapter')
+const User = require('../user')
+const TextMessage = require('../message').TextMessage
+class Sample extends Adapter {
+    constructor(robot) {
+        super(robot)
+        this.robot.logger.info('Constructor')
+    }
+    send(envelope, ...strings) {
+        this.robot.logger.info('Send')
+    }
+    reply(envelope, ...strings) {
+        this.robot.logger.info('Reply')
+    }
+    run() {
+        this.robot.logger.info('Run')
+        this.emit('connected')
+        const user = new User(1001, 'Sample User')
+        const message = new TextMessage(user, 'Some Sample Message', 'MSG-001')
+        this.robot.receive(message)
+    }
+}
+exports.use = (robot) => new Sample(robot)
 ```
 
 ## Setting Up Your Development Environment
@@ -76,16 +73,18 @@ exports.use = (robot) ->
 
 ## Gotchas
 
-There is a an open issue in the node community around [npm linked peer dependencies not working](https://github.com/npm/npm/issues/5875).  To get this working for our project you will need to do some minor changes to your code.
+There is a an open issue in the node community around [npm linked peer dependencies not working](https://github.com/npm/npm/issues/5875). To get this working for our project you will need to do some minor changes to your code.
 
 1. For the import in your `hubot-sample` adapter, add the following code
 
-  ```coffee
-  try
-    {Robot,Adapter,TextMessage,User} = require 'hubot'
-  catch
-    prequire = require('parent-require')
-    {Robot,Adapter,TextMessage,User} = prequire 'hubot'
+  ```javascript
+  let  {Robot,Adapter,TextMessage,User} = {}
+  try {
+    {Robot,Adapter,TextMessage,User} = require('hubot')
+  } catch {
+    const prequire = require('parent-require')
+    {Robot,Adapter,TextMessage,User} = prequire('hubot')
+  }
   ```
 2. In your `hubot-sample` folder, modify the `package.json` to include the following dependency so this custom import mechanism will work
 

package/docs/deploying/windows.md

@@ -8,16 +8,16 @@ Hasn't been fully tested - YMMV
 
 There are 4 primary steps to deploying and running hubot on a Windows machine:
 
-  * node and npm
-  * a way to get source code updated on the server
-  * setting up environment variables for hubot
-  * a way to start hubot, start it up if it crashes, and restart it when code updates
+* node and npm
+* a way to get source code updated on the server
+* setting up environment variables for hubot
+* a way to start hubot, start it up if it crashes, and restart it when code updates
 
 ## node and npm
 
 To start, your windows server will need node and npm.
 The best way to do this is with [chocolatey](http://chocolatey.org) using the [nodejs.install](http://chocolatey.org/packages/nodejs.install) package.
-I've found that sometimes the system path variable is not correctly set; ensure you can run node/npm from the command line. If needed set the PATH variable with "setx PATH \"%PATH%;C:\Program Files\nodejs\" "
+I've found that sometimes the system path variable is not correctly set; ensure you can run node/npm from the command line. If needed set the PATH variable with `set PATH=%PATH%;\"C:\Program Files\nodejs\"`
 
 Your other option is to install directly from [NodeJS](https://nodejs.org/) and run the current download (v0.12.4 as of this documentation). This should set your PATH variables for you.
 

package/docs/implementation.md

@@ -43,9 +43,7 @@ Furthermore, Hubot scripts exist to enable persistence across Hubot restarts.
 `hubot-redis-brain` is such a script and uses a backend Redis server.
 
 By default, the brain contains a list of all users seen by Hubot.
-Therefore, without persistence across restarts, the brain will contain the list of users encountered so far, during the current run of Hubot.
-On the other hand, with persistence across restarts, the brain will contain all users encountered by Hubot during all of its runs.
-This list of users can be accessed through `hubot.brain.users()` and other utility methods.
+Therefore, without persistence across restarts, the brain will contain the list of users encountered so far, during the current run of Hubot. On the other hand, with persistence across restarts, the brain will contain all users encountered by Hubot during all of its runs. This list of users can be accessed through `hubot.brain.users()` and other utility methods.
 
 ### Datastore
 

package/docs/index.md

@@ -44,15 +44,12 @@ You now have your own functional hubot! There's a `bin/hubot`
 command for convenience, to handle installing npm dependencies, loading scripts,
 and then launching your hubot.
 
-Hubot needs Redis to persist data, so before you can start hubot on your own computer, you should have Redis installed on your localhost. If just want to test Hubot without Redis, then you can remove `hubot-redis-brain` from `external-scripts.json`.
+Note: Hubot can use Redis to persist data, so before you can start hubot on your own computer, if you want to persist data, then you should have Redis running on your machine accessible via `localhost`. Then, ensure that `hubot-redis-brain` is listed in `external-scripts.json` as an `Array` of module names (e.g. `['hubot-redis-brain']`) or an `object` where the key is the name of the module (e.g. `{'hubot-redis-brain': 'some arbitrary value'}`) where the value of the property in the object is passed to the module function as the second argument. The first argument being the hubot Robot instance.
 
     % bin/hubot
     Hubot>
 
-This starts hubot using the [shell adapter](./adapters/shell.md), which
-is mostly useful for development. Make note of the name in the `hubot>` prompt;
-this is the name your hubot will respond to with commands. If the prompt
-reads `myhubot>` then your commands must start with `myhubot <command>`
+This starts hubot using the [shell adapter](./adapters/shell.md), which is mostly useful for development. Make note of the name in the `hubot>` prompt; this is the name your hubot will respond to with commands. If the prompt reads `myhubot>` then your commands must start with `myhubot <command>`.
 
 For example, to list available commands:
 
@@ -107,7 +104,7 @@ To use a script from an NPM package:
 2. Add the package to `external-scripts.json`.
 3. Run `npm home <package-name>` to open a browser window for the homepage of the script, where you can find more information about configuring and installing the script.
 
-You can also put your own scripts under the `scripts/` directory. All scripts placed there are automatically loaded and ready to use with your hubot. Read more about customizing hubot by [writing your own scripts](scripting.md).
+You can also put your own scripts under the `scripts/` directory. All scripts (files ending with either `.js` or `.mjs`) placed there are automatically loaded and ready to use with your hubot. Read more about customizing hubot by [writing your own scripts](scripting.md).
 
 ## Adapters
 
@@ -115,9 +112,7 @@ Hubot uses the adapter pattern to support multiple chat-backends. Here is a [lis
 
 ## Deploying
 
-You can deploy hubot to Heroku, which is the officially supported method.
-Additionally you are able to deploy hubot to a UNIX-like system or Windows.
-Please note the support for deploying to Windows isn't officially supported.
+You can deploy hubot to Heroku, which is the officially supported method. Additionally you are able to deploy hubot to a UNIX-like system or Windows. Please note the support for deploying to Windows isn't officially supported.
 
 * [Deploying Hubot onto Azure](./deploying/azure.md)
 * [Deploying Hubot onto Bluemix](./deploying/bluemix.md)
@@ -127,4 +122,4 @@ Please note the support for deploying to Windows isn't officially supported.
 
 ## Patterns
 
-Using custom scripts, you can quickly customize Hubot to be the most life embettering robot he or she can be. Read [docs/patterns.md](patterns.md) for some nifty tricks that may come in handy as you teach your hubot new skills.
+Using custom scripts, you can quickly customize Hubot to be the most life embettering robot he or she can be. Read [docs/patterns.md](patterns.md) for some nifty tricks that may come in handy as you teach your hubot new skills.