xsh 1.1.6 → 1.1.8

package/README.md

@@ -28,8 +28,6 @@ const xsh = require("xsh");
 xsh.exec("echo hello");
 ```
 
-The shell commands under `xsh.$` come from [shelljs](https://www.npmjs.com/package/shelljs).
-
 ## API
 
 ### `Promise`
@@ -63,7 +61,10 @@ Both return the string `"echo hello"`.
 xsh.exec(shellCommand, [options], [callback] );
 ```
 
-Use [shelljs `exec`] to execute `shellCommand` in `async` mode.
+Execute `shellCommand` asynchronously with Node.js
+[`child_process.exec`](https://nodejs.org/api/child_process.html#child_processexeccommand-options-callback).
+`xsh.exec` adds flexible command fragments, a callback/error shape, and a thenable result that
+also exposes the child process and its output streams.
 
 #### Arguments
 
@@ -72,8 +73,9 @@ Use [shelljs `exec`] to execute `shellCommand` in `async` mode.
 -   `options` - optional `options`
 
     -   If it's either `true` or `false`, it sets `silent` flag for output to console.
-    -   It can also be an object that's passed to [NodeJS exec](https://nodejs.org/api/child_process.html#child_process_child_process_exec_command_options_callback).
-        -   For example, it can be `{silent: true}`
+    -   It can also be an object with `silent` and any option accepted by
+        [Node.js `exec`](https://nodejs.org/api/child_process.html#child_processexeccommand-options-callback).
+    -   `maxBuffer` defaults to 20 MiB.
     -   This can be the first, last, or second to last (if last is the callback) argument.
 
 -   `callback` - optional, if provided, it will be called as follows:
@@ -161,25 +163,20 @@ If `path` doesn't exist in `process.env.PATH` then it's added to the end.
 
 If you don't want to operate on `process.env` you can pass in a second argument that's either an object or a string that's the path to change.
 
-### [`$`](#)
-
-An instance of [shelljs].
+### [pushd](#pushd) / [popd](#popd)
 
 ```js
-const xsh = require("xsh");
-xsh.$.cd("/tmp");
+xsh.pushd(dir);
+// ...
+xsh.popd();
 ```
 
-[shelljs `exec`]: http://documentup.com/shelljs/shelljs#execcommand--options--callback
-
-[shelljs]: https://github.com/shelljs/shelljs
-
-
+`pushd` saves `process.cwd()` on a stack, then `chdir`s into `dir`, returning the new cwd.
+`popd` `chdir`s back to the directory most recently saved by `pushd`, returning it. `popd`
+throws if the stack is empty.
 
 [npm-image]: https://badge.fury.io/js/xsh.svg
 
 [npm-url]: https://npmjs.org/package/xsh
 
 
-
-

package/dist/exec.d.ts

@@ -1,4 +1,4 @@
-import type { ChildProcess } from "node:child_process";
+import { type ChildProcess } from "node:child_process";
 export interface ExecOutput {
     stdout: string;
     stderr: string;
@@ -9,7 +9,7 @@ export interface ExecError extends Error {
 }
 export type ExecCallback = (err: ExecError | null, output: ExecOutput) => void;
 /**
- * Options passed through to shelljs `exec` (`async: true` is always set).
+ * Options passed through to Node.js `child_process.exec`.
  * A plain boolean is shorthand for `{ silent: boolean }`.
  */
 export interface ExecOptions {
@@ -31,13 +31,13 @@ export interface ExecResult {
     stderr: ChildProcess["stderr"];
 }
 /**
- * Execute a shell command with shelljs `exec` in async mode.
+ * Execute a shell command with Node.js `child_process.exec`.
  *
  * Arguments can be any mix of command fragments (strings / arrays of strings,
  * joined with `" "`), one options object or boolean (silent shorthand) as the
  * first, last, or second to last argument, and a callback as the last argument.
  *
- * Returns the shelljs child process when a callback is given, else an
+ * Returns the child process when a callback is given, else an
  * {@link ExecResult} thenable.
  */
 export declare function exec(...args: Array<ExecFragment | ExecOptions | boolean>): ExecResult;

package/dist/exec.js

@@ -1,6 +1,7 @@
-import shell from "shelljs";
 import assert from "node:assert";
+import { exec as childExec } from "node:child_process";
 import { util } from "./util.js";
+const DEFAULT_MAX_BUFFER = 20 * 1024 * 1024;
 export function exec(...args) {
     const error = (cmd, code, output) => {
         const err = new Error(`shell cmd '${cmd}' exit code ${code}`);
@@ -53,11 +54,27 @@ export function exec(...args) {
         s = " ";
         return a;
     }, "");
-    const doExec = (xcb) => shell.exec(cmd, Object.assign({ async: true }, options), (code, stdout, stderr) => {
-        const output = { stdout, stderr };
-        const err = code === 0 ? null : error(cmd, code, output);
-        xcb(err, output);
-    });
+    const doExec = (xcb) => {
+        const { silent = false, async: _async, fatal: _fatal, ...execOptions } = options;
+        const child = childExec(cmd, Object.assign({
+            cwd: process.cwd(),
+            env: process.env,
+            maxBuffer: DEFAULT_MAX_BUFFER,
+            encoding: "utf8"
+        }, execOptions), (execErr, stdout, stderr) => {
+            const output = { stdout, stderr };
+            const code = execErr ? execErr.code : 0;
+            /* v8 ignore next -- @preserve Node execution errors normally provide a code. */
+            const exitCode = code === undefined ? 1 : code;
+            const err = exitCode === 0 ? null : error(cmd, exitCode, output);
+            xcb(err, output);
+        });
+        if (!silent) {
+            child.stdout?.pipe(process.stdout);
+            child.stderr?.pipe(process.stderr);
+        }
+        return child;
+    };
     if (cb) {
         return doExec(cb);
     }

package/dist/index.d.ts

@@ -1,10 +1,10 @@
-import shell from "shelljs";
 import { exec } from "./exec.ts";
 import { env } from "./env.ts";
 import { envPath } from "./env-path.ts";
 import { mkCmd } from "./mkcmd.ts";
 import { pathCwd } from "./path-cwd.ts";
 import { pathCwdNm } from "./path-cwd-nm.ts";
+import { pushd, popd } from "./pushd.ts";
 export type { ExecOutput, ExecError, ExecCallback, ExecOptions, ExecFragment, ExecArg, ExecResult } from "./exec.ts";
 export type { EnvContainer } from "./env-path.ts";
 export interface Xsh {
@@ -14,13 +14,12 @@ export interface Xsh {
     mkCmd: typeof mkCmd;
     pathCwd: typeof pathCwd;
     pathCwdNm: typeof pathCwdNm;
-    /** the shelljs instance xsh uses */
-    $: typeof shell;
+    pushd: typeof pushd;
+    popd: typeof popd;
     /** Promise implementation used by exec - set to null to restore native Promise */
     Promise: PromiseConstructor;
 }
 declare const xsh: Xsh;
-export { exec, env, envPath, mkCmd, pathCwd, pathCwdNm };
-export declare const $: typeof shell;
+export { exec, env, envPath, mkCmd, pathCwd, pathCwdNm, pushd, popd };
 export default xsh;
 export { xsh as "module.exports" };

package/dist/index.js

@@ -1,4 +1,3 @@
-import shell from "shelljs";
 import { util } from "./util.js";
 import { exec } from "./exec.js";
 import { env } from "./env.js";
@@ -6,6 +5,7 @@ import { envPath } from "./env-path.js";
 import { mkCmd } from "./mkcmd.js";
 import { pathCwd } from "./path-cwd.js";
 import { pathCwdNm } from "./path-cwd-nm.js";
+import { pushd, popd } from "./pushd.js";
 const xsh = {
     exec,
     env,
@@ -13,7 +13,8 @@ const xsh = {
     mkCmd,
     pathCwd,
     pathCwdNm,
-    $: shell
+    pushd,
+    popd
 };
 Object.defineProperty(xsh, "Promise", {
     set: p => {
@@ -21,8 +22,7 @@ Object.defineProperty(xsh, "Promise", {
     },
     get: () => util.Promise
 });
-export { exec, env, envPath, mkCmd, pathCwd, pathCwdNm };
-export const $ = shell;
+export { exec, env, envPath, mkCmd, pathCwd, pathCwdNm, pushd, popd };
 export default xsh;
 // make `require("xsh")` in CJS consumers (node >=22.12 require(esm)) return the
 // xsh object itself - same shape as the historical module.exports - instead of

package/dist/pushd.d.ts

@@ -0,0 +1,4 @@
+/** Save the current working directory on a stack, then `chdir` into `dir`. */
+export declare function pushd(dir: string): string;
+/** `chdir` back to the directory most recently saved by {@link pushd}. */
+export declare function popd(): string;

package/dist/pushd.js

@@ -0,0 +1,15 @@
+import assert from "node:assert";
+const stack = [];
+/** Save the current working directory on a stack, then `chdir` into `dir`. */
+export function pushd(dir) {
+    stack.push(process.cwd());
+    process.chdir(dir);
+    return process.cwd();
+}
+/** `chdir` back to the directory most recently saved by {@link pushd}. */
+export function popd() {
+    const dir = stack.pop();
+    assert(dir !== undefined, "xsh.popd: directory stack is empty");
+    process.chdir(dir);
+    return dir;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xsh",
-  "version": "1.1.6",
+  "version": "1.1.8",
   "description": "Some random NodeJS helper functions for shell execution",
   "type": "module",
   "types": "./dist/index.d.ts",
@@ -39,22 +39,17 @@
   "keywords": [
     "shell",
     "exec",
-    "shelljs",
     "env",
     "PATH"
   ],
   "author": "Joel Chen",
   "license": "Apache-2.0",
-  "dependencies": {
-    "shelljs": "^0.10.0"
-  },
   "devDependencies": {
     "@types/node": "^26.4.1",
-    "@types/shelljs": "^0.10.0",
     "@vitest/coverage-v8": "^5.0.0",
-    "aveazul": "^2.1.6",
-    "publish-util": "^3.1.5",
-    "run-verify": "^2.1.6",
+    "aveazul": "^2.1.8",
+    "publish-util": "^3.1.7",
+    "run-verify": "^2.1.8",
     "typescript": "^7.0.2",
     "vite": "^8.2.2",
     "vitest": "^5.0.0"