@webpod/ps 0.1.4 → 1.0.0

package/README.md

@@ -8,7 +8,7 @@
 * [x] `table-parser` replaced with `@webpod/ingrid` to handle some issues: [neekey/ps#76](https://github.com/neekey/ps/issues/76), [neekey/ps#62](https://github.com/neekey/ps/issues/62), [neekey/table-parser#11](https://github.com/neekey/table-parser/issues/11), [neekey/table-parser#18](https://github.com/neekey/table-parser/issues/18)
 * [x] Provides promisified responses
 * [x] Brings sync API
-* [x] Builds a process tree
+* [x] Builds a process subtree by parent
 
 ## Install
 ```bash
@@ -16,10 +16,13 @@ $ npm install @webpod/ps
 ```
 
 ## Internals
-This module invokes different tools to get process list:
+This module uses different approaches for getting process list:
 
-* `ps` for unix/mac: `ps -lx`
-* [`wmic` for win runtimes](https://learn.microsoft.com/en-us/windows/win32/wmisdk/wmic): `wmic process get ProcessId,CommandLine`.
+| Platform                 | Method                                                                                                                                        |
+|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
+| Unix/Mac                 | `ps -lx`                                                                                                                                      |
+| Windows (kernel >= 26000)| `pwsh -NoProfile -Command "Get-CimInstance Win32_Process \| Select-Object ProcessId,ParentProcessId,CommandLine \| ConvertTo-Json -Compress"` |
+| Windows (kernel < 26000) | [`wmic`](https://learn.microsoft.com/en-us/windows/win32/wmisdk/wmic) `process get ProcessId,CommandLine`                                     |
 
 ## Usage
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webpod/ps",
-  "version": "0.1.4",
+  "version": "1.0.0",
   "description": "A process lookup utility",
   "publishConfig": {
     "access": "public"
@@ -23,10 +23,10 @@
     "build:dts": "tsc --emitDeclarationOnly --outDir target/dts",
     "build:docs": "typedoc --options src/main/typedoc",
     "build:stamp": "npx buildstamp",
-    "test": "concurrently 'npm:test:*'",
+    "test": "concurrently 'npm:test:*' && npm run x:test:legacy",
     "test:lint": "eslint -c src/test/lint/.eslintrc.json src",
     "test:unit": "c8 -r lcov -r text -o target/coverage -x src/scripts -x src/test -x target node --loader ts-node/esm --experimental-specifier-resolution=node src/scripts/test.mjs",
-    "test:legacy": "node ./node_modules/mocha/bin/mocha -t 0 -R spec src/test/legacy/test.cjs",
+    "x:test:legacy": "node ./node_modules/mocha/bin/mocha -t 0 -R spec src/test/legacy/test.cjs",
     "publish:draft": "npm run build && npm publish --no-git-tag-version"
   },
   "files": [
@@ -42,15 +42,15 @@
   ],
   "dependencies": {
     "@webpod/ingrid": "^1.1.1",
-    "zurk": "^0.11.4"
+    "zurk": "^0.11.5"
   },
   "devDependencies": {
-    "@types/node": "^24.0.13",
+    "@types/node": "^24.5.2",
     "c8": "^10.1.3",
-    "concurrently": "^9.2.0",
-    "esbuild": "^0.25.6",
+    "concurrently": "^9.2.1",
+    "esbuild": "^0.25.10",
     "esbuild-node-externals": "^1.18.0",
-    "esbuild-plugin-entry-chunks": "^0.1.15",
+    "esbuild-plugin-entry-chunks": "^0.1.17",
     "eslint": "^8.57.0",
     "eslint-config-qiwi": "^2.1.3",
     "fast-glob": "^3.3.3",
@@ -58,8 +58,8 @@
     "mocha": "^10.8.2",
     "sinon": "^18.0.1",
     "ts-node": "^10.9.2",
-    "typedoc": "^0.28.7",
-    "typescript": "^5.8.3"
+    "typedoc": "^0.28.13",
+    "typescript": "^5.9.2"
   },
   "repository": {
     "type": "git",

package/target/cjs/index.cjs

@@ -62,11 +62,44 @@ module.exports = __toCommonJS(index_exports);
 // src/main/ts/ps.ts
 var import_node_process = __toESM(require("node:process"), 1);
 var import_node_fs = __toESM(require("node:fs"), 1);
-var import_node_os = require("node:os");
+var import_node_os = __toESM(require("node:os"), 1);
 var import_ingrid = require("@webpod/ingrid");
 var import_spawn = require("zurk/spawn");
 var IS_WIN = import_node_process.default.platform === "win32";
-var WMIC_INPUT = "wmic process get ProcessId,ParentProcessId,CommandLine";
+var IS_WIN2025_PLUS = IS_WIN && Number.parseInt(import_node_os.default.release().split(".")[2], 10) >= 26e3;
+var LOOKUPS = {
+  wmic: {
+    cmd: "wmic process get ProcessId,ParentProcessId,CommandLine",
+    args: [],
+    parse(stdout) {
+      return (0, import_ingrid.parse)(removeWmicPrefix(stdout), { format: "win" });
+    }
+  },
+  ps: {
+    cmd: "ps",
+    args: ["-lx"],
+    parse(stdout) {
+      return (0, import_ingrid.parse)(stdout, { format: "unix" });
+    }
+  },
+  pwsh: {
+    cmd: "pwsh",
+    args: ["-NoProfile", "-Command", '"Get-CimInstance Win32_Process | Select-Object ProcessId,ParentProcessId,CommandLine | ConvertTo-Json -Compress"'],
+    parse(stdout) {
+      let arr = [];
+      try {
+        arr = JSON.parse(stdout);
+      } catch (e) {
+        return [];
+      }
+      return arr.map((p) => ({
+        ProcessId: [p.ProcessId + ""],
+        ParentProcessId: [p.ParentProcessId + ""],
+        CommandLine: p.CommandLine ? [p.CommandLine] : []
+      }));
+    }
+  }
+};
 var isBin = (f) => {
   if (f === "") return false;
   if (!f.includes("/") && !f.includes("\\")) return true;
@@ -90,42 +123,35 @@ var _lookup = ({
 }) => {
   const pFactory = sync ? makePseudoDeferred.bind(null, []) : makeDeferred;
   const { promise, resolve, reject } = pFactory();
-  const { psargs = ["-lx"] } = query;
-  const args = Array.isArray(psargs) ? psargs : psargs.split(/\s+/);
   const result = [];
-  const extract = IS_WIN ? removeWmicPrefix : identity;
+  const lookupFlow = IS_WIN ? IS_WIN2025_PLUS ? "pwsh" : "wmic" : "ps";
+  const {
+    parse: parse2,
+    cmd,
+    args
+  } = LOOKUPS[lookupFlow];
   const callback = (err, { stdout }) => {
     if (err) {
       reject(err);
       cb(err);
       return;
     }
-    result.push(...parseProcessList(extract(stdout), query));
+    result.push(...filterProcessList(normalizeOutput(parse2(stdout)), query));
     resolve(result);
     cb(null, result);
   };
-  const ctx = IS_WIN ? {
-    cmd: WMIC_INPUT,
-    args: [],
-    callback,
-    sync,
-    run(cb2) {
-      cb2();
-    }
-  } : {
-    cmd: "ps",
+  (0, import_spawn.exec)({
+    cmd,
     args,
     callback,
     sync,
     run(cb2) {
       cb2();
     }
-  };
-  (0, import_spawn.exec)(ctx);
+  });
   return Object.assign(promise, result);
 };
-var parseProcessList = (output, query = {}) => {
-  const processList = parseGrid(output);
+var filterProcessList = (processList, query = {}) => {
   const pidList = (query.pid === void 0 ? [] : [query.pid].flat(1)).map((v) => v + "");
   const filters = [
     (p) => query.command ? new RegExp(query.command, "i").test(p.command) : true,
@@ -137,9 +163,9 @@ var parseProcessList = (output, query = {}) => {
   );
 };
 var removeWmicPrefix = (stdout) => {
-  const s = stdout.indexOf(WMIC_INPUT + import_node_os.EOL);
-  const e = stdout.includes(">") ? stdout.trimEnd().lastIndexOf(import_node_os.EOL) : stdout.length;
-  return (s > 0 ? stdout.slice(s + WMIC_INPUT.length, e) : stdout.slice(0, e)).trimStart();
+  const s = stdout.indexOf(LOOKUPS.wmic.cmd + import_node_os.default.EOL);
+  const e = stdout.includes(">") ? stdout.trimEnd().lastIndexOf(import_node_os.default.EOL) : stdout.length;
+  return (s > 0 ? stdout.slice(s + LOOKUPS.wmic.cmd.length, e) : stdout.slice(0, e)).trimStart();
 };
 var pickTree = (list, pid, recursive = false) => {
   const children = list.filter((p) => p.ppid === pid + "");
@@ -233,11 +259,10 @@ var kill = (pid, opts, next) => {
   }
   return promise;
 };
-var parseGrid = (output) => output ? formatOutput((0, import_ingrid.parse)(output, { format: IS_WIN ? "win" : "unix" })) : [];
-var formatOutput = (data) => data.reduce((m, d) => {
-  var _a, _b, _c, _d;
-  const pid = ((_a = d.PID) == null ? void 0 : _a[0]) || ((_b = d.ProcessId) == null ? void 0 : _b[0]);
-  const ppid = ((_c = d.PPID) == null ? void 0 : _c[0]) || ((_d = d.ParentProcessId) == null ? void 0 : _d[0]);
+var normalizeOutput = (data) => data.reduce((m, d) => {
+  var _a, _b;
+  const pid = (_a = d.PID || d.ProcessId) == null ? void 0 : _a[0];
+  const ppid = (_b = d.PPID || d.ParentProcessId) == null ? void 0 : _b[0];
   const _cmd = d.CMD || d.CommandLine || d.COMMAND || [];
   const cmd = _cmd.length === 1 ? _cmd[0].split(/\s+/) : _cmd;
   if (pid && cmd.length > 0) {

package/target/dts/ps.d.ts

@@ -1,4 +1,4 @@
-import { TIngridResponse } from '@webpod/ingrid';
+import { type TIngridResponse } from '@webpod/ingrid';
 export type TPsLookupCallback = (err: any, processList?: TPsLookupEntry[]) => void;
 export type TPsLookupEntry = {
     pid: string;
@@ -11,7 +11,6 @@ export type TPsLookupQuery = {
     command?: string;
     arguments?: string;
     ppid?: number | string;
-    psargs?: string | string[];
 };
 export type TPsKillOptions = {
     timeout?: number;
@@ -43,7 +42,7 @@ export declare const lookup: {
  * @return {TPsLookupEntry[]}
  */
 export declare const lookupSync: (query?: TPsLookupQuery, cb?: TPsLookupCallback) => TPsLookupEntry[];
-export declare const parseProcessList: (output: string, query?: TPsLookupQuery) => TPsLookupEntry[];
+export declare const filterProcessList: (processList: TPsLookupEntry[], query?: TPsLookupQuery) => TPsLookupEntry[];
 export declare const removeWmicPrefix: (stdout: string) => string;
 export type TPsTreeOpts = {
     pid: string | number;
@@ -64,6 +63,5 @@ export declare const treeSync: (opts?: string | number | TPsTreeOpts | undefined
  * @param next
  */
 export declare const kill: (pid: string | number, opts?: TPsNext | TPsKillOptions | TPsKillOptions["signal"], next?: TPsNext) => Promise<void>;
-export declare const parseGrid: (output: string) => TPsLookupEntry[];
-export declare const formatOutput: (data: TIngridResponse) => TPsLookupEntry[];
+export declare const normalizeOutput: (data: TIngridResponse) => TPsLookupEntry[];
 export type PromiseResolve<T = any> = (value?: T | PromiseLike<T>) => void;

package/target/esm/index.mjs

@@ -1,11 +1,44 @@
 // src/main/ts/ps.ts
 import process from "node:process";
 import fs from "node:fs";
-import { EOL as SystemEOL } from "node:os";
+import os from "node:os";
 import { parse } from "@webpod/ingrid";
 import { exec } from "zurk/spawn";
 var IS_WIN = process.platform === "win32";
-var WMIC_INPUT = "wmic process get ProcessId,ParentProcessId,CommandLine";
+var IS_WIN2025_PLUS = IS_WIN && Number.parseInt(os.release().split(".")[2], 10) >= 26e3;
+var LOOKUPS = {
+  wmic: {
+    cmd: "wmic process get ProcessId,ParentProcessId,CommandLine",
+    args: [],
+    parse(stdout) {
+      return parse(removeWmicPrefix(stdout), { format: "win" });
+    }
+  },
+  ps: {
+    cmd: "ps",
+    args: ["-lx"],
+    parse(stdout) {
+      return parse(stdout, { format: "unix" });
+    }
+  },
+  pwsh: {
+    cmd: "pwsh",
+    args: ["-NoProfile", "-Command", '"Get-CimInstance Win32_Process | Select-Object ProcessId,ParentProcessId,CommandLine | ConvertTo-Json -Compress"'],
+    parse(stdout) {
+      let arr = [];
+      try {
+        arr = JSON.parse(stdout);
+      } catch {
+        return [];
+      }
+      return arr.map((p) => ({
+        ProcessId: [p.ProcessId + ""],
+        ParentProcessId: [p.ParentProcessId + ""],
+        CommandLine: p.CommandLine ? [p.CommandLine] : []
+      }));
+    }
+  }
+};
 var isBin = (f) => {
   if (f === "") return false;
   if (!f.includes("/") && !f.includes("\\")) return true;
@@ -29,42 +62,35 @@ var _lookup = ({
 }) => {
   const pFactory = sync ? makePseudoDeferred.bind(null, []) : makeDeferred;
   const { promise, resolve, reject } = pFactory();
-  const { psargs = ["-lx"] } = query;
-  const args = Array.isArray(psargs) ? psargs : psargs.split(/\s+/);
   const result = [];
-  const extract = IS_WIN ? removeWmicPrefix : identity;
+  const lookupFlow = IS_WIN ? IS_WIN2025_PLUS ? "pwsh" : "wmic" : "ps";
+  const {
+    parse: parse2,
+    cmd,
+    args
+  } = LOOKUPS[lookupFlow];
   const callback = (err, { stdout }) => {
     if (err) {
       reject(err);
       cb(err);
       return;
     }
-    result.push(...parseProcessList(extract(stdout), query));
+    result.push(...filterProcessList(normalizeOutput(parse2(stdout)), query));
     resolve(result);
     cb(null, result);
   };
-  const ctx = IS_WIN ? {
-    cmd: WMIC_INPUT,
-    args: [],
-    callback,
-    sync,
-    run(cb2) {
-      cb2();
-    }
-  } : {
-    cmd: "ps",
+  exec({
+    cmd,
     args,
     callback,
     sync,
     run(cb2) {
       cb2();
     }
-  };
-  exec(ctx);
+  });
   return Object.assign(promise, result);
 };
-var parseProcessList = (output, query = {}) => {
-  const processList = parseGrid(output);
+var filterProcessList = (processList, query = {}) => {
   const pidList = (query.pid === void 0 ? [] : [query.pid].flat(1)).map((v) => v + "");
   const filters = [
     (p) => query.command ? new RegExp(query.command, "i").test(p.command) : true,
@@ -76,9 +102,9 @@ var parseProcessList = (output, query = {}) => {
   );
 };
 var removeWmicPrefix = (stdout) => {
-  const s = stdout.indexOf(WMIC_INPUT + SystemEOL);
-  const e = stdout.includes(">") ? stdout.trimEnd().lastIndexOf(SystemEOL) : stdout.length;
-  return (s > 0 ? stdout.slice(s + WMIC_INPUT.length, e) : stdout.slice(0, e)).trimStart();
+  const s = stdout.indexOf(LOOKUPS.wmic.cmd + os.EOL);
+  const e = stdout.includes(">") ? stdout.trimEnd().lastIndexOf(os.EOL) : stdout.length;
+  return (s > 0 ? stdout.slice(s + LOOKUPS.wmic.cmd.length, e) : stdout.slice(0, e)).trimStart();
 };
 var pickTree = (list, pid, recursive = false) => {
   const children = list.filter((p) => p.ppid === pid + "");
@@ -170,10 +196,9 @@ var kill = (pid, opts, next) => {
   }
   return promise;
 };
-var parseGrid = (output) => output ? formatOutput(parse(output, { format: IS_WIN ? "win" : "unix" })) : [];
-var formatOutput = (data) => data.reduce((m, d) => {
-  const pid = d.PID?.[0] || d.ProcessId?.[0];
-  const ppid = d.PPID?.[0] || d.ParentProcessId?.[0];
+var normalizeOutput = (data) => data.reduce((m, d) => {
+  const pid = (d.PID || d.ProcessId)?.[0];
+  const ppid = (d.PPID || d.ParentProcessId)?.[0];
   const _cmd = d.CMD || d.CommandLine || d.COMMAND || [];
   const cmd = _cmd.length === 1 ? _cmd[0].split(/\s+/) : _cmd;
   if (pid && cmd.length > 0) {