@j-o-r/sh 0.0.1

package/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 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 [yyyy] [name of copyright owner]
+
+   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

@@ -0,0 +1,133 @@
+# @j-o-r/sh
+
+Execute shell commands from JavaScript.
+
+![Alt text](https://raw.githubusercontent.com/j-o-r/sh/main/jor-sh.png "logo")
+
+## Introduction
+
+BETA
+
+This Node.js module, `@j-o-r/sh`, simplifies the execution of shell commands within JavaScript applications. It provides a range of utilities to handle shell scripts and manage their output efficiently.
+
+This project draws inspiration from the exceptional [zx library](https://github.com/google/zx). The core functionality of zx, particularly the shell execution method, has been extracted and forms the foundation of this project.
+
+## Installation
+
+Install the module using npm:
+
+```sh
+npm install @j-o-r/sh
+```
+
+## Usage
+
+### Basic Usage
+
+To execute a shell command, use the `SH` function:
+
+```javascript
+import { SH, cd, within, sleep, retry, expBackoff } from '@j-o-r/sh';
+
+SH`your_shell_command`
+  .then(output => {
+    console.log('Output:', output);
+  })
+  .catch(error => {
+    console.error('Error:', error);
+  });
+```
+
+```javascript
+
+const res = await SH`ls -FLa`.pipe(SH`grep package.json`);
+console.log(res.toString());
+
+const ar = within(async () => {
+	const res = await Promise.all([
+		SH`sleep 1; echo 1`,
+		SH`sleep 2; echo 2`,
+		sleep(2),
+		SH`sleep 3; echo 3`
+	]);
+});
+
+``` 
+
+```javascript
+const p = await retry(3, expBackoff(), () => SH`curl -s https://unreachable:`);
+```
+
+The `SH` method accepts a template literal string enclosed in backticks as its argument. It returns a `ProcessPromise`. Once this promise is resolved, it yields a `ProcessOutput` object.
+### Additional Utilities
+
+The module also provides additional utilities for common tasks:
+
+- `cd(dir)`: Change the working directory.
+- `sleep(duration)`: Pause execution for a specified duration.
+- `retry(count, interval, callback)`: Retry a command a specified number of times with an optional interval.
+- `stdin()`: Read from standard input.
+- `within(callback)`: Create an async context in a sync block.
+- `expBackoff(max, rand)`: Generate intervals for exponential backoff.
+
+
+## ProcessPromise
+
+This class is returned by the shell command. Here's a summary of its methods and properties:
+
+### Methods
+
+- **pipe(dest)**: Pipes the output of this process to the input of another `ProcessPromise`
+- **kill(signal = 'SIGTERM')**: Sends a kill signal to the child process.
+- **stdio(stdin, stdout, stderr)**: Sets the standard input/output/error streams for the child process.
+- **nothrow()**: Configures the promise not to throw an error when the command execution fails.
+- **quiet()**: Suppresses log output.
+- **verbose()**: Enables verbose log output.
+- **timeout(d, signal = 'SIGTERM')**: Sets a timeout for killing the process.
+- **halt()**: Stops the execution of the next step in the process.
+
+### Getters
+
+- **stdin**: Returns the standard input stream of the child process.
+- **stdout**: Returns the standard output stream of the child process.
+- **stderr**: Returns the standard error stream of the child process.
+- **exitCode**: Returns a promise that resolves to the exit code of the child process.
+
+### Properties
+
+- **isHalted**: A getter that returns a boolean indicating whether the promise is halted.
+
+## Output
+
+The `ProcessOutput` class collects output from the `ProcessPromise` shell process. It extends the `Error` class to provide compatibility with error handling mechanisms. Here's a summary of its features:
+
+
+### Getters
+
+- **stdout**: Returns the standard output (stdout) of the child process as a string.
+- **stderr**: Returns the error output (stderr) of the child process as a string.
+- **exitCode**: Returns the exit code of the process as a number.
+- **signal**: Returns the signal received by the process, such as 'SIGTERM', as a string.
+
+### Methods
+
+- **toString()**: 
+  - Returns a trimmed string combining `stderr` and `stdout`. 
+  - This method is automatically invoked by various JavaScript methods for output consolidation.
+- **[inspect.custom]()**:
+  - Custom inspection method used for debugging.
+  - Displays the current state of the object when passed to `console.log`.
+
+### Examples
+
+- Script for setting up my wokspace in [TMUX](./workspace.js)
+- Take a look at the [test](./test/sh.js)
+
+## Contributing
+
+Contributions are welcome. Please submit issues and pull requests on our [GitHub repository](https://github.com/j-o-r/sh).
+
+## License
+
+This project is licensed under the Apache License, Version 2.0.
+

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@j-o-r/sh",
+  "author": "Jorrit Duin <jorrit.duin@gmail.com>",
+  "type": "module",
+  "version": "0.0.1",
+  "description": "Execute shell commands from javascript",
+  "main": "src/sh.js",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "scripts": {
+    "test": "test/sh.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/j-o-r/sh.git"
+  },
+  "license": "Apache License, Version 2.0",
+  "dependencies": {
+    "ps-tree": "^1.2.0",
+    "which": "^4.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.8.10",
+    "uvu": "^0.5.6"
+  },
+  "bugs": {
+    "url": "https://github.com/j-o-r/sh/issues"
+  },
+  "homepage": "https://github.com/j-o-r/sh",
+  "keywords": [
+    "shell",
+    "command-line",
+    "shell-script",
+    "nodejs",
+    "javascript",
+    "process-management",
+    "script-execution",
+    "cli",
+    "zx-inspired",
+    "automation",
+    "devops",
+    "command-execution",
+    "shell-commands",
+    "process-promise",
+    "process-output"
+  ]
+}

package/src/ProcessOutput.js

@@ -0,0 +1,113 @@
+// Copyright 2021 Google LLC
+//
+// 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
+//
+//     https://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.
+// 
+//
+// Original Source: zx
+// Link to Original Source: https://github.com/google/zx
+// Reason for Using This Code: 
+// The core functionality of this code is highly beneficial. However, certain parts of the original code 
+// were overwriting the global namespace with core libraries and variables. This was causing conflicts with 
+// other packages (for instance, fetch) and introducing unexpected elements into my code base.
+// Changes Made: 
+// - The code has been or is being reformatted to comply with ES2020 standards.
+// - Some methods were added and existing ones were modified to enhance usability.
+// - The namespace has been changed from '$' to 'SH'.
+// Modified by: jorrit.duin+sh[AT]gmail.com
+
+import { inspect } from 'node:util';
+import { exitCodeInfo} from './utils.js';
+
+/**
+* The ProcessPromise returns a ProcessOutput even when it fails, by rejecting it.
+* The extension of the Error class is implemented to ensure compatibility when an Error is expected upon rejection.
+*/
+class ProcessOutput extends Error {
+	#code = 0;
+	#signal;
+	#stdout = '';
+	#stderr = '';
+	#combined = '';
+	/**
+	* @param {number} code - exit code
+	* @param {string} signal - SIGTERM ...
+	* @param {string} stdout - std reponse string
+	* @param {string} stderr - error reponse string
+	* @param {string} combined - stderr + stdout
+	* @param {string} message - Error message
+	*/
+	constructor(code, signal, stdout = '', stderr = '', combined = '', message = '') {
+		super(message);
+		this.#code = code;
+		this.#signal = signal;
+		this.#stdout = stdout;
+		this.#stderr = stderr;
+		this.#combined = combined;
+		this.name = 'ProcessOutput';
+	}
+	/**
+	* This string represents the standard output (stdout) from the child process.
+	* @returns {string}
+	*/
+	get stdout() {
+		return this.#stdout;
+	}
+	/**
+	* This string represents the error output (stderr) from the child process.
+	* @returns {string}
+	*/
+	get stderr() {
+		return this.#stderr;
+	}
+
+	/**
+	* This is an internal method that is often invoked automatically 
+	* by various JavaScript methods. 
+	* It consolidates the entire output for completeness and facilitates further processing.
+	* 
+	* @returns {string} The consolidated output as a
+	*/
+	toString() {
+		return this.#combined.trim();
+	}
+	/**
+	* This represents the exit code returned by the external process.
+	* @returns {number} The exit
+	*/
+	get exitCode() {
+		return this.#code;
+	}
+	/**
+	* This represents the exit signal, for example, "SIGTERM", received from the child process.
+	* @returns {string} The exit signal from the child
+	*/
+	get signal() {
+		return this.#signal;
+	}
+ 	/** 
+	* This method is used for debugging purposes. It displays the current state of the object
+	* when passed to the console.log function.
+	*/
+ 	[inspect.custom]() {
+ 		let stringify = (s) => s.length === 0 ? "''" : inspect(s);
+ 		return `ProcessOutput {
+    stdout: ${stringify(this.stdout)},
+    stderr: ${stringify(this.stderr)},
+    signal: ${inspect(this.signal)},
+    exitCode: ${(this.exitCode)}${exitCodeInfo(this.exitCode)
+ 				? ' (' + exitCodeInfo(this.exitCode) + ')'
+ 				: ''}
+  }`;
+ 	}
+}
+export default ProcessOutput;