add cli options

Author: nieheyong

package.json

@@ -1,16 +1,27 @@
 {
   "name": "logcat-in-devtools",
-  "version": "0.1.2",
-  "description": "view android adb logcat logs in chrome devtools console",
+  "version": "0.1.3",
+  "description": "View android adb logcat logs in chrome devtools console",
+  "homepage": "https://github.com/nieheyong/logcat-in-devtools.git",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nieheyong/logcat-in-devtools.git"
+  },
   "bin": "src/index.js",
-  "keywords": [],
+  "keywords": [
+    "logcat",
+    "logcat viewer",
+    "adb",
+    "devtools"
+  ],
   "author": "niehey@163.com",
   "license": "MIT",
   "scripts": {
     "start": "npx ."
   },
   "dependencies": {
-    "chalk": "^4.1.2"
+    "chalk": "^4.1.2",
+    "commander": "^11.1.0"
   },
   "devDependencies": {
     "@types/node": "^22.7.4"

src/adb.js

@@ -2,7 +2,7 @@ const { spawn, execSync } = require("child_process");
 const { appLog, appLogError, exitProcess } = require('./stdio');
 const chalk = require("chalk");
 
-function checkAdbDevice() {
+function checkAdbDevice(serial) {
   const outputText = execSync("adb devices", { encoding: "utf8" });
   const outputLines = outputText.trim().split("\n");
   appLog(`\n$ adb devices\n${outputText.trim()}\n `);
@@ -19,7 +19,15 @@ function checkAdbDevice() {
     exitProcess(1);
   }
 
-  if (process.env.ANDROID_SERIAL) {
+  if (serial) {
+    const exist = validDevices.find((device) => serial === device.split('\t')[0]);
+    if (!exist) {
+      appLog(chalk.red
+        (`The device with serial ${serial} not connected.\n`)
+      );
+      exitProcess(1);
+    }
+  } else if (process.env.ANDROID_SERIAL) {
     appLog(`Environment Variable ${chalk.yellow('ANDROID_SERIAL')}: ${process.env.ANDROID_SERIAL}`);
     const exist = validDevices.find((device) => process.env.ANDROID_SERIAL === device.split('\t')[0]);
     if (!exist) {
@@ -32,19 +40,22 @@ Please check the device serial or unset the ${chalk.yellow("ANDROID_SERIAL")} en
   } else if (devices.length > 1) {
     appLog(
       `Multiple adb devices detected, will use the first device.\n` +
-      `You can also set the ${chalk.yellow("ANDROID_SERIAL")} env to specify device`
+      `You can also use --serial <SERIAL> to specify device`
     );
     const [firstDevice] = validDevices[0].split("\t");
     appLog(chalk.green(`Using adb device: ${firstDevice}`));
     process.env.ANDROID_SERIAL = firstDevice;
   }
 }
 
-function listenAdbLogCat(onLogCallback) {
+function listenAdbLogCat(params) {
+  const { onLog, serial } = params;
+
   // clear logcat buffer
-  execSync("adb logcat -c");
+  execSync(`adb${serial ? ` -s ${serial}` : ''} logcat -c`);
 
-  const adbProcess = spawn("adb", ["logcat"]);
+  const extraArgs = serial ? ['-s', serial] : []
+  const adbProcess = spawn("adb", [...extraArgs, 'logcat']);
 
   let leftover = "";
   adbProcess.stdout.on("data", (data) => {
@@ -53,7 +64,7 @@ function listenAdbLogCat(onLogCallback) {
     const lines = fullChunk.split("\n");
     leftover = lines.pop();
 
-    lines.forEach(onLogCallback);
+    lines.forEach(onLog);
   });
 
   adbProcess.stderr.on("data", (data) => {

src/index.js

@@ -1,6 +1,8 @@
 #!/usr/bin/env node --inspect
 const inspector = require("inspector");
 const chalk = require("chalk");
+const { program } = require('commander');
+
 const packageJson = require("../package.json");
 const { checkAdbDevice, listenAdbLogCat, styleLogcatLine } = require('./adb');
 const { muteStdio, vmLog, appLog, appLogError, listenForKeypress } = require("./stdio");
@@ -41,14 +43,14 @@ function showInspectTips() {
   ]);
 }
 
-function run() {
+function run(cliOptions) {
   muteStdio()
   appLog(`\n${chalk.yellow(packageJson.name)}@${packageJson.version}\n `);
-  checkAdbDevice();
+  checkAdbDevice(cliOptions.serial);
 
-  if (process.env.LOG_PATTERN) {
-    logPattern = new RegExp(process.env.LOG_PATTERN);
-    appLog(`Detect LOG_PATTERN: ${chalk.yellow(process.env.LOG_PATTERN)}\nJavascript RegExp:`, logPattern);
+  if (cliOptions.match) {
+    logPattern = new RegExp(cliOptions.match);
+    appLog(`Detect match: ${chalk.yellow(cliOptions.match)}\nJavascript RegExp:`, logPattern);
   }
 
   if (!process.features.inspector) {
@@ -58,6 +60,22 @@ function run() {
 
   showInspectTips();
 
-  listenAdbLogCat(processAdbLogLine);
+  listenAdbLogCat({
+    serial: cliOptions.serial,
+    onLog: processAdbLogLine
+  });
 }
-run();
+
+
+console.log('')
+program
+  .name(packageJson.name)
+  .description(packageJson.description)
+  .version(packageJson.version);
+
+program
+  .option('-m, --match <RegExp>', 'only print messages that match RegExp')
+  .option('-s, --serial <SERIAL>', 'use device with given serial (overrides $ANDROID_SERIAL)')
+  .action((options) => {
+    run(options);
+  }).parse();

yarn.lock

@@ -36,6 +36,11 @@ color-name@~1.1.4:
   resolved "https://registry.yarnpkg.com/color-name/-/color-name-1.1.4.tgz#c2a09a87acbde69543de6f63fa3995c826c536a2"
   integrity sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==
 
+commander@^11.1.0:
+  version "11.1.0"
+  resolved "https://registry.yarnpkg.com/commander/-/commander-11.1.0.tgz#62fdce76006a68e5c1ab3314dc92e800eb83d906"
+  integrity sha512-yPVavfyCcRhmorC7rWlkHn15b4wDVgVmBA7kV4QVBsF7kv/9TKJAbAXVTxvTnwP8HHKjRCJDClKbciiYS7p0DQ==
+
 has-flag@^4.0.0:
   version "4.0.0"
   resolved "https://registry.yarnpkg.com/has-flag/-/has-flag-4.0.0.tgz#944771fd9c81c81265c4d6941860da06bb59479b"