add search command; add help

Author: jkrup

README.md

@@ -19,25 +19,61 @@ $ npm install -g pwatch
 Add `pwatch` at the end of your command.
 
 ```
-$ sleep 10 | pwatch
+  pwatch <pid | command>
+
+
+  Commands:
+    search      [name]      Lists all processes by PID that match "name"
+
+
+  Examples:
+
+    – Notifies after 10 seconds
+
+      ${'$ sleep 10 | pwatch'.cyan}
+
+    – See all PID for node related processes
+
+      ${'$ pwatch search node'.cyan}
+
+    – Notify me when process 4030 ends
+
+      ${'$ pwatch 4030'.cyan}
+
+    – Run in background with a &
+
+      ${'$ sleep 10 | pwatch &'.cyan}
+  `)
+```
+
+### Examples
+
+```
+sleep 10 | pwatch
 ```
 or
 
 ```
-$ sleep 10 && pwatch
+sleep 10 && pwatch
 ```
 or 
 
 ```
-$ sleep 10; pwatch
+sleep 10; pwatch
+```
+
+Optionally add a `&` so pwatch runs in the background
+
+```
+sleep 10 | pwatch &
 ```
 
 Or if you forget to call it when running your command
 
 ```
 $ scp somelargefile.tar.gz root@remotehost:~
-$ ps aux | grep scp
-justink          60132   0.0  0.2  3041904  31712 s018  S+   12:15PM   0:00.20 scp somelargefile.tar.gz root@remotehost:~
+$ pwatch search scp
+    60132 - 0:00.20 scp somelargefile.tar.gz root@remotehost:~
 $ pwatch 60132
 ```
 

package.json

@@ -1,10 +1,10 @@
 {
   "name": "pwatch",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "Process Watcher",
   "main": "./index.js",
   "bin": {
-      "pwatch": "./index.js"
+    "pwatch": "./index.js"
   },
   "scripts": {
     "prepublish": "babel src --out-dir dist",
@@ -19,6 +19,8 @@
     "jest": "^18.1.0"
   },
   "dependencies": {
-    "node-notifier": "^5.0.2"
+    "colors": "^1.1.2",
+    "node-notifier": "^5.0.2",
+    "ps-man": "jkrup/node-ps"
   }
 }

src/main.js

@@ -1,38 +1,83 @@
 import tty from 'tty';
-import { exec } from 'child_process';
 import notifier from 'node-notifier';
+import ps from 'ps-man';
+import 'colors';
 
-function checkPid(pid, cb = function() { notifier.notify(`Process ${pid}: Completed`) }) {
-    exec(`ps ${pid}`, (error, stdout, stderr) => {
-        if (error) {
-            return cb();
-        }
-        setTimeout(checkPid.bind(this, pid, cb), 1000);
-    });
+function checkPid(pid, cb = () => { notifier.notify(`Process ${pid}: Completed`); }) {
+  ps.list({ pid }, (err, res) => {
+    if (res.length === 0) {
+      return cb();
+    }
+    return setTimeout(checkPid.bind(this, pid, cb), 1000);
+  });
 }
 
 function handlePiped() {
-    process.stdin.on('data', () => { }); // required so that readable is called on end
-    process.stdin.on('end', () => {
-        notifier.notify(`Process Completed`);
-    });
+  process.stdin.on('data', () => { }); // required so that readable is called on end
+  process.stdin.on('end', () => {
+    notifier.notify('Process Completed');
+  });
+}
+
+function search(term) {
+  ps.list({ name: new RegExp(term, 'i') }, (err, res) => {
+    const result = res
+      .filter(el => !el.command.match(/pwatch search/))
+      .map(el => `${el.pid.yellow} - ${el.command}`)
+      .join('\n');
+    console.log(result);
+  });
+}
+
+function help() {
+  console.log(`
+  ${'pwatch'.bold} <pid | command>
+
+
+  Commands:
+    search      [name]      Lists all processes by PID that match "name"
+
+
+  Examples:
+
+    ${'–'.grey} Notifies after 10 seconds
+
+      ${'$ sleep 10 | pwatch'.cyan}
+
+    ${'–'.grey} See all PID for node related processes
+
+      ${'$ pwatch search node'.cyan}
+
+    ${'–'.grey} Notify me when process 4030 ends
+
+      ${'$ pwatch 4030'.cyan}
+
+    ${'–'.grey} Run in background with a &
+
+      ${'$ sleep 10 | pwatch &'.cyan}
+  `);
 }
 
 function handlePid(pid) {
-    if (!pid) {
-        notifier.notify('No pid specified');
-        process.exit(0);
-    }
+  if (!pid) {
+    notifier.notify('No pid specified');
+    process.exit(0);
+  }
+  if (String(pid).match(/search/i)) {
+    search(process.argv[3]);
+  } else if (Number.isNaN(Number(pid))) {
+    help();
+  } else {
     checkPid(pid);
+  }
 }
 
-
 export default function main() {
-    const isCalledViaPipe = !tty.isatty();
-    if (isCalledViaPipe) {
-        handlePiped();
-    } else {
-        handlePid(process.argv[2])
-    }
+  const isCalledViaPipe = !tty.isatty();
+  if (isCalledViaPipe) {
+    handlePiped();
+  } else {
+    handlePid(process.argv[2]);
+  }
 }
 

yarn.lock

@@ -753,6 +753,10 @@ [email protected]:
   version "1.0.3"
   resolved "https://registry.yarnpkg.com/colors/-/colors-1.0.3.tgz#0433f44d809680fdeb60ed260f1b0c262e82a40b"
 
+colors@^1.1.2:
+  version "1.1.2"
+  resolved "https://registry.yarnpkg.com/colors/-/colors-1.1.2.tgz#168a4701756b6a7f51a12ce0c97bfa28c084ed63"
+
 combined-stream@^1.0.5, combined-stream@~1.0.5:
   version "1.0.5"
   resolved "https://registry.yarnpkg.com/combined-stream/-/combined-stream-1.0.5.tgz#938370a57b4a51dea2c77c15d5c5fdf895164009"
@@ -2090,6 +2094,10 @@ prr@~0.0.0:
   version "0.0.0"
   resolved "https://registry.yarnpkg.com/prr/-/prr-0.0.0.tgz#1a84b85908325501411853d0081ee3fa86e2926a"
 
+ps-man@jkrup/node-ps:
+  version "1.1.4"
+  resolved "https://codeload.github.com/jkrup/node-ps/tar.gz/b6070bb6290a2bc6b6aa914aa868724e13cff5c2"
+
 punycode@^1.4.1:
   version "1.4.1"
   resolved "https://registry.yarnpkg.com/punycode/-/punycode-1.4.1.tgz#c0d5a63b2718800ad8e1eb0fa5269c84dd41845e"