more details added 🚀🚀🚀

Author: JCMais

.env.sample

@@ -7,8 +7,12 @@
 # Bot name
 HUBOT_NAME=hubot
 
-# Required if using the default adapter which is slack
-HUBOT_SLACK_TOKEN=xoxb-YOUR-TOKEN-HERE 
+# Port the bot http server will read on
+PORT=3000
+
+# Required if using the slack adapter
+HUBOT_ADAPTER=slack
+HUBOT_SLACK_TOKEN=xoxb-YOUR-TOKEN-HERE
 
 # Following ones are optional, but great as their current values.
 

Dockerfile

@@ -19,12 +19,12 @@ FROM node:10-alpine
 
 WORKDIR /hubot/code
 
-ENV NODE_ENV production
-
 ARG PORT=3000
 
 ENV PORT ${PORT}
 
+ENV NODE_ENV production
+
 COPY --from=builder /app .
 
 EXPOSE ${PORT}

README.md

@@ -73,7 +73,15 @@ See https://github.com/mtsmfm/hubot-test-helper/issues/19
 
 There is no brain persister installed, it's your job to install one if needed.
 
+## How does the coffee script scripts can be run alongside typescript during development?
+
+They don't.
+
+There is a postinstall hook that calls the script [`tools/compile-coffee-deps.js`][tools/compile-coffee-deps.js]
+ which is responsible for compilling the dependencies .coffee files to pure .js.
+
 [robot.http]:https://hubot.github.com/docs/scripting/#making-http-calls
 [node-scoped-http-client]:https://github.com/technoweenie/node-scoped-http-client
 [hubot-test-helper]:https://github.com/mtsmfm/hubot-test-helper
 [example.spec.ts]: ./src/scripts/__tests__/example.spec.ts
+[tools/compile-coffee-deps.js]: ./tools/compile-coffee-deps.js

package.json

@@ -7,6 +7,7 @@
     "type": "git",
     "url": "git://github.com/JCMais/hubot-typescript-boilerplate.git"
   },
+  "private": true,
   "keywords": [
     "chatops",
     "hubot",
@@ -15,16 +16,20 @@
   ],
   "description": "ChatOps made easier",
   "dependencies": {
+    "@slack/client": "^4.8.0",
+    "@types/express": "^4.16.0",
     "@types/hubot": "^2.19.2",
+    "@types/ramda": "^0.25.41",
     "axios": "^0.18.0",
-    "coffeescript": "^2.3.2",
+    "coffeescript": "1.12.7",
     "cross-env": "^5.2.0",
     "hubot": "^3.1.1",
     "hubot-diagnostics": "^1.0.0",
     "hubot-help": "^1.0.1",
     "hubot-rules": "^1.0.0",
     "hubot-scripts": "^2.17.2",
-    "hubot-slack": "^4.5.5"
+    "hubot-slack": "^4.5.5",
+    "ramda": "^0.25.0"
   },
   "devDependencies": {
     "@types/jest": "^23.3.9",
@@ -50,14 +55,15 @@
   ],
   "scripts": {
     "start": "node  node_modules/hubot/bin/hubot.js --require ./build/scripts",
-    "dev": "dotenv -e .env ts-node -- node_modules/hubot/bin/hubot.js --require ./src/scripts",
+    "dev": "dotenv -e .env ts-node -- --files node_modules/hubot/bin/hubot.js --require ./src/scripts",
     "dev:watch": "nodemon",
     "clean": "rimraf build",
     "build": "yarn clean && tsc",
     "build:start": "yarn build && yarn start",
     "postinstall": "node ./tools/compile-coffee-deps.js && patch-package",
     "prepublishOnly": "yarn lint && yarn test && yarn build",
     "lint": "tslint --project tsconfig.json {src}/**/*.ts",
+    "prettier": "prettier --write src/**/*.ts",
     "test": "jest",
     "heroku-postbuild": "yarn build"
   }

prettier.config.js

@@ -1,5 +1,5 @@
 module.exports = {
-  semi: true,
+  semi: false,
   singleQuote: true,
   trailingComma: 'all',
 }

src/scripts/#1-startup.ts

