@rpcbase/cli 0.8.0 → 0.12.0

package/bin.js

@@ -6,34 +6,57 @@ require("dotenv").config({path: path.join(__dirname, "./.env")})
 const yargs = require("yargs/yargs")
 const {hideBin} = require("yargs/helpers")
 
-const default_command = require("./src/default_command")
+const start_command = require("./src/start_command")
+const print_versions = require("./src/print_versions")
 const update = require("./src/update")
 
-let is_command = false
-
-const args = yargs(hideBin(process.argv))
-  .command(["update", "up"], "Update rb dependencies to latest version", () => {}, async(argv) => {
-    is_command = true
+yargs(hideBin(process.argv))
+  .command(["start", "*"], "Starts client, server, and infrastructure", (yargs) => {
+    yargs
+      .option("coverage", {
+        alias: "c",
+        type: "boolean",
+        default: false,
+        description: "Adds coverage instrumentation (always disabled in production)"
+      })
+      .option("verbose", {
+        type: "boolean",
+        default: false,
+        description: "Run with verbose logging"
+      })
+      .option("debug", {
+        type: "boolean",
+        default: false,
+        description: "Run with debug logging"
+      })
+  }, (argv) => {
+    if (argv.version) return print_versions()
+    start_command(argv)
+  })
+  // Update
+  .command(["update", "up"], "Update rb dependencies to latest version", (yargs) => {
+    yargs
+      .option("dry-run", {
+        type: "boolean",
+        default: false,
+        description: "Print output without writing any files"
+      })
+  }, async(argv) => {
+    if (argv.version) return print_versions()
     await update()
   })
+  // Ping
   .command("ping", "Ping", () => {}, (argv) => {
-    is_command = true
+    if (argv.version) return print_versions()
     console.log("PING")
   })
-  .option("coverage", {
-    alias: "c",
+  // Global options
+  .version(false)
+  .option("version", {
+    alias: "v",
     type: "boolean",
-    default: false,
-    description: "Adds coverage instrumentation (always disabled in production)"
+    description: "Displays the @rpcbase/cli version"
   })
-  // .option("version", {
-  //   alias: "v",
-  //   type: "boolean",
-  //   default: false,
-  //   // description: "Displays CLI version"
-  // })
+  .help("h")
+  .alias("h", "help")
   .parse()
-
-if (!is_command) {
-  default_command(args)
-}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rpcbase/cli",
-  "version": "0.8.0",
+  "version": "0.12.0",
   "license": "SSPL-1.0",
   "bin": {
     "rb": "./bin.js"
@@ -10,10 +10,10 @@
   },
   "dependencies": {
     "bluebird": "3.7.2",
-    "chalk": "4.1.2",
-    "concurrently": "7.2.1",
+    "concurrently": "7.2.2",
     "debug": "4.3.4",
     "dotenv": "16.0.1",
+    "picocolors": "1.0.0",
     "semver": "7.3.7",
     "validator": "13.7.0",
     "yargs": "17.5.1"

package/src/errors.js

@@ -1,8 +1,8 @@
 /* @flow */
-const chalk = require("chalk")
+const colors = require("picocolors")
 
 const ERRORS = {
-  INVALID_CWD: `expected to run in ${chalk.cyan("client/")} or ${chalk.cyan("server/server/")} or project root directory`
+  INVALID_CWD: `expected to run in ${colors.cyan("client/")} or ${colors.cyan("server/server/")} or project root directory`
 }
 
 module.exports = ERRORS

package/src/helpers/docker_runtime_check.js

@@ -1,12 +1,21 @@
 /* @flow */
 const {execSync} = require("child_process")
-const chalk = require("chalk")
+const os = require("os")
+const colors = require("picocolors")
+
+const {FORCE_DOCKER} = process.env
 
 const docker_runtime_check = () => {
+  // skip check on osx except when forcing docker
+  if (os.platform() === "darwin" && !FORCE_DOCKER) {
+    return
+  }
+
+
   try {
     execSync("docker version -f json")
   } catch (err) {
-    console.log(chalk.cyan.bold("docker"), "exited with error")
+    console.log(colors.cyan("docker"), "exited with error")
     process.exit(1)
   }
 }

package/src/helpers/exit_with_message.js

@@ -1,8 +1,8 @@
 /* @flow */
-const chalk = require("chalk")
+const colors = require("picocolors")
 
 const exit_with_message = (message = "", code = 1) => {
-  console.log(chalk.red("error:"), message)
+  console.log(colors.red("error:"), message)
 
   // TODO: sentry(?) report error
 

package/src/print_versions.js

@@ -0,0 +1,15 @@
+/* @flow */
+const {execSync} = require("child_process")
+
+const colors = require("picocolors")
+
+const package = require("../package.json")
+
+const print_versions = () => {
+  console.log(`${colors.cyan("rb")} v${package.version}`)
+
+  const node_out = execSync("node -v")
+  console.log(`${colors.green("node")} ${node_out.toString().trim()}`)
+}
+
+module.exports = print_versions

package/src/{default_command.js → start_command.js}

@@ -2,7 +2,7 @@
 const debug = require("debug")("rb-cli")
 const path = require("path")
 const fs = require("fs")
-const chalk = require("chalk")
+const colors = require("picocolors")
 const concurrently = require("concurrently")
 
 const docker_runtime_check = require("./helpers/docker_runtime_check")
@@ -13,7 +13,7 @@ const verify_project = require("./verify_project")
 // TODO: nuke this
 // server native + docker + docker-native is way too complex
 // either everything is native, or everything is in docker
-const default_command = async(args) => {
+const start_command = async(args) => {
   const run_configs = get_run_configs()
 
   const run_commands = []
@@ -39,11 +39,20 @@ const default_command = async(args) => {
       prefixColor = "#4DB33D"
     }
 
-    // pass through coverage arg to client and server
-    if (["client", "server"].includes(cfg.type) && args.coverage) {
-      command = `${command} --coverage`
+    // pass through listed args to client and server
+    if (["client", "server"].includes(cfg.type)) {
+      if (args.coverage) {
+        command = `${command} --coverage`
+      }
+      if (args.debug) {
+        command = `${command} --debug`
+      }
+      if (args.verbose) {
+        command = `${command} --verbose`
+      }
     }
 
+
     // add command
     run_commands.push({
       name,
@@ -72,7 +81,7 @@ const default_command = async(args) => {
     })
     .catch((err) => {
       if (project_errors?.length >  0) {
-        console.log(`\n${chalk.bold("exited due to configuration errors:")}`)
+        console.log(`\n${colors.bold("exited due to configuration errors:")}`)
         project_errors.forEach((err) => {
           console.log(err)
         })
@@ -94,4 +103,4 @@ const default_command = async(args) => {
   }
 }
 
-module.exports = default_command
+module.exports = start_command

package/src/verify_project/index.js

@@ -1,7 +1,7 @@
 /* @flow */
 const path = require("path")
 const _ = require("lodash")
-const chalk = require("chalk")
+const colors = require("picocolors")
 const Promise = require("bluebird")
 
 const verify_packages_installed = require("./verify_packages_installed")
@@ -34,18 +34,18 @@ const verify_project = async(run_configs) => {
   )
 
   if (deps_errors.length > 0) {
-    let error_str = `${chalk.bold.red("error:")} the following packages are missing from your ${chalk.bold("node_modules")}\n`
+    let error_str = `${colors.red("error:")} the following packages are missing from your ${colors.bold("node_modules")}\n`
     deps_errors.forEach((err) => {
       error_str += `  ${err}\n`
     })
-    error_str += `\n  run ${chalk.bold("yarn install")} to ensure dependencies are installed\n`
+    error_str += `\n  run ${colors.bold("yarn install")} to ensure dependencies are installed\n`
     result_errors.push(error_str)
   }
 
   // get env file from server and validate required services and ports
   const env_errors = await verify_env(project_root_dir)
   if (env_errors.length > 0) {
-    let error_str = `${chalk.bold.red("error:")} ${chalk.bold(".env")} misconfigurations\n`
+    let error_str = `${colors.red("error:")} ${colors.bold(".env")} misconfigurations\n`
     env_errors.forEach((err) => {
       error_str += `  ${err}\n`
     })

package/src/verify_project/thresholds.schema.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.rpcbase.com/schemas/thresholds.schema.json",
+  "title": "thresholds",
+  "type": "object",
+  "properties": {
+    "statements": {
+      "type": "number",
+      "minimum": 0,
+      "maximum": 100,
+    },
+    "branches": {
+      "type": "number",
+      "minimum": 0,
+      "maximum": 100,
+    },
+    "functions": {
+      "type": "number",
+      "minimum": 0,
+      "maximum": 100,
+    },
+    "lines": {
+      "type": "number",
+      "minimum": 0,
+      "maximum": 100,
+    }
+  }
+}

package/src/verify_project/verify_env.js

@@ -1,14 +1,15 @@
 /* @flow */
 const fs = require("fs")
 const path = require("path")
-const chalk = require("chalk")
+
+const colors = require("picocolors")
 const dotenv = require("dotenv")
 const validator = require("validator")
 
 
 const validate_port = (val) => {
   if (!validator.isPort(val)) {
-    return `expected ${chalk.bold(val)} to be a valid port number`
+    return `expected ${colors.bold(val)} to be a valid port number`
   }
 }
 
@@ -31,7 +32,7 @@ const SERVICES = [
       "DATABASE_PORT": validate_port,
       "DATABASE_NAME": (val) => {
         if (!/^[$A-Z_][0-9A-Z_$-]*$/i.test(val)) {
-          return `expected ${chalk.bold(`'${val}'`)} to be a valid database name`
+          return `expected ${colors.bold(`'${val}'`)} to be a valid database name`
         }
       }
     },
@@ -65,13 +66,13 @@ const verify_env = async(root_dir) => {
       const env_val = parsed_env[k]
 
       if (!env_val) {
-        result_errors.push(`${chalk.yellow.bold(k)} is missing`)
+        result_errors.push(`${colors.yellow(k)} is missing`)
         return
       }
 
       const err = val_fn(env_val)
       if (err) {
-        result_errors.push(`${chalk.yellow.bold(k)} ${err}`)
+        result_errors.push(`${colors.yellow(k)} ${err}`)
       }
     })
   })

package/src/verify_project/verify_packages_installed.js

@@ -2,7 +2,7 @@
 const path = require("path")
 const fs = require("fs")
 const util = require("util")
-const chalk = require("chalk")
+const colors = require("picocolors")
 const semverSatisfies = require("semver/functions/satisfies")
 
 const exec = util.promisify(require("child_process").exec)
@@ -37,7 +37,7 @@ const verify_packages_installed = (root_dir) => async(wd) => {
 
   Object.keys(deps).forEach((k) => {
     if (!installed[k]) {
-      result_errors.push(`${chalk.yellow.bold(k)} is missing in ${chalk.bold(rel_dir + "/")}`)
+      result_errors.push(`${colors.yellow(k)} is missing in ${colors.bold(rel_dir + "/")}`)
     }
   })