add screenshots and handle --open

Author: ds300

.gitignore

@@ -1,4 +1,5 @@
 *.mp4
+*.png
 node_modules/
 
 *.log

index.js

@@ -3,45 +3,72 @@ const { join } = require("path")
 const chalk = require("kleur")
 const { init } = require("./src/adb")
 const { existsSync } = require("fs")
-const { countdown } = require("./src/countdown")
 const { cli } = require("./src/cli")
 const { normalize } = require("path")
-const { setVisibleTouches, getVisibleTouches } = require("./src/visibleTouches")
 const { recordVideo } = require("./src/recordVideo")
+const { takeScreenshot } = require("./src/takeScreenshot")
+const open = require("open")
 
 const version = require(join(__dirname, "./package.json")).version
 
-console.log(chalk.bold("record-android-screen"), version, "\n")
+console.log(chalk.bold("android-capture"), version, "\n")
+
+/**
+ * @type {Record<string, boolean>}
+ */
+const videoTypes = {
+  video: true,
+  movie: true,
+  mp4: true,
+}
+
+/**
+ * @type {Record<string, boolean>}
+ */
+const imageTypes = {
+  image: true,
+  screenshot: true,
+  still: true,
+  picture: true,
+  png: true,
+}
 
 async function run() {
   try {
-    const [filename, ...others] = cli.input
+    const [type = "", filename, ...others] = cli.input
+
+    const mode =
+      type in imageTypes ? "image" : type in videoTypes ? "video" : null
+
+    if (!mode) {
+      cli.showHelp(1)
+    }
 
     if (others.length) {
       console.error("Unexpected arguements: ", others.join(" "))
       cli.showHelp(1)
     }
 
-    const outPath = normalize(sanitizeFilename(filename) ?? generateFilename())
-
-    await init()
-    await countdown()
+    const extension = mode === "image" ? "png" : "mp4"
+    const defaultFilename =
+      mode === "image" ? "android-screenshot" : "android-video"
 
-    const hasVisibleTouchesByDefault = getVisibleTouches()
+    const outPath = normalize(
+      sanitizeFilename(filename, extension) ??
+        generateFilename(defaultFilename, extension),
+    )
 
-    setVisibleTouches(true)
+    await init()
 
-    try {
-      const result = await recordVideo(outPath)
-      if (!result.escaped) {
-        console.log("That's a wrap!", chalk.bold(outPath))
-      }
-      console.log()
-    } catch (e) {
-      console.error("failed in main loop", e)
+    if (mode === "video") {
+      await recordVideo(outPath)
+    } else {
+      await takeScreenshot(outPath)
     }
 
-    setVisibleTouches(hasVisibleTouchesByDefault)
+    if (cli.flags.open) {
+      open(outPath)
+    }
 
     process.exit(0)
   } catch (e) {
@@ -50,18 +77,22 @@ async function run() {
   }
 }
 
-function generateFilename() {
+/**
+ * @param {string} name
+ * @param {string} extension
+ */
+function generateFilename(name, extension) {
   const date = new Date()
   const year = date.getFullYear()
   const month = date.getMonth() + 1
   const day = date.getDate()
 
-  let filename = `./recording.${year}-${month}-${day}.00.mp4`
+  let filename = `./${name}.${year}-${month}-${day}.00.${extension}`
   let i = 1
   while (existsSync(filename)) {
-    filename = `./recording.${year}-${month}-${day}.${i
+    filename = `./${name}.${year}-${month}-${day}.${i
       .toString()
-      .padStart(2, "0")}.mp4`
+      .padStart(2, "0")}.${extension}`
     i++
   }
   return filename
@@ -70,13 +101,14 @@ function generateFilename() {
 /**
  *
  * @param {string | null | undefined} filename
+ * @param {string} extension
  */
-function sanitizeFilename(filename) {
+function sanitizeFilename(filename, extension) {
   if (!filename) {
     return null
   }
-  if (!filename.endsWith(".mp4")) {
-    return filename + ".mp4"
+  if (!filename.endsWith("." + extension)) {
+    return filename + "." + extension
   } else {
     return filename
   }

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "record-android-screen",
+  "name": "android-capture",
   "version": "1.0.0",
   "main": "index.js",
   "author": "David Sheldrick",
@@ -12,6 +12,7 @@
   "dependencies": {
     "kleur": "^4.1.4",
     "log-update": "^4.0.0",
-    "meow": "^9.0.0"
+    "meow": "^9.0.0",
+    "open": "^8.0.4"
   }
 }

src/cli.js

@@ -1,22 +1,35 @@
+const { bold } = require("kleur")
 const meow = require("meow")
 
 module.exports.cli = meow(
   `
   Usage
-    $ npx record-android-screen [<out-file>] [...options]
+
+    $ npx android-capture video [<out-file>] [...options]
+    $ npx android-capture image [<out-file>] [...options]
 
   Options
-    --full-res       Record in full resolution (may not work in emulators)
-    --open           Open the video after saving
-    --no-countdown   Prevent the 3..2..1.. countdown
-    --help, -h       Show this help text
+
+    ${bold("--full-res")}
+      Record video in full resolution (may not work in emulators).
+      Images are always full-resolution.
+
+    ${bold("--open")}
+      Open the file after saving
+
+    ${bold("--no-countdown")}
+      Prevent the 3..2..1.. countdown when recording video.
+
+    ${bold("--help, -h")}
+      Show this help text
 
   Examples
-    $ npx record-android-screen
 
-    $ npx record-android-screen ./my-recording.mp4
+    $ npx android-capture video
+
+    $ npx android-capture video ./my-recording.mp4 --ful-res
 
-    $ npx record-android-screen --open
+    $ npx android-capture image --open
 `,
   {
     flags: {

src/recordVideo.js

@@ -2,7 +2,9 @@ const { red, green, bold, gray } = require("kleur")
 const logUpdate = require("log-update")
 const { adb, adbAsync } = require("./adb")
 const { cli } = require("./cli")
+const { countdown } = require("./countdown")
 const { pushKeyboardContext, popKeyboardContext } = require("./keyboardInput")
+const { getVisibleTouches, setVisibleTouches } = require("./visibleTouches")
 
 function getScreenSize() {
   const output = adb("shell", "wm", "size").stdout.toString()
@@ -26,11 +28,34 @@ const ENTER_KEYS = {
   " ": true,
 }
 
+/**
+ * @param {string} outFile
+ */
+module.exports.recordVideo = async (outFile) => {
+  await countdown()
+
+  const hasVisibleTouchesByDefault = getVisibleTouches()
+
+  setVisibleTouches(true)
+
+  try {
+    const result = await createRecording(outFile)
+    if (!result.escaped) {
+      console.log("That's a wrap!", bold(outFile))
+    }
+    console.log()
+  } catch (e) {
+    console.error("failed in main loop", e)
+  }
+
+  setVisibleTouches(hasVisibleTouchesByDefault)
+}
+
 /**
  * @param {string} outFile
  * @returns {Promise<{escaped: boolean}>}
  */
-module.exports.recordVideo = async function recordVideo(outFile) {
+async function createRecording(outFile) {
   const internalFilePath = `/sdcard/android-screen-recording.mp4`
   const screenSize = getScreenSize()
 

src/takeScreenshot.js

@@ -0,0 +1,14 @@
+const { bold } = require("kleur")
+const { adb } = require("./adb")
+
+/**
+ * @param {string} outFile
+ */
+module.exports.takeScreenshot = async (outFile) => {
+  const internalFilePath = "/sdcard/android-capture-image.png"
+  console.log("Taking screenshot...\n")
+  adb("shell", "screencap", "-p", internalFilePath)
+  adb("pull", internalFilePath, outFile)
+  adb("shell", "rm", internalFilePath)
+  console.log("Image saved to", bold(outFile))
+}

yarn.lock

@@ -141,6 +141,11 @@ decamelize@^1.1.0, decamelize@^1.2.0:
   resolved "https://registry.yarnpkg.com/decamelize/-/decamelize-1.2.0.tgz#f6534d15148269b20352e7bee26f501f9a191290"
   integrity sha1-9lNNFRSCabIDUue+4m9QH5oZEpA=
 
+define-lazy-prop@^2.0.0:
+  version "2.0.0"
+  resolved "https://registry.yarnpkg.com/define-lazy-prop/-/define-lazy-prop-2.0.0.tgz#3f7ae421129bcaaac9bc74905c98a0009ec9ee7f"
+  integrity sha512-Ds09qNh8yw3khSjiJjiUInaGX9xlqZDY7JVryGxdxV7NPeuqQfplOpQ66yJFZut3jLa5zOwkXw1g9EI2uKh4Og==
+
 emoji-regex@^8.0.0:
   version "8.0.0"
   resolved "https://registry.yarnpkg.com/emoji-regex/-/emoji-regex-8.0.0.tgz#e818fd69ce5ccfcb404594f842963bf53164cc37"
@@ -217,6 +222,11 @@ is-core-module@^2.2.0:
   dependencies:
     has "^1.0.3"
 
+is-docker@^2.0.0, is-docker@^2.1.1:
+  version "2.1.1"
+  resolved "https://registry.yarnpkg.com/is-docker/-/is-docker-2.1.1.tgz#4125a88e44e450d384e09047ede71adc2d144156"
+  integrity sha512-ZOoqiXfEwtGknTiuDEy8pN2CfE3TxMHprvNer1mXiqwkOT77Rw3YVrUQ52EqAOU3QAWDQ+bQdx7HJzrv7LS2Hw==
+
 is-fullwidth-code-point@^3.0.0:
   version "3.0.0"
   resolved "https://registry.yarnpkg.com/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz#f116f8064fe90b3f7844a38997c0b75051269f1d"
@@ -227,6 +237,13 @@ is-plain-obj@^1.1.0:
   resolved "https://registry.yarnpkg.com/is-plain-obj/-/is-plain-obj-1.1.0.tgz#71a50c8429dfca773c92a390a4a03b39fcd51d3e"
   integrity sha1-caUMhCnfync8kqOQpKA7OfzVHT4=
 
+is-wsl@^2.2.0:
+  version "2.2.0"
+  resolved "https://registry.yarnpkg.com/is-wsl/-/is-wsl-2.2.0.tgz#74a4c76e77ca9fd3f932f290c17ea326cd157271"
+  integrity sha512-fKzAra0rGJUUBwGBgNkHZuToZcn+TtXHpeCgmkMJMMYx1sQDYaCSyjJBSCa2nH1DGm7s3n1oBnohoVTBaN7Lww==
+  dependencies:
+    is-docker "^2.0.0"
+
 js-tokens@^4.0.0:
   version "4.0.0"
   resolved "https://registry.yarnpkg.com/js-tokens/-/js-tokens-4.0.0.tgz#19203fb59991df98e3a287050d4647cdeaf32499"
@@ -350,6 +367,15 @@ onetime@^5.1.0:
   dependencies:
     mimic-fn "^2.1.0"
 
+open@^8.0.4:
+  version "8.0.4"
+  resolved "https://registry.yarnpkg.com/open/-/open-8.0.4.tgz#2fb90debffcf20f4d7be537502ed3e3ee9e5dcbc"
+  integrity sha512-Txc9FOcvjrr5Kv+Zb3w89uKMKiP7wH8mLdYj1xJa+YnhhntEYhbB6cQHjS4O6P+jFwMEzEQVVcpfnu9WkKNuLQ==
+  dependencies:
+    define-lazy-prop "^2.0.0"
+    is-docker "^2.1.1"
+    is-wsl "^2.2.0"
+
 p-limit@^2.2.0:
   version "2.3.0"
   resolved "https://registry.yarnpkg.com/p-limit/-/p-limit-2.3.0.tgz#3dd33c647a214fdfffd835933eb086da0dc21db1"