xsh 0.4.6 → 1.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2017 Joel Chen
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,5 +1,4 @@
-[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url]
-[![Dependency Status][daviddm-image]][daviddm-url] [![devDependency Status][daviddm-dev-image]][daviddm-dev-url]
+[![NPM version][npm-image]][npm-url]
 
 # xsh
 
@@ -13,12 +12,24 @@ npm install xsh --save-dev
 
 ## Usage
 
+xsh >= 1.0.0 is an ES module written in TypeScript, requiring node >= 22.12.
+
+```js
+import xsh from "xsh";
+
+xsh.exec("echo hello");
+```
+
+CJS consumers can still `require` it (node >= 22.12 `require(esm)`):
+
 ```js
 const xsh = require("xsh");
 
 xsh.exec("echo hello");
 ```
 
+The shell commands under `xsh.$` come from [shelljs](https://www.npmjs.com/package/shelljs).
+
 ## API
 
 ### `Promise`
@@ -26,7 +37,9 @@ xsh.exec("echo hello");
 You can set a custom `Promise` with:
 
 ```js
-xsh.Promise = require("bluebird");
+import AveAzul from "aveazul";
+
+xsh.Promise = AveAzul;
 ```
 
 Or set to the native `Promise` with:
@@ -161,18 +174,12 @@ xsh.$.cd("/tmp");
 
 [shelljs]: https://github.com/shelljs/shelljs
 
-[travis-image]: https://travis-ci.org/jchip/xsh.svg?branch=master
 
-[travis-url]: https://travis-ci.org/jchip/xsh
 
 [npm-image]: https://badge.fury.io/js/xsh.svg
 
 [npm-url]: https://npmjs.org/package/xsh
 
-[daviddm-image]: https://david-dm.org/jchip/xsh/status.svg
 
-[daviddm-url]: https://david-dm.org/jchip/xsh
 
-[daviddm-dev-image]: https://david-dm.org/jchip/xsh/dev-status.svg
 
-[daviddm-dev-url]: https://david-dm.org/jchip/xsh?type=dev

package/dist/env-path.d.ts

@@ -0,0 +1,39 @@
+/** an env container like `process.env` */
+export type EnvContainer = Record<string, string | undefined>;
+/**
+ * Find the key for the PATH variable in `env` - case insensitive fallback for
+ * platforms (Windows) where it's not exactly `PATH`.
+ */
+export declare function findEnvKey(env: EnvContainer, key?: string): string | undefined;
+export declare const envKey: string;
+/**
+ * Add `p` to the front of PATH in `env`, removing any existing occurrences.
+ *
+ * @param p path to add
+ * @param env env container, a PATH string, or undefined for `process.env`
+ * @returns the updated PATH string
+ */
+export declare function addToFront(p: string | null | undefined, env?: EnvContainer | string): string;
+/**
+ * Add `p` to the end of PATH in `env`, removing any existing occurrences.
+ *
+ * @param p path to add
+ * @param env env container, a PATH string, or undefined for `process.env`
+ * @returns the updated PATH string
+ */
+export declare function addToEnd(p?: string | null, env?: EnvContainer | string): string;
+/**
+ * Add `p` to the end of PATH in `env` only if it's not already in there.
+ *
+ * @param p path to add
+ * @param env env container, a PATH string, or undefined for `process.env`
+ * @returns the updated PATH string
+ */
+export declare function add(p?: string | null, env?: EnvContainer | string): string;
+export declare const envPath: {
+    addToFront: typeof addToFront;
+    addToEnd: typeof addToEnd;
+    add: typeof add;
+    envKey: string;
+    findEnvKey: typeof findEnvKey;
+};

package/dist/env-path.js

@@ -0,0 +1,89 @@
+import Path from "node:path";
+const pathDelim = Path.delimiter;
+const defaultEnvKey = process.platform === "win32" ? "Path" : "PATH";
+/**
+ * Find the key for the PATH variable in `env` - case insensitive fallback for
+ * platforms (Windows) where it's not exactly `PATH`.
+ */
+export function findEnvKey(env, key) {
+    if (!key || !Object.prototype.hasOwnProperty.call(env, key)) {
+        for (const x of Object.keys(env)) {
+            if (x.toLowerCase() === "path") {
+                key = x;
+                break;
+            }
+        }
+    }
+    return key;
+}
+export const envKey = findEnvKey(process.env, defaultEnvKey);
+function check(env) {
+    // allow calls like this: envPath.add("addition_path", "existing_path");
+    if (typeof env === "string") {
+        env = { [envKey]: env };
+    }
+    else if (!env) {
+        env = process.env;
+    }
+    return env;
+}
+/**
+ * Add `p` to the front of PATH in `env`, removing any existing occurrences.
+ *
+ * @param p path to add
+ * @param env env container, a PATH string, or undefined for `process.env`
+ * @returns the updated PATH string
+ */
+export function addToFront(p, env) {
+    env = check(env);
+    let update = env[envKey] || "";
+    if (typeof p === "string" && p) {
+        update = update.trim();
+        const paths = update.split(pathDelim).filter(x => x && x !== p);
+        paths.unshift(p);
+        update = paths.join(pathDelim);
+    }
+    env[envKey] = update;
+    return update;
+}
+/**
+ * Add `p` to the end of PATH in `env`, removing any existing occurrences.
+ *
+ * @param p path to add
+ * @param env env container, a PATH string, or undefined for `process.env`
+ * @returns the updated PATH string
+ */
+export function addToEnd(p, env) {
+    env = check(env);
+    let update = env[envKey] || "";
+    if (typeof p === "string" && p) {
+        update = update.trim();
+        const paths = update.split(pathDelim).filter(x => x && x !== p);
+        paths.push(p);
+        update = paths.join(pathDelim);
+    }
+    env[envKey] = update;
+    return update;
+}
+/**
+ * Add `p` to the end of PATH in `env` only if it's not already in there.
+ *
+ * @param p path to add
+ * @param env env container, a PATH string, or undefined for `process.env`
+ * @returns the updated PATH string
+ */
+export function add(p, env) {
+    env = check(env);
+    let update = env[envKey] || "";
+    if (typeof p === "string" && p) {
+        update = update.trim();
+        const paths = update.split(pathDelim).filter(x => x);
+        if (paths.indexOf(p) < 0) {
+            paths.push(p);
+            update = paths.join(pathDelim);
+        }
+    }
+    env[envKey] = update;
+    return update;
+}
+export const envPath = { addToFront, addToEnd, add, envKey, findEnvKey };

package/dist/env.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Get an environment variable
+ *
+ * @param name env variable name
+ * @param valWhenUndef value to return if the variable is not defined
+ */
+export declare function get(name: string, valWhenUndef?: string): string | undefined;
+/**
+ * Get an environment variable as a boolean.  `"true"`, `"1"`, `"yes"`, `"on"`
+ * (case insensitive) are `true`, anything else is `false`.
+ *
+ * @param name env variable name
+ * @param valWhenUndef value to return if the variable is not defined - must be
+ *   a boolean, else `false` is returned
+ */
+export declare function getAsBool(name: string, valWhenUndef?: unknown): boolean;
+/**
+ * Get an environment variable as an integer.
+ *
+ * @param name env variable name
+ * @param valWhenUndef value to return if the variable is not defined or can't
+ *   be parsed - must be a number, else `NaN` is returned
+ */
+export declare function getAsInt(name: string, valWhenUndef?: unknown): number;
+export declare const env: {
+    get: typeof get;
+    getAsBool: typeof getAsBool;
+    getAsInt: typeof getAsInt;
+};

package/dist/env.js

@@ -0,0 +1,50 @@
+/**
+ * Get an environment variable
+ *
+ * @param name env variable name
+ * @param valWhenUndef value to return if the variable is not defined
+ */
+export function get(name, valWhenUndef) {
+    const x = process.env[name];
+    return x === undefined ? valWhenUndef : x;
+}
+/**
+ * Get an environment variable as a boolean.  `"true"`, `"1"`, `"yes"`, `"on"`
+ * (case insensitive) are `true`, anything else is `false`.
+ *
+ * @param name env variable name
+ * @param valWhenUndef value to return if the variable is not defined - must be
+ *   a boolean, else `false` is returned
+ */
+export function getAsBool(name, valWhenUndef) {
+    const x = process.env[name];
+    if (x === undefined) {
+        if (typeof valWhenUndef === "boolean") {
+            return valWhenUndef;
+        }
+        return false;
+    }
+    const b = x.toLowerCase();
+    return b === "true" || b === "1" || b === "yes" || b === "on";
+}
+/**
+ * Get an environment variable as an integer.
+ *
+ * @param name env variable name
+ * @param valWhenUndef value to return if the variable is not defined or can't
+ *   be parsed - must be a number, else `NaN` is returned
+ */
+export function getAsInt(name, valWhenUndef) {
+    let n = NaN;
+    const x = process.env[name];
+    if (x !== undefined) {
+        n = +x;
+        if (!isNaN(n))
+            return n;
+    }
+    if (typeof valWhenUndef === "number") {
+        return valWhenUndef;
+    }
+    return n;
+}
+export const env = { get, getAsBool, getAsInt };

package/dist/esc-regex.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Escape a string for literal use inside a RegExp.
+ *
+ * Paths routinely carry regex metacharacters - a `.` in a dot directory, `+`
+ * or parens in a project name, `\` separators on Windows - so interpolating
+ * one raw either silently mismatches or throws a SyntaxError.
+ */
+export declare const escapeRegExp: (x: string) => string;

package/dist/esc-regex.js

@@ -0,0 +1,8 @@
+/**
+ * Escape a string for literal use inside a RegExp.
+ *
+ * Paths routinely carry regex metacharacters - a `.` in a dot directory, `+`
+ * or parens in a project name, `\` separators on Windows - so interpolating
+ * one raw either silently mismatches or throws a SyntaxError.
+ */
+export const escapeRegExp = (x) => x.replace(/[\\^$.*+?()[\]{}|]/g, "\\$&");

package/dist/exec.d.ts

@@ -0,0 +1,44 @@
+import type { ChildProcess } from "node:child_process";
+export interface ExecOutput {
+    stdout: string;
+    stderr: string;
+}
+export interface ExecError extends Error {
+    output: ExecOutput;
+    code: number;
+}
+export type ExecCallback = (err: ExecError | null, output: ExecOutput) => void;
+/**
+ * Options passed through to shelljs `exec` (`async: true` is always set).
+ * A plain boolean is shorthand for `{ silent: boolean }`.
+ */
+export interface ExecOptions {
+    silent?: boolean;
+    env?: Record<string, string | undefined>;
+    cwd?: string;
+    [key: string]: unknown;
+}
+/** command fragments: arrays of strings are joined with `" "` */
+export type ExecFragment = string | string[];
+export type ExecArg = ExecFragment | ExecOptions | ExecCallback | boolean;
+/** thenable returned by `exec` when no callback is given */
+export interface ExecResult {
+    then: <T = ExecOutput, R = never>(onFulfill?: ((output: ExecOutput) => T | PromiseLike<T>) | null, onReject?: ((err: ExecError) => R | PromiseLike<R>) | null) => Promise<T | R>;
+    catch: <R = never>(onReject?: ((err: ExecError) => R | PromiseLike<R>) | null) => Promise<ExecOutput | R>;
+    promise: Promise<ExecOutput>;
+    child: ChildProcess;
+    stdout: ChildProcess["stdout"];
+    stderr: ChildProcess["stderr"];
+}
+/**
+ * Execute a shell command with shelljs `exec` in async mode.
+ *
+ * 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
+ * {@link ExecResult} thenable.
+ */
+export declare function exec(...args: Array<ExecFragment | ExecOptions | boolean>): ExecResult;
+export declare function exec(...args: [...ExecArg[], ExecCallback]): ChildProcess;

package/dist/exec.js

@@ -0,0 +1,77 @@
+import shell from "shelljs";
+import assert from "node:assert";
+import { util } from "./util.js";
+export function exec(...args) {
+    const error = (cmd, code, output) => {
+        const err = new Error(`shell cmd '${cmd}' exit code ${code}`);
+        err.output = output;
+        err.code = code;
+        return err;
+    };
+    const len = args.length;
+    let cb;
+    let options;
+    const cmdFragments = [];
+    for (let i = 0; i < len; i++) {
+        const arg = args[i];
+        const tof = typeof arg;
+        if (tof === "string" || Array.isArray(arg)) {
+            cmdFragments.push(arg);
+        }
+        else if (tof === "function") {
+            assert(i + 1 === len, "xsh.exec: callback must be the last argument");
+            cb = arg;
+        }
+        else if (tof === "boolean" || (tof === "object" && arg !== null)) {
+            assert(i === 0 || len - i === 1 || len - i === 2, "xsh.exec: options must be the first, last, or second to last argument");
+            options = arg;
+        }
+        else {
+            throw new Error("xsh.exec: command fragment must be an array or string");
+        }
+    }
+    //
+    // Dispatch on `typeof`, not `constructor.name`: the latter threw a TypeError on `null` and on
+    // `Object.create(null)` options, and rejected class-instance options that structurally satisfy
+    // ExecOptions - so the declared type accepted arguments the runtime did not.
+    //
+    if (options === undefined) {
+        options = { silent: false };
+    }
+    else if (typeof options === "boolean") {
+        options = { silent: options };
+    }
+    if (cmdFragments.length < 1) {
+        throw new Error("xsh.exec: expects at least one command fragment");
+    }
+    let s = "";
+    const cmd = cmdFragments.reduce((a, x) => {
+        if (Array.isArray(x)) {
+            x = x.join(" ");
+        }
+        a = `${a}${s}${x}`;
+        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);
+    });
+    if (cb) {
+        return doExec(cb);
+    }
+    let child;
+    assert(util.Promise, "xsh.exec: No Promise available - see doc on setting one");
+    const promise = new util.Promise((resolve, reject) => {
+        child = doExec((err, output) => (err ? reject(err) : resolve(output)));
+    });
+    return {
+        then: (a, b) => promise.then(a, b),
+        catch: (a) => promise.catch(a),
+        promise,
+        child,
+        stdout: child.stdout,
+        stderr: child.stderr
+    };
+}

package/dist/index.d.ts

@@ -0,0 +1,26 @@
+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";
+export type { ExecOutput, ExecError, ExecCallback, ExecOptions, ExecFragment, ExecArg, ExecResult } from "./exec.ts";
+export type { EnvContainer } from "./env-path.ts";
+export interface Xsh {
+    exec: typeof exec;
+    env: typeof env;
+    envPath: typeof envPath;
+    mkCmd: typeof mkCmd;
+    pathCwd: typeof pathCwd;
+    pathCwdNm: typeof pathCwdNm;
+    /** the shelljs instance xsh uses */
+    $: typeof shell;
+    /** 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 default xsh;
+export { xsh as "module.exports" };

package/dist/index.js

@@ -0,0 +1,30 @@
+import shell from "shelljs";
+import { util } from "./util.js";
+import { exec } from "./exec.js";
+import { env } from "./env.js";
+import { envPath } from "./env-path.js";
+import { mkCmd } from "./mkcmd.js";
+import { pathCwd } from "./path-cwd.js";
+import { pathCwdNm } from "./path-cwd-nm.js";
+const xsh = {
+    exec,
+    env,
+    envPath,
+    mkCmd,
+    pathCwd,
+    pathCwdNm,
+    $: shell
+};
+Object.defineProperty(xsh, "Promise", {
+    set: p => {
+        util.Promise = p || Promise;
+    },
+    get: () => util.Promise
+});
+export { exec, env, envPath, mkCmd, pathCwd, pathCwdNm };
+export const $ = shell;
+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
+// the module namespace.
+export { xsh as "module.exports" };

package/dist/mkcmd.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Make a command string: a single array of strings is joined with `" "`,
+ * otherwise all arguments are joined with `" "`.
+ */
+export declare function mkCmd(...args: Array<string | string[]>): string;

package/dist/mkcmd.js

@@ -0,0 +1,8 @@
+/**
+ * Make a command string: a single array of strings is joined with `" "`,
+ * otherwise all arguments are joined with `" "`.
+ */
+export function mkCmd(...args) {
+    const a = args[0];
+    return Array.isArray(a) ? a.join(" ") : args.join(" ");
+}

package/dist/path-cwd-nm.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Remove occurrences of CWD/node_modules from `p`.
+ *
+ * @param p path string to process
+ * @param flags RegExp flags, ie: `"g"`
+ */
+declare function remove(p: string, flags?: string): string;
+/**
+ * Replace occurrences of CWD/node_modules in `p` with `str` (default
+ * `"CWD/~"`), and any remaining `/node_modules/` with `/~/`.
+ *
+ * @param p path string to process
+ * @param str replacement - non-string means use `"CWD/~"`
+ * @param flags RegExp flags, ie: `"g"`
+ */
+declare function replace(p: string, str?: string | null | false, flags?: string): string;
+export declare const pathCwdNm: {
+    remove: typeof remove;
+    replace: typeof replace;
+};
+export {};

package/dist/path-cwd-nm.js

@@ -0,0 +1,34 @@
+import Path from "node:path";
+import { pathCwd } from "./path-cwd.js";
+import { escapeRegExp } from "./esc-regex.js";
+const normNm = escapeRegExp(Path.normalize("/node_modules/"));
+const normNmReplacer = Path.normalize("/~/");
+const makeNmRegex = () => escapeRegExp(Path.resolve("node_modules"));
+/**
+ * Remove occurrences of CWD/node_modules from `p`.
+ *
+ * @param p path string to process
+ * @param flags RegExp flags, ie: `"g"`
+ */
+function remove(p, flags) {
+    const nmRegex = new RegExp(makeNmRegex(), flags || "");
+    p = p.replace(nmRegex, "");
+    return pathCwd.remove(p, flags);
+}
+/**
+ * Replace occurrences of CWD/node_modules in `p` with `str` (default
+ * `"CWD/~"`), and any remaining `/node_modules/` with `/~/`.
+ *
+ * @param p path string to process
+ * @param str replacement - non-string means use `"CWD/~"`
+ * @param flags RegExp flags, ie: `"g"`
+ */
+function replace(p, str, flags) {
+    if (typeof str !== "string") {
+        str = Path.join(`CWD`, `~`);
+    }
+    const nmRegex = new RegExp(makeNmRegex(), flags || "");
+    p = pathCwd.replace(p.replace(nmRegex, str), null, flags);
+    return p.replace(new RegExp(normNm, flags), normNmReplacer);
+}
+export const pathCwdNm = { remove, replace };

package/dist/path-cwd.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Remove occurrences of CWD from `p`.
+ *
+ * @param p path string to process
+ * @param flags RegExp flags, ie: `"g"`
+ * @param stripSlash also strip the path separator following CWD
+ */
+declare function remove(p: string, flags?: string, stripSlash?: boolean): string;
+/**
+ * Replace occurrences of CWD in `p` with `str` (default `"CWD"`).
+ *
+ * @param p path string to process
+ * @param str replacement - non-string means use `"CWD"`
+ * @param flags RegExp flags, ie: `"g"`
+ */
+declare function replace(p: string, str?: string | null | false, flags?: string): string;
+export declare const pathCwd: {
+    remove: typeof remove;
+    replace: typeof replace;
+};
+export {};

package/dist/path-cwd.js

@@ -0,0 +1,36 @@
+import Path from "node:path";
+import { escapeRegExp } from "./esc-regex.js";
+/**
+ * Remove occurrences of CWD from `p`.
+ *
+ * @param p path string to process
+ * @param flags RegExp flags, ie: `"g"`
+ * @param stripSlash also strip the path separator following CWD
+ */
+function remove(p, flags, stripSlash) {
+    const cwd = process.cwd();
+    if (stripSlash) {
+        const regex = new RegExp(escapeRegExp(Path.join(cwd, Path.sep)), flags);
+        p = p.replace(regex, "");
+    }
+    if (p.indexOf(cwd) >= 0) {
+        const regex = new RegExp(escapeRegExp(cwd), flags);
+        return p.replace(regex, "");
+    }
+    return p;
+}
+/**
+ * Replace occurrences of CWD in `p` with `str` (default `"CWD"`).
+ *
+ * @param p path string to process
+ * @param str replacement - non-string means use `"CWD"`
+ * @param flags RegExp flags, ie: `"g"`
+ */
+function replace(p, str, flags) {
+    if (typeof str !== "string") {
+        str = "CWD";
+    }
+    const regex = new RegExp(escapeRegExp(process.cwd()), flags);
+    return p.replace(regex, str);
+}
+export const pathCwd = { remove, replace };

package/dist/util.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Mutable holder for the Promise implementation xsh uses.
+ *
+ * Lives in its own module so exec reads the current value at call time,
+ * while the setter is exposed as the `Promise` property on the xsh object.
+ */
+export declare const util: {
+    Promise: PromiseConstructor;
+};

package/dist/util.js

@@ -0,0 +1,9 @@
+/**
+ * Mutable holder for the Promise implementation xsh uses.
+ *
+ * Lives in its own module so exec reads the current value at call time,
+ * while the setter is exposed as the `Promise` property on the xsh object.
+ */
+export const util = {
+    Promise
+};

package/package.json

@@ -1,35 +1,51 @@
 {
   "name": "xsh",
-  "version": "0.4.6",
+  "version": "1.0.0",
   "description": "Some random NodeJS helper functions for shell execution",
-  "main": "lib/index.js",
+  "type": "module",
+  "types": "./dist/index.d.ts",
+  "main": "./dist/index.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "sideEffects": false,
+  "engines": {
+    "node": ">=22.12.0"
+  },
   "scripts": {
-    "test": "mocha test/spec",
-    "format": "prettier --write --print-width 100 lib/*.js",
-    "coverage": "nyc --all --reporter=lcov --reporter=text --reporter=text-summary npm test"
+    "build": "rm -rf dist && tsc -p tsconfig.json",
+    "test": "vitest run",
+    "coverage": "vitest run --coverage",
+    "ci:check": "tsc --noEmit -p tsconfig.json && vitest run",
+    "prepublishOnly": "npm run build",
+    "postpack": "publish-util-postpack"
   },
   "files": [
-    "lib"
+    "dist"
   ],
+  "bugs": {
+    "url": "https://github.com/jchip/fynjs/issues"
+  },
   "repository": {
     "type": "git",
-    "url": "https://github.com/jchip/xsh.git"
+    "url": "git+https://github.com/jchip/fynjs.git",
+    "directory": "packages/xsh"
   },
-  "homepage": "https://github.com/jchip/xsh",
-  "keywords": [],
+  "homepage": "https://github.com/jchip/fynjs/tree/main/packages/xsh",
+  "keywords": [
+    "shell",
+    "exec",
+    "shelljs",
+    "env",
+    "PATH"
+  ],
   "author": "Joel Chen <joel123@gmail.com>",
   "license": "Apache-2.0",
   "dependencies": {
-    "shcmd": "^0.8.4"
-  },
-  "devDependencies": {
-    "bluebird": "^3.5.1",
-    "chai": "^4.0.2",
-    "mocha": "^3.4.2",
-    "nyc": "^11.0.2",
-    "prettier": "^1.19.1"
-  },
-  "prettier": {
-    "printWidth": 100
+    "shelljs": "^0.10.0"
   }
 }

package/lib/env-path.js

@@ -1,94 +0,0 @@
-"use strict";
-
-const Path = require("path");
-const pathDelim = Path.delimiter;
-
-/* istanbul ignore next */
-const defaultEnvKey = process.platform === "win32" ? "Path" : "PATH";
-
-function findEnvKey(env, key) {
-  if (!key || !env.hasOwnProperty(key)) {
-    for (const x of Object.keys(env)) {
-      if (x.toLowerCase() === "path") {
-        key = x;
-        break;
-      }
-    }
-  }
-
-  return key;
-}
-
-const envKey = findEnvKey(process.env, defaultEnvKey);
-
-function check(env) {
-  // allow calls like this: envPath.add("addition_path", "existing_path");
-  if (typeof env === "string") {
-    env = { [envKey]: env };
-  } else if (!env) {
-    env = process.env;
-  }
-
-  return env;
-}
-
-function addToFront(p, env) {
-  env = check(env);
-
-  let update = env[envKey] || "";
-
-  if (typeof p === "string" && p) {
-    update = update.trim();
-    const paths = update.split(pathDelim).filter(x => x && x !== p);
-    paths.unshift(p);
-    update = paths.join(pathDelim);
-  }
-
-  env[envKey] = update;
-
-  return update;
-}
-
-function addToEnd(p, env) {
-  env = check(env);
-
-  let update = env[envKey] || "";
-
-  if (typeof p === "string" && p) {
-    update = update.trim();
-    const paths = update.split(pathDelim).filter(x => x && x !== p);
-    paths.push(p);
-    update = paths.join(pathDelim);
-  }
-
-  env[envKey] = update;
-
-  return update;
-}
-
-function add(p, env) {
-  env = check(env);
-
-  let update = env[envKey] || "";
-
-  if (typeof p === "string" && p) {
-    update = update.trim();
-    const paths = update.split(pathDelim).filter(x => x);
-    if (paths.indexOf(p) < 0) {
-      paths.push(p);
-      update = paths.join(pathDelim);
-    }
-  }
-
-  env[envKey] = update;
-
-  return update;
-}
-
-module.exports = {
-  addToFront,
-  addToEnd,
-  add,
-  envKey,
-  findEnvKey
-};

package/lib/env.js

@@ -1,40 +0,0 @@
-"use strict";
-
-const get = (name, valWhenUndef) => {
-  const x = process.env[name];
-  return x === undefined ? valWhenUndef : x;
-};
-
-const getAsBool = (name, valWhenUndef) => {
-  const x = process.env[name];
-  if (x === undefined) {
-    if (typeof valWhenUndef === "boolean") {
-      return valWhenUndef;
-    }
-    return false;
-  }
-
-  const b = x.toLowerCase();
-  return b === "true" || b === "1" || b === "yes" || b === "on";
-};
-
-const getAsInt = (name, valWhenUndef) => {
-  let n = NaN;
-  const x = process.env[name];
-  if (x !== undefined) {
-    n = +x;
-    if (!isNaN(n)) return n;
-  }
-
-  if (typeof valWhenUndef === "number") {
-    return valWhenUndef;
-  }
-
-  return n;
-};
-
-module.exports = {
-  get: get,
-  getAsBool,
-  getAsInt
-};

package/lib/esc-bs.js

@@ -1,6 +0,0 @@
-"use strict";
-
-const Path = require("path");
-
-/* istanbul ignore next */
-module.exports = Path.sep === "\\" ? x => x.replace(/\\/g, "\\\\") : x => x;

package/lib/exec.js

@@ -1,88 +0,0 @@
-"use strict";
-
-const shell = require("shcmd");
-const util = require("./util");
-const assert = require("assert");
-
-function exec() {
-  const error = (cmd, code, output) => {
-    const err = new Error(`shell cmd '${cmd}' exit code ${code}`);
-    err.output = output;
-    err.code = code;
-    return err;
-  };
-
-  const len = arguments.length;
-
-  let cb;
-  let options;
-
-  const cmdFragments = [];
-  for (let i = 0; i < len; i++) {
-    const arg = arguments[i];
-    const tof = typeof arg;
-    if (tof === "string" || Array.isArray(arg)) {
-      cmdFragments.push(arg);
-    } else if (tof === "function") {
-      assert(i + 1 === len, "xsh.exec: callback must be the last argument");
-      cb = arg;
-    } else if (arg.constructor.name === "Boolean" || arg.constructor.name === "Object") {
-      assert(
-        i === 0 || len - i === 1 || len - i === 2,
-        "xsh.exec: options must be the first, last, or second to last argument"
-      );
-      options = arg;
-    } else {
-      throw new Error("xsh.exec: command fragment must be an array or string");
-    }
-  }
-
-  if (!options) {
-    options = { silent: false };
-  } else if (options.constructor.name === "Boolean") {
-    options = { silent: options };
-  }
-
-  if (cmdFragments.length < 1) {
-    throw new Error("xsh.exec: expects at least one command fragment");
-  }
-
-  let s = "";
-  const cmd = cmdFragments.reduce((a, x) => {
-    if (Array.isArray(x)) {
-      x = x.join(" ");
-    }
-    a = `${a}${s}${x}`;
-    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);
-    });
-
-  if (cb) {
-    return doExec(cb);
-  }
-
-  let child;
-
-  assert(util.Promise, "xsh.exec: No Promise available - see doc on setting one");
-  const promise = new util.Promise((resolve, reject) => {
-    child = doExec((err, output) => (err ? reject(err) : resolve(output)));
-  });
-
-  return {
-    then: (a, b) => promise.then(a, b),
-    catch: a => promise.catch(a),
-    promise,
-    child,
-    stdout: child.stdout,
-    stderr: child.stderr
-  };
-}
-
-module.exports = exec;

package/lib/index.js

@@ -1,22 +0,0 @@
-"use strict";
-
-const util = require("./util");
-
-const xsh = {
-  exec: require("./exec"),
-  env: require("./env"),
-  envPath: require("./env-path"),
-  mkCmd: require("./mkcmd"),
-  pathCwd: require("./path-cwd"),
-  pathCwdNm: require("./path-cwd-nm"),
-  $: require("shcmd")
-};
-
-Object.defineProperty(xsh, "Promise", {
-  set: p => {
-    util.Promise = p || Promise;
-  },
-  get: () => util.Promise
-});
-
-module.exports = xsh;

package/lib/mkcmd.js

@@ -1,7 +0,0 @@
-"use strict";
-
-function mkCmd(a) {
-  return Array.isArray(a) ? a.join(" ") : Array.prototype.slice.call(arguments).join(" ");
-}
-
-module.exports = mkCmd;

package/lib/path-cwd-nm.js

@@ -1,25 +0,0 @@
-"use strict";
-
-const pathCwd = require("./path-cwd");
-const Path = require("path");
-const escBs = require("./esc-bs");
-const normNm = escBs(Path.normalize("/node_modules/"));
-const normNmReplacer = Path.normalize("/~/");
-
-const makeNmRegex = () => escBs(Path.resolve("node_modules"));
-
-module.exports = {
-  remove: (p, flags) => {
-    const nmRegex = new RegExp(makeNmRegex(), flags || "");
-    p = p.replace(nmRegex, "");
-    return pathCwd.remove(p, flags);
-  },
-  replace: (p, str, flags) => {
-    if (typeof str !== "string") {
-      str = Path.join(`CWD`, `~`);
-    }
-    const nmRegex = new RegExp(makeNmRegex(), flags || "");
-    p = pathCwd.replace(p.replace(nmRegex, str), null, flags);
-    return p.replace(new RegExp(normNm, flags), normNmReplacer);
-  }
-};

package/lib/path-cwd.js

@@ -1,26 +0,0 @@
-"use strict";
-
-const Path = require("path");
-const escBs = require("./esc-bs");
-
-module.exports = {
-  remove: (p, flags, stripSlash) => {
-    const cwd = process.cwd();
-    if (stripSlash) {
-      const regex = new RegExp(escBs(Path.join(cwd, Path.sep)), flags);
-      p = p.replace(regex, "");
-    }
-    if (p.indexOf(cwd) >= 0) {
-      const regex = new RegExp(escBs(cwd), flags);
-      return p.replace(regex, "");
-    }
-    return p;
-  },
-  replace: (p, str, flags) => {
-    if (typeof str !== "string") {
-      str = "CWD";
-    }
-    const regex = new RegExp(escBs(process.cwd()), flags);
-    return p.replace(regex, str);
-  }
-};

package/lib/util.js

@@ -1,5 +0,0 @@
-"use strict";
-
-module.exports = {
-  Promise
-};