@@ -0,0 +1,9 @@
+// Description:
+//   fs.readDir (method used by hubot to iterate over this dir)
+//    returns the files sorted on Node.js, so this script is going to be read first.
+//   That way you can use this as an startup script
+
+import { Robot } from 'hubot'
+import SlackAdapter from 'hubot-slack'
+
+module.exports = async function startup(robot: Robot<SlackAdapter>) {}

src/scripts/__tests__/example.spec.ts

@@ -1,34 +1,34 @@
-import Helper from 'hubot-test-helper';
-import mockAxios from 'jest-mock-axios';
+import Helper from 'hubot-test-helper'
+import mockAxios from 'jest-mock-axios'
 
-const helper = new Helper('../example.ts');
+const helper = new Helper('../example.ts')
 
-let room = (null as unknown) as ReturnType<typeof helper.createRoom>;
+let room = (null as unknown) as ReturnType<typeof helper.createRoom>
 
 beforeEach(() => {
   room = helper.createRoom({
     httpd: false,
-  });
+  })
 
   // cleaning up the mess left behind the previous test
-  mockAxios.reset();
-});
+  mockAxios.reset()
+})
 
 it('should work correctly when user posts a link', async function() {
-  const url = 'http://google.com';
+  const url = 'http://google.com'
 
-  await room.user.say('user1', url);
+  await room.user.say('user1', `hubot ${url}`)
 
   // we could just mock axios using jest itself, see https://github.com/knee-cola/jest-mock-axios/issues/3#issuecomment-369057670
-  mockAxios.mockResponse();
+  mockAxios.mockResponse()
 
-  await global.delay(10);
+  await global.delay(10)
 
-  expect(mockAxios.get).toHaveBeenCalledWith(url);
+  expect(mockAxios.get).toHaveBeenCalledWith(url)
 
   expect(room.messages).toEqual([
-    ['user1', 'http://google.com'],
+    ['user1', 'hubot http://google.com'],
     ['hubot', 'ok1: http://google.com'],
     ['hubot', 'ok2: http://google.com'],
-  ]);
-});
+  ])
+})

src/scripts/example.ts

@@ -16,18 +16,16 @@
 //
 // Author:
 //   JCMais
-import { Robot } from 'hubot';
-import axios from 'axios';
+import { Robot } from 'hubot'
+import axios from 'axios'
 
 module.exports = async function example(robot: Robot<{}>) {
-  robot.hear(/(http(?:s?):\/\/(\S*))/i, async res => {
-    const url = res.match[1];
-    res.send(`ok1: ${url}`);
+  robot.respond(/(http(?:s?):\/\/(\S*))/i, async res => {
+    const url = res.match[1]
+    res.send(`ok1: ${url}`)
 
-    res.send('Ok!')
+    await axios.get(url)
 
-    await axios.get(url);
-
-    res.send(`ok2: ${url}`);
-  });
-};
+    res.send(`ok2: ${url}`)
+  })
+}

src/scripts/health.ts

@@ -0,0 +1,8 @@
+// Description:
+//   Add /health endpoing that can be used for checking for bot health
+import { Robot } from 'hubot'
+import SlackAdapter from 'hubot-slack'
+
+module.exports = async function example(robot: Robot<SlackAdapter>) {
+  robot.router
+}

tools/compile-coffee-deps.js

@@ -1,48 +1,94 @@
 // This is necessary so we don't have coffeescript files being required
-const path = require('path');
-const fs = require('fs');
+const path = require('path')
+const fs = require('fs')
 const { execSync } = require('child_process')
 
-const scriptsToCheck = require('../external-scripts.json');
+const scriptsToCheck = require('../external-scripts.json')
 
-const cwd = path.join(__dirname, '..');
+const cwd = path.join(__dirname, '..')
 
