Adding ability to extend existing docker-compose file to include volumes for watching plugins.

packages/cli/package.json

@@ -45,7 +45,8 @@
     "pouchdb": "7.3.0",
     "pouchdb-replication-stream": "1.2.9",
     "randomstring": "1.1.5",
-    "tar": "6.1.11"
+    "tar": "6.1.11",
+    "yaml": "^2.1.1"
   },
   "devDependencies": {
     "copyfiles": "^2.4.1",

packages/cli/src/constants.js

@@ -11,6 +11,7 @@ exports.CommandWords = {
 exports.InitTypes = {
   QUICK: "quick",
   DIGITAL_OCEAN: "do",
+  SINGLE: "single",
 }
 
 exports.AnalyticsEvents = {

packages/cli/src/hosting/index.js

@@ -1,11 +1,13 @@
 const Command = require("../structures/Command")
 const { CommandWords, InitTypes, AnalyticsEvents } = require("../constants")
 const { lookpath } = require("lookpath")
+const { resolve } = require("path")
 const {
   downloadFile,
   logErrorToFile,
   success,
   info,
+  error,
   parseEnv,
 } = require("../utils")
 const { confirmation } = require("../questions")
@@ -14,6 +16,7 @@ const compose = require("docker-compose")
 const makeEnv = require("./makeEnv")
 const axios = require("axios")
 const { captureEvent } = require("../events")
+const yaml = require("yaml")
 
 const BUDIBASE_SERVICES = ["app-service", "worker-service", "proxy-service"]
 const ERROR_FILE = "docker-error.log"
@@ -154,11 +157,58 @@ async function update() {
   })
 }
 
+async function watchPlugins(pluginPath) {
+  const PLUGIN_PATH = "/plugins"
+  // get absolute path
+  pluginPath = resolve(pluginPath)
+  if (!fs.existsSync(pluginPath)) {
+    console.log(
+      error(
+        `The directory "${pluginPath}" does not exist, please create and then try again.`
+      )
+    )
+    return
+  }
+  const opts = ["docker-compose.yaml", "docker-compose.yml"]
+  let dockerFilePath = opts.find(name => fs.existsSync(name))
+  if (!dockerFilePath) {
+    console.log(error("Unable to locate docker-compose YAML."))
+    return
+  }
+  const dockerYaml = fs.readFileSync(dockerFilePath, "utf8")
+  const parsedYaml = yaml.parse(dockerYaml)
+  let service
+  if (parsedYaml["services"]["app-service"]) {
+    service = parsedYaml["services"]["app-service"]
+  }
+  if (!service) {
+    console.log(
+      error(
+        "Unable to locate service within compose file, is it a valid Budibase configuration?"
+      )
+    )
+    return
+  }
+  // set environment variable
+  service.environment["PLUGINS_DIR"] = PLUGIN_PATH
+  // add volumes to parsed yaml
+  if (!service.volumes) {
+    service.volumes = []
+  }
+  const found = service.volumes.find(vol => vol.includes(PLUGIN_PATH))
+  if (found) {
+    service.volumes.splice(service.volumes.indexOf(found), 1)
+  }
+  service.volumes.push(`${pluginPath}:${PLUGIN_PATH}`)
+  fs.writeFileSync(dockerFilePath, yaml.stringify(parsedYaml))
+  console.log(success("Docker compose configuration has been updated!"))
+}
+
 const command = new Command(`${CommandWords.HOSTING}`)
   .addHelp("Controls self hosting on the Budibase platform.")
   .addSubOption(
     "--init [type]",
-    "Configure a self hosted platform in current directory, type can be unspecified or 'quick'.",
+    "Configure a self hosted platform in current directory, type can be unspecified, 'quick' or 'single'.",
     init
   )
   .addSubOption(
@@ -181,5 +231,11 @@ const command = new Command(`${CommandWords.HOSTING}`)
     "Update the Budibase images to the latest version.",
     update
   )
+  .addSubOption(
+    "--watch-plugin-dir [directory]",
+    "Add plugin directory watching to a Budibase install.",
+    watchPlugins
+  )
+  .addSubOption("--dev", "")
 
 exports.command = command

packages/cli/src/structures/Command.js

@@ -1,4 +1,9 @@
-const { getSubHelpDescription, getHelpDescription, error } = require("../utils")
+const {
+  getSubHelpDescription,
+  getHelpDescription,
+  error,
+  capitaliseFirstLetter,
+} = require("../utils")
 
 class Command {
   constructor(command, func = null) {
@@ -8,6 +13,15 @@ class Command {
     this.func = func
   }
 
+  convertToCommander(lookup) {
+    const parts = lookup.toLowerCase().split("-")
+    // camel case, separate out first
+    const first = parts.shift()
+    return [first]
+      .concat(parts.map(part => capitaliseFirstLetter(part)))
+      .join("")
+  }
+
   addHelp(help) {
     this.help = help
     return this
@@ -38,7 +52,9 @@ class Command {
       try {
         let executed = false
         for (let opt of thisCmd.opts) {
-          const lookup = opt.command.split(" ")[0].replace("--", "")
+          let lookup = opt.command.split(" ")[0].replace("--", "")
+          // need to handle how commander converts watch-plugin-dir to watchPluginDir
+          lookup = this.convertToCommander(lookup)
           if (!executed && options[lookup]) {
             const input =
               Object.keys(options).length > 1 ? options : options[lookup]

packages/cli/src/utils.js

@@ -84,3 +84,7 @@ exports.moveDirectory = (oldPath, newPath) => {
   }
   fs.rmdirSync(oldPath)
 }
+
+exports.capitaliseFirstLetter = str => {
+  return str.charAt(0).toUpperCase() + str.slice(1)
+}