hubot 9.0.1 → 9.1.0

package/README.md

@@ -15,6 +15,16 @@ 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
+
+```sh
+mkdir myhubot
+cd myhubot
+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.1",
+  "version": "9.1.0",
   "author": "hubot",
   "keywords": [
     "github",
@@ -24,7 +24,6 @@
     "pino": "^8.11.0"
   },
   "devDependencies": {
-    "semantic-release": "^21.0.1",
     "standard": "^17.1.0"
   },
   "engines": {
@@ -37,6 +36,7 @@
   },
   "scripts": {
     "start": "bin/hubot",
+    "gen": "bin/hubot --create myhubot",
     "pretest": "standard",
     "test": "node --test",
     "test:smoke": "node src/**/*.js",

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

@@ -494,7 +494,7 @@ class Robot {
       if (Array.from(HUBOT_DEFAULT_ADAPTERS).indexOf(this.adapterName) > -1) {
         this.adapter = this.requireAdapterFrom(path.resolve(path.join(__dirname, 'adapters', this.adapterName)))
       } else if (['.js', '.cjs', '.coffee'].includes(ext)) {
-        this.adapter = this.requireAdapterFrom(pathToFileURL(path.resolve(adapterPath)).pathname)
+        this.adapter = this.requireAdapterFrom(path.resolve(adapterPath))
       } else if (['.mjs'].includes(ext)) {
         this.adapter = await this.importAdapterFrom(pathToFileURL(path.resolve(adapterPath)).href)
       } else {