spawno 2.1.1 → 3.0.0

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016-20 Ionică Bizău <bizauionica@gmail.com> (https://ionicabizau.net)
+Copyright (c) 2016-26 Ionică Bizău <bizauionica@gmail.com> (https://ionicabizau.net)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -19,7 +19,7 @@
 
 # spawno
 
- [![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Ask me anything](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/spawno.svg)](https://www.npmjs.com/package/spawno) [![Downloads](https://img.shields.io/npm/dt/spawno.svg)](https://www.npmjs.com/package/spawno) [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
+ [![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Ask me anything](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/spawno.svg)](https://www.npmjs.com/package/spawno) [![Downloads](https://img.shields.io/npm/dt/spawno.svg)](https://www.npmjs.com/package/spawno) [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/@johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
 
 <a href="https://www.buymeacoffee.com/H96WwChMy" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee"></a>
 
@@ -74,7 +74,11 @@ yarn add spawno
 
 
 ```js
-const spawn = require("spawno");
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import spawn from "spawno";
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
 spawn("ls", ["-l"], { cwd: __dirname }, (err, stdout, stderr) => {
     console.log(err || stderr || stdout);
@@ -84,10 +88,11 @@ spawn("ls", ["-l"], { cwd: __dirname }, (err, stdout, stderr) => {
 });
 
 // Pipe the output in the stdout/stderr streams (this will not collect the output in memory)
-let proc = spawn("ping", ["ionicabizau.net"], {
-    cwd: __dirname
-  , output: true
+spawn("ping", ["ionicabizau.net"], {
+    cwd: __dirname,
+    output: true
 });
+
 // =>
 // PING ionicabizau.net (109.107.37.233) 56(84) bytes of data.
 // 64 bytes from cip-109-107-37-233.gb1.brightbox.com (109.107.37.233): icmp_seq=1 ttl=54 time=49.2 ms
@@ -96,7 +101,7 @@ let proc = spawn("ping", ["ionicabizau.net"], {
 // 64 bytes from cip-109-107-37-233.gb1.brightbox.com (109.107.37.233): icmp_seq=4 ttl=54 time=46.3 ms
 
 // Promise interface
-spawn.promise("curl", ["ionicabizau.net"]).then(console.log)
+spawn.promise("curl", ["ionicabizau.net"]).then(console.log);
 ```
 
 
@@ -109,20 +114,6 @@ spawn.promise("curl", ["ionicabizau.net"]).then(console.log)
 
 
 
-## :question: Get Help
-
-There are few ways to get help:
-
-
-
- 1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
- 2. For bug reports and feature requests, open issues. :bug:
- 3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
-
-
-
-
-
 ## :memo: Documentation
 
 
@@ -131,9 +122,9 @@ Creates the child process.
 
 #### Params
 
-- **String** `command`: The command you want to run.
+- **string** `command`: The command you want to run.
 - **Array** `args`: The command arguments.
-- **Object** `options`: The options to pass to the `spawn` function extended with:
+- **object** `options`: The options to pass to the `spawn` function extended with:
  - `output` (Boolean): If truly, the output will be piped in the
    process stdout/stderr streams.
  - `data` (String|Boolean): If `false`, the `stdin` stream will not be ended. By default this is an empty string.
@@ -142,9 +133,15 @@ Creates the child process.
 #### Return
 - **Process** The child process that was created.
 
-### `spawno.promise()`
+### `spawno.promise(command, args, options)`
 The promise interface.
 
+#### Params
+
+- **string** `command`: The command you want to run.
+- **Array** `args`: The command arguments.
+- **object** `options`: The options to pass to the `spawn` function.
+
 #### Return
 - **Promise** The promise which will be eventually resolved with the following object:
   - `code`
@@ -159,6 +156,24 @@ The promise interface.
 
 
 
+## :question: Get Help
+
+There are few ways to get help:
+
+
+
+ 1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
+ 2. For bug reports and feature requests, open issues. :bug:
+ 3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
+
+
+
+
+
+
+
+
+
 
 
 
@@ -201,26 +216,6 @@ Thanks! :heart:
 
 
 
-## :dizzy: Where is this library used?
-If you are using this library in one of your projects, add it in this list. :sparkles:
-
- - `powershell`
- - `diable`
- - `spawn-npm`
- - `electroner`
- - `git-cloner`
- - `git-status`
- - `@zkochan/diable`
- - `babel-it`
- - `initial-commit-date`
- - `fortran`
- - `striking-clock`
- - `git-change-author`
- - `pull-from-source`
- - `ship-release`
-
-
-
 
 
 

package/lib/index.js

@@ -1,26 +1,22 @@
-"use strict";
-
-var spawn = require("child_process").spawn,
-    procOutput = require("proc-output");
+import { spawn } from "node:child_process";
+import procOutput from "proc-output";
 
 /**
  * spawno
  * Creates the child process.
- *
  * @name spawno
  * @function
- * @param {String} command The command you want to run.
+ * @param {string} command The command you want to run.
  * @param {Array} args The command arguments.
- * @param {Object} options The options to pass to the `spawn` function extended with:
+ * @param {object} options The options to pass to the `spawn` function extended with:
  *
  *  - `output` (Boolean): If truly, the output will be piped in the
  *    process stdout/stderr streams.
  *  - `data` (String|Boolean): If `false`, the `stdin` stream will not be ended. By default this is an empty string.
- *
  * @param {Function} cb The callback function.
  * @returns {Process} The child process that was created.
  */
-module.exports = function spawno(command, args, options, cb) {
+function spawno(command, args, options, cb) {
 
     if (typeof args === "function") {
         cb = args;
@@ -44,13 +40,14 @@ module.exports = function spawno(command, args, options, cb) {
         options.input = options.input || "";
     }
 
-    var showOutput = options.output,
-        inputData = options.input;
+    let showOutput = options.output;
+    let inputData = options.input
+      ;
 
     delete options.output;
     delete options.input;
 
-    var proc = spawn(command, args, options);
+    let proc = spawn(command, args, options);
 
     if (showOutput) {
         proc.stdout.pipe(process.stdout);
@@ -66,31 +63,36 @@ module.exports = function spawno(command, args, options, cb) {
     }
 
     return proc;
-};
+}
 
 /**
  * spawno.promise
  * The promise interface.
- *
  * @name spawno.promise
  * @function
+ * @param {string} command The command you want to run.
+ * @param {Array} args The command arguments.
+ * @param {object} options The options to pass to the `spawn` function.
  * @returns {Promise} The promise which will be eventually resolved with the following object:
  *
  *   - `code`
  *   - `stdout`
  *   - `stderr`
  */
-module.exports.promise = function (command, args, options) {
-    return new Promise(function (resolve, reject) {
-        module.exports(command, args, options, function (err, stdout, stderr, code) {
-            if (err) {
-                return reject(err);
-            }
+const promise = (command, args, options) => {
+    return new Promise((resolve, reject) => {
+        spawno(command, args, options, (err, stdout, stderr, code) => {
+            if (err) { return reject(err); }
             resolve({
-                code: code,
-                stdout: stdout,
-                stderr: stderr
+                code,
+                stdout,
+                stderr
             });
         });
     });
-};
+};
+
+spawno.promise = promise;
+
+export { promise };
+export default spawno;

package/package.json

@@ -1,15 +1,16 @@
 {
   "name": "spawno",
-  "version": "2.1.1",
+  "version": "3.0.0",
   "description": "Easily work with child processes.",
+  "type": "module",
   "main": "lib/index.js",
+  "exports": "./lib/index.js",
   "directories": {
     "example": "example"
   },
   "dependencies": {
-    "proc-output": "^1.0.0"
+    "proc-output": "^2.0.0"
   },
-  "devDependencies": {},
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
@@ -39,9 +40,11 @@
     "menu/",
     "cli.js",
     "index.js",
+    "index.d.ts",
+    "package-lock.json",
     "bloggify.js",
     "bloggify.json",
     "bloggify/"
   ],
   "blah": {}
-}
+}