improve logging

Author: ds300

index.js

@@ -2,22 +2,21 @@
 
 const { join } = require("path")
 
-const chalk = require("kleur")
 const { init } = require("./src/adb")
 const { existsSync } = require("fs")
 const { cli } = require("./src/cli")
 const { normalize } = require("path")
 const { recordVideo } = require("./src/recordVideo")
 const { takeScreenshot } = require("./src/takeScreenshot")
 const open = require("open")
-const { bgRed, bold } = require("kleur")
+const { bold, gray } = require("kleur")
 const { selectOption } = require("./src/selectOption")
 const logUpdate = require("log-update")
+const { fail } = require("./src/log")
 
 const version = require(join(__dirname, "./package.json")).version
 
-console.log()
-console.log(chalk.bold("android-capture"), version, "\n")
+console.log(bold().gray("android-capture"), gray(version), "\n")
 
 /**
  * @type {Record<string, boolean>}
@@ -42,10 +41,8 @@ const imageTypes = {
 /**
  * @param {any} message
  */
-function fail(message) {
-  console.error(bgRed(" ERROR "), message)
-  console.error("\nRun with", bold("--help"), "for usage information.")
-  process.exit(1)
+function error(message) {
+  fail(message, "\nRun with", bold("--help"), "for usage information.")
 }
 
 async function run() {
@@ -74,7 +71,7 @@ async function run() {
     }
 
     if (others.length) {
-      fail("Unexpected arguements: " + others.join(" "))
+      error("Unexpected arguements: " + others.join(" "))
     }
 
     const extension = mode === "image" ? "png" : "mp4"
@@ -87,7 +84,7 @@ async function run() {
     )
 
     if (cli.flags.copy && mode === "video") {
-      fail(`The ${bold("--copy")} option does not work with video.`)
+      error(`The ${bold("--copy")} option does not work with video.`)
     }
 
     const useTemporaryFile = !filename && cli.flags.copy && !cli.flags.open

src/adb.js

@@ -1,14 +1,18 @@
 const { spawn } = require("child_process")
+const { gray } = require("kleur")
 const { getDevice } = require("./getDevice")
+const { verbose, formatSpawnArgs } = require("./log")
 const { spawnSafeSync } = require("./spawnSafeSync")
 
 let device = ""
 
 module.exports.adb = (/** @type {string[]} */ ...args) =>
   spawnSafeSync("adb", ["-s", device, ...args])
 
-module.exports.adbAsync = (/** @type {string[]} */ ...args) =>
-  spawn("adb", ["-s", device, ...args])
+module.exports.adbAsync = (/** @type {string[]} */ ...args) => {
+  verbose(gray("$"), "adb", formatSpawnArgs(["-s", device, ...args]))
+  return spawn("adb", ["-s", device, ...args])
+}
 
 module.exports.init = async () => {
   device = await getDevice()

src/cli.js

@@ -26,6 +26,9 @@ module.exports.cli = meow(
     ${bold("--help, -h")}
       Show this help text
 
+    ${bold("--verbose")}
+      Show verbose output
+
   Examples
 
     $ npx android-capture video
@@ -57,6 +60,10 @@ module.exports.cli = meow(
         type: "boolean",
         default: false,
       },
+      verbose: {
+        type: "boolean",
+        default: false,
+      },
     },
     allowUnknownFlags: false,
   },

src/countdown.js

@@ -16,7 +16,7 @@ module.exports.countdown = async () => {
         0,
         numCharsOfCountdownStringToUse,
       )
-      logUpdate(`          🎬 Get ready! ${countdownSoFar}\n\n`)
+      logUpdate(`    🎬 Get ready! ${countdownSoFar}\n\n`)
       if (ratio >= 1) {
         clearInterval(interval)
         r(null)

src/getDevice.js

@@ -1,18 +1,16 @@
-const { bgRed, bold } = require("kleur")
+const { bold } = require("kleur")
+const { fail } = require("./log")
 const { selectOption } = require("./selectOption")
 
 const { spawnSafeSync } = require("./spawnSafeSync")
 
-const ERROR = bgRed(" ERROR ")
-
 module.exports.getDevice = async () => {
-  const res = spawnSafeSync("which", ["adb"], {
-    logStdErrOnError: false,
-    throwOnError: false,
-  })
+  const res = spawnSafeSync("which", ["adb"], { failOnError: false })
   if (res.status !== 0) {
-    console.error(ERROR, bold("adb"), "not found")
-    console.error("Please install and configure the android dev tools.")
+    fail(
+      `${bold("adb")} not found`,
+      "Please install and configure the android dev tools.",
+    )
   }
 
   const result = spawnSafeSync("adb", ["devices", "-l"]).stdout.toString()
@@ -21,9 +19,9 @@ module.exports.getDevice = async () => {
     .trim()
     .split(/\r?\n/g)
     .filter(Boolean)
+
   if (deviceLines.length === 0) {
-    console.error(bgRed(" ERROR "), "No devices or emulators connected.")
-    process.exit(0)
+    fail("No devices or emulators connected.")
   }
 
   if (deviceLines.length === 1) {
@@ -48,7 +46,9 @@ module.exports.getDevice = async () => {
  */
 function parseDeviceLine(line) {
   const [id, _type, ...properties] = line.split(/\s+/)
-  const model = (properties.find((p) => p.startsWith("model:")) || "").split(":")[1]
+  const model = (properties.find((p) => p.startsWith("model:")) || "").split(
+    ":",
+  )[1]
   const isUSB = properties.some((p) => p.startsWith("usb:"))
   return { id, model, isUSB }
 }

src/log.js

@@ -0,0 +1,35 @@
+const { bgRed } = require("kleur")
+const logUpdate = require("log-update")
+const { cli } = require("./cli")
+
+/**
+ * @param {string} msg
+ * @param {...any} others
+ */
+module.exports.fail = (msg, ...others) => {
+  logUpdate.done()
+  console.error(bgRed(" ERROR "), msg)
+  if (others.length) {
+    console.error(...others)
+  }
+  process.exit(1)
+}
+
+/**
+ * @param  {...any} args
+ */
+module.exports.verbose = (...args) => {
+  if (cli.flags.verbose) {
+    logUpdate.done()
+    console.log(...args)
+  }
+}
+
+/**
+ * @param {string[]} args
+ */
+module.exports.formatSpawnArgs = (args) => {
+  return args
+    .map((a) => (a.match(/^[\w\-]+$/) ? a : `'${a.replace(/'/g, `'\\''`)}'`))
+    .join(" ")
+}

src/recordVideo.js

@@ -4,6 +4,7 @@ const { adb, adbAsync } = require("./adb")
 const { cli } = require("./cli")
 const { countdown } = require("./countdown")
 const { pushKeyboardContext, popKeyboardContext } = require("./keyboardInput")
+const { fail } = require("./log")
 const { getVisibleTouches, setVisibleTouches } = require("./visibleTouches")
 
 function getScreenSize() {
@@ -88,18 +89,17 @@ async function createRecording(outFile) {
       display.stop()
 
       if (err) {
-        console.log(err)
+        logUpdate.done()
+        fail("Failed to capture video.", err)
       }
 
       if (!escaped) {
-        logUpdate(
-          `          ${green("✔")} Cut!\n\nTransferring video from phone...`,
-        )
+        logUpdate(`    ${green("✔")} Cut!\n\nTransferring video from phone...`)
         await new Promise((r) => setTimeout(r, 2000))
         console.log()
         adb("pull", internalFilePath, outFile)
       } else {
-        logUpdate(`          ${bold().red("♺")} Cancelling...\n\n`)
+        logUpdate(`    ${bold().red("♺")} Cancelling...\n\n`)
       }
       adb("shell", "rm", internalFilePath)
       resolve({ escaped })
@@ -142,7 +142,7 @@ class RecordingMessage {
     return this
   }
   print() {
-    logUpdate(`          ${this.toggle ? red("⦿") : " "} Recording...
+    logUpdate(`    ${this.toggle ? red("⦿") : " "} Recording...
 
 Press ${printKey(bold().green("SPACE"))} to finish recording, or ${printKey(
       "ESC",

src/spawnSafeSync.js

@@ -1,14 +1,15 @@
 /**
- * @typedef {{ throwOnError?: boolean, logStdErrOnError?: boolean, maxBuffer?: number} & import('child_process').SpawnOptions} SpawnSafeOptions
+ * @typedef {{ failOnError?: boolean, maxBuffer?: number} & import('child_process').SpawnOptions} SpawnSafeOptions
  */
 
 /** @type {SpawnSafeOptions} */
 const defaultOptions = {
-  logStdErrOnError: true,
-  throwOnError: true,
+  failOnError: true,
 }
 
 const { spawnSync } = require("child_process")
+const { gray } = require("kleur")
+const { verbose, fail, formatSpawnArgs } = require("./log")
 
 class ConsoleError {
   /**
@@ -25,18 +26,17 @@ module.exports.spawnSafeSync = (
   /** @type {string[]} */ args,
   /** @type {SpawnSafeOptions} */ options,
 ) => {
+  verbose(`${gray("$")} ${command} ${formatSpawnArgs(args)}`)
   const mergedOptions = Object.assign({}, defaultOptions, options)
   const result = spawnSync(command, args, options)
   if (result.error || result.status !== 0) {
-    if (mergedOptions.logStdErrOnError) {
-      if (result.stderr) {
-        console.error(result.stderr.toString())
-      } else if (result.error) {
-        console.error(result.error)
-      }
-    }
-    if (mergedOptions.throwOnError) {
-      throw new ConsoleError(result)
+    if (mergedOptions.failOnError) {
+      const err = result.stderr ? result.stderr.toString() : ""
+      const out = result.stdout ? result.stdout.toString() : ""
+      fail(
+        `Command failed: ${command} ${formatSpawnArgs(args)}`,
+        ...[err, out, result.error].filter(Boolean),
+      )
     }
   }
   return result