-scriptsToCheck.forEach((npmModule) => {
+const getModulePackageJson = npmModule =>
+  path.join(cwd, 'node_modules', npmModule, 'package.json')
 
-  const packageJsonPath = path.join(cwd, 'node_modules', npmModule, 'package.json');
+const compileCoffeeFilesInsidePackage = npmModule => {
+  console.log(`Compilling .coffee files inside module ${npmModule}`)
+  try {
+    execSync(`yarn coffee -c node_modules/${npmModule}`, {
+      cwd,
+    })
+  } catch (err) {
+    console.error(
+      `Error while trying to compile coffee files on package ${npmModule}`,
+    )
+    console.error(err)
+    return false
+  }
+
+  return true
+}
+
+function compileSlackAdapter() {
+  console.log('Compilling .coffee files inside slack adapter')
+
+  const packageJsonPath = getModulePackageJson('hubot-slack')
 
   if (!fs.existsSync(packageJsonPath)) {
-    console.warn(`No package.json file found for hubot script package ${npmModule}.`)
-    console.warn(`If this package does exists you will have to compile the .coffee files on it by running:`)
-    console.warn(`yarn coffeescript -c node_modules/${npmModule}`)
-    return;
+    console.warn(`No package.json file found for hubot slack adapter.`)
+    console.warn(
+      `If this package does exists you will have to compile the .coffee files on it by running:`,
+    )
+    console.warn(`  $ yarn coffeescript -c node_modules/slack-adapter`)
+    console.warn(
+      `If you are not using that adapter you can safely ignore this warning and remove this call on:`,
+    )
+    console.warn(`  tools/compile-coffee-deps.js`)
+    return
   }
 
-  const packageJson = require(`${npmModule}/package.json`);
+  const hasCompiled = compileCoffeeFilesInsidePackage('hubot-slack')
 
-  const mainFile = path.parse(packageJson.main)
-  const ext = path.extname(packageJson.main)
+  // no need to change package.json, since main there does not have an extension.
+}
 
-  const shouldCompile = mainFile.ext === '.coffee';
+function compileExternalScripts() {
+  scriptsToCheck.forEach(npmModule => {
+    const packageJsonPath = getModulePackageJson(npmModule)
 
-  if (shouldCompile) {
-    console.log(`Compilling .coffee files inside module ${npmModule}`)
-    try {
-      execSync(`yarn coffee -c node_modules/${npmModule}`, {
-        cwd,
-      })
-    } catch (err) {
-      console.error(`Error while trying to compile coffee files on package ${npmModule}`)
-      console.error(err);
-      return;
+    if (!fs.existsSync(packageJsonPath)) {
+      console.warn(
+        `No package.json file found for hubot script package ${npmModule}.`,
+      )
+      console.warn(
+        `If this package does exists you will have to compile the .coffee files on it by running:`,
+      )
+      console.warn(`yarn coffeescript -c node_modules/${npmModule}`)
+      return
     }
 
-    packageJson.main = path.format({
-      ...mainFile,
-      ext: '.js',
-      base: null,
-    });
+    const packageJson = require(`${npmModule}/package.json`)
 
-    fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2))
-  }
-})
+    const mainFile = path.parse(packageJson.main)
+    const ext = path.extname(packageJson.main)
+
+    const shouldCompile = mainFile.ext === '.coffee'
+
+    if (shouldCompile) {
+      const hasCompiled = compileCoffeeFilesInsidePackage(npmModule)
+
+      if (!hasCompiled) return
+
+      packageJson.main = path.format({
+        ...mainFile,
+        ext: '.js',
+        base: null,
+      })
+
+      fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2))
+    }
+  })
+}
+
+;(function run() {
+  compileSlackAdapter()
+  compileExternalScripts()
+})()

types/custom/hubot.d.ts

@@ -0,0 +1,17 @@
+// https://stackoverflow.com/a/53346014/710693
+// This import serves no purpose except to make the file a module
+// (so that the following statement is a module augmentation rather
+// than a module declaration) and could be replaced with `export {}`.
+import * as hubot from 'hubot'
+
+import { Application } from 'express'
+
+declare module 'hubot' {
+  interface Message {
+    mentions: string[]
+  }
+
+  interface Robot<A> {
+    router: Application
+  }
+}

types/custom/index.d.ts

@@ -1 +1,2 @@
 /// <reference path="global.d.ts" />
+/// <reference path="hubot.d.ts" />

types/external/hubot-slack/index.d.ts

@@ -0,0 +1,11 @@
+declare module 'hubot-slack' {
+  interface Options {
+    token: string;
+  }
+
+  class SlackAdapter {
+    options: Options;
+  }
+
+  export = SlackAdapter;
+}