add --copy option

Author: ds300

index.js

@@ -8,6 +8,9 @@ const { normalize } = require("path")
 const { recordVideo } = require("./src/recordVideo")
 const { takeScreenshot } = require("./src/takeScreenshot")
 const open = require("open")
+const { bgRed, bold } = require("kleur")
+const { selectOption } = require("./src/selectOption")
+const logUpdate = require("log-update")
 
 const version = require(join(__dirname, "./package.json")).version
 
@@ -33,20 +36,42 @@ const imageTypes = {
   png: true,
 }
 
+/**
+ * @param {any} message
+ */
+function fail(message) {
+  console.error(bgRed(" ERROR "), message)
+  console.error("\nRun with", bold("--help"), "for usage information.")
+  process.exit(1)
+}
+
 async function run() {
   try {
     const [type = "", filename, ...others] = cli.input
 
-    const mode =
+    /**
+     * @type {"video" | "image" | null}
+     */
+    let mode =
       type in imageTypes ? "image" : type in videoTypes ? "video" : null
 
     if (!mode) {
-      cli.showHelp(1)
+      const idx = await selectOption("What do you want to capture?", [
+        "Video",
+        "Screenshot",
+      ])
+      mode = idx === 0 ? "video" : "image"
+      logUpdate(
+        `💡 Hint! In the future you can run ${bold(
+          `npx android-capture ${mode}`,
+        )}\n`,
+      )
+      logUpdate.done()
+      await new Promise((r) => setTimeout(r, 1000))
     }
 
     if (others.length) {
-      console.error("Unexpected arguements: ", others.join(" "))
-      cli.showHelp(1)
+      fail("Unexpected arguements: " + others.join(" "))
     }
 
     const extension = mode === "image" ? "png" : "mp4"
@@ -58,12 +83,18 @@ async function run() {
         generateFilename(defaultFilename, extension),
     )
 
+    if (cli.flags.copy && mode === "video") {
+      fail(`The ${bold("--copy")} option does not work with video.`)
+    }
+
+    const useTemporaryFile = !filename && cli.flags.copy && !cli.flags.open
+
     await init()
 
     if (mode === "video") {
       await recordVideo(outPath)
     } else {
-      await takeScreenshot(outPath)
+      await takeScreenshot(outPath, useTemporaryFile)
     }
 
     if (cli.flags.open) {

src/cli.js

@@ -1,4 +1,4 @@
-const { bold } = require("kleur")
+const { bold, grey } = require("kleur")
 const meow = require("meow")
 
 module.exports.cli = meow(
@@ -10,6 +10,9 @@ module.exports.cli = meow(
 
   Options
 
+    ${bold("--copy")} ${grey("(image capture only)")}
+      Copies the screenshot to the clipboard. Currently macOS only.
+
     ${bold("--full-res")}
       Record video in full resolution (may not work in emulators).
       Images are always full-resolution.
@@ -50,6 +53,10 @@ module.exports.cli = meow(
         type: "boolean",
         default: true,
       },
+      copy: {
+        type: "boolean",
+        default: false,
+      },
     },
     allowUnknownFlags: false,
   },

src/copy-image-macos

@@ -0,0 +1,6 @@
+#!/usr/bin/osascript
+
+on run args
+  set thePath to (first item of args)
+  set the clipboard to (read thePath as «class PNGf»)
+end

src/getDevice.js

@@ -1,6 +1,5 @@
-const { bgRed, bold, bgBlue, cyan, gray } = require("kleur")
-const logUpdate = require("log-update")
-const { pushKeyboardContext, popKeyboardContext } = require("./keyboardInput")
+const { bgRed, bold } = require("kleur")
+const { selectOption } = require("./selectOption")
 
 const { spawnSafeSync } = require("./spawnSafeSync")
 
@@ -53,48 +52,3 @@ function parseDeviceLine(line) {
   const isUSB = properties.some((p) => p.startsWith("usb:"))
   return { id, model, isUSB }
 }
-
-/**
- * @param {string} title
- * @param {string[]} options
- * @returns {Promise<number>}
- */
-async function selectOption(title, options) {
-  return new Promise((resolve) => {
-    let selection = 0
-    const draw = () => {
-      const lines = ["          " + bgBlue(` ${title} `), ""]
-      for (let i = 0; i < options.length; i++) {
-        lines.push(
-          "  " +
-            (i === selection
-              ? cyan().bold("• [" + (i + 1) + "]")
-              : gray("  [" + (i + 1) + "]")) +
-            " " +
-            options[i],
-        )
-      }
-      lines.push("", "Use up/down arrow keys and hit [ENTER]")
-      logUpdate(lines.join("\n"))
-    }
-
-    draw()
-    pushKeyboardContext({
-      handleKeyPress(key) {
-        if (key === "\r") {
-          // enter!
-          popKeyboardContext()
-          resolve(selection)
-        } else if (key === "\u001b[B") {
-          // arrow down!
-          selection = Math.min(selection + 1, options.length - 1)
-          draw()
-        } else if (key === "\u001b[A") {
-          // arrow up!
-          selection = Math.max(selection - 1, 0)
-          draw()
-        }
-      },
-    })
-  })
-}

src/selectOption.js

@@ -0,0 +1,48 @@
+const { cyan, gray, bold } = require("kleur")
+const logUpdate = require("log-update")
+const { pushKeyboardContext, popKeyboardContext } = require("./keyboardInput")
+
+/**
+ * @param {string} title
+ * @param {string[]} options
+ * @returns {Promise<number>}
+ */
+module.exports.selectOption = async function selectOption(title, options) {
+  return new Promise((resolve) => {
+    let selection = 0
+    const draw = () => {
+      const lines = ["          " + bold(` ${title} `), ""]
+      for (let i = 0; i < options.length; i++) {
+        lines.push(
+          "  " +
+            (i === selection
+              ? cyan().bold("• [" + (i + 1) + "]")
+              : gray("  [" + (i + 1) + "]")) +
+            " " +
+            options[i],
+        )
+      }
+      lines.push("", "Use up/down arrow keys and hit [ENTER]")
+      logUpdate(lines.join("\n"))
+    }
+
+    draw()
+    pushKeyboardContext({
+      handleKeyPress(key) {
+        if (key === "\r") {
+          // enter!
+          popKeyboardContext()
+          resolve(selection)
+        } else if (key === "\u001b[B") {
+          // arrow down!
+          selection = Math.min(selection + 1, options.length - 1)
+          draw()
+        } else if (key === "\u001b[A") {
+          // arrow up!
+          selection = Math.max(selection - 1, 0)
+          draw()
+        }
+      },
+    })
+  })
+}

src/takeScreenshot.js

@@ -1,14 +1,41 @@
-const { bold } = require("kleur")
+const { bold, bgRed } = require("kleur")
 const { adb } = require("./adb")
+const { cli } = require("./cli")
+const { tmpdir, platform } = require("os")
+const { join, basename } = require("path")
+const { unlinkSync } = require("fs")
+const { spawnSafeSync } = require("./spawnSafeSync")
 
 /**
  * @param {string} outFile
+ * @param {boolean} useTemporaryFile
  */
-module.exports.takeScreenshot = async (outFile) => {
+module.exports.takeScreenshot = async (outFile, useTemporaryFile) => {
   const internalFilePath = "/sdcard/android-capture-image.png"
+  const externalFilePath = useTemporaryFile
+    ? join(tmpdir(), basename(outFile))
+    : outFile
   console.log("Taking screenshot...\n")
   adb("shell", "screencap", "-p", internalFilePath)
-  adb("pull", internalFilePath, outFile)
+  adb("pull", internalFilePath, externalFilePath)
   adb("shell", "rm", internalFilePath)
-  console.log("Image saved to", bold(outFile))
+  if (cli.flags.copy) {
+    if (platform() === "darwin") {
+      spawnSafeSync(join(__dirname, "copy-image-macos"), [externalFilePath])
+      console.log("Image copied to clipboard!\n")
+    } else {
+      console.error(
+        bgRed(" ERROR "),
+        "--copy option currently only works on macOS.",
+      )
+      console.error(
+        "Contribute support for other platforms at\n\n    https://github.com/ds300/android-capture\n",
+      )
+    }
+  }
+  if (useTemporaryFile) {
+    unlinkSync(externalFilePath)
+  } else {
+    console.log("Image saved to", bold(outFile))
+  }
 }