spawn-rx 2.0.12 → 4.0.0-beta.1

package/.prettierrc

@@ -0,0 +1,4 @@
+{
+  "endOfLine": "auto",
+  "semi": true
+}

package/CODE_OF_CONDUCT.md

@@ -1,50 +1,50 @@
-# Contributor Code of Conduct
-
-As contributors and maintainers of this project, and in the interest of
-fostering an open and welcoming community, we pledge to respect all people who
-contribute through reporting issues, posting feature requests, updating
-documentation, submitting pull requests or patches, and other activities.
-
-We are committed to making participation in this project a harassment-free
-experience for everyone, regardless of level of experience, gender, gender
-identity and expression, sexual orientation, disability, personal appearance,
-body size, race, ethnicity, age, religion, or nationality.
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery
-* Personal attacks
-* Trolling or insulting/derogatory comments
-* Public or private harassment
-* Publishing other's private information, such as physical or electronic
-  addresses, without explicit permission
-* Other unethical or unprofessional conduct
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-By adopting this Code of Conduct, project maintainers commit themselves to
-fairly and consistently applying these principles to every aspect of managing
-this project. Project maintainers who do not follow or enforce the Code of
-Conduct may be permanently removed from the project team.
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting a project maintainer at paul@paulbetts.org. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. Maintainers are
-obligated to maintain confidentiality with regard to the reporter of an
-incident.
-
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 1.3.0, available at
-[http://contributor-covenant.org/version/1/3/0/][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/3/0/
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at paul@paulbetts.org. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

package/COPYING

@@ -1,7 +1,7 @@
-Copyright (c) 2016 Paul Betts
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Copyright (c) 2016 Paul Betts
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,187 +1,187 @@
-# spawn-rx: A better version of spawn
-
-| Linux/OSX | Windows |
-| --- | --- |
-| [![Build Status](https://travis-ci.org/tools-rx/spawn-rx.svg?branch=master)](https://travis-ci.org/tools-rx/spawn-rx) | [![Build status](https://ci.appveyor.com/api/projects/status/xm9xpgma4jwy3xns?svg=true)](https://ci.appveyor.com/project/dfbaskin/spawn-rx) |
-
-`spawn-rx` is a package that adds an Observable as well as a Promise version of 
-the `child_process.spawn` API, and fixes some deficiencies in `spawn` that come 
-up especially on Windows. For example:
-
-* `spawn` searches PATH on POSIX platforms but will not on Windows, you need to
-  provide an exact path. spawn-rx makes Windows act like other platforms.
-  
-* On Windows, `{detached: true}` doesn't actually create a process group properly.
-  `spawn-rx` provides a `spawnDetached` method that allows you to spawn a detached
-  process and kill the entire process group if needed.
-  
-* POSIX platforms allow you to directly execute scripts that have a shebang at 
-  the top of the file, whereas Windows can only natively `spawn` EXE files, which
-  makes executing npm binaries annoying. `spawn-rx` automatically rewrites your
-  `cmd` and `args` parameters for CMD scripts, PowerShell scripts, and node.js
-  files.
-
-## Examples
-
-spawn-as-promise:
-
-```js
-// Will run down path to find C:\Windows\System32\wmic.exe, whereas normal 
-// 'spawn' would require an absolute path.
-spawnPromise('wmic', [])
-  .then((result) => console.log(result));
-```
-
-Handle failed processes as errors:
-
-```js
-try {
-  await spawnPromise('exit', ['-1']);
-} catch (e) {
-  console.log("Processes that return non-zero exit codes throw")
-}
-```
-
-Kill running process trees:
-
-```js
-let disp = spawnDetached('takesALongTime', []).subscribe();
-await Promise.delay(1000);
-
-// Kill the process and its children by unsubscribing.
-disp.dispose();
-```
-
-Stream process output:
-
-```js
-spawn('ls', ['-r'])
-  .subscribe(
-    (x) => console.log(x), 
-    (e) => console.log("Process exited with an error"));
-```
-
-Execute scripts:
-
-```js
-// Executes ./node_modules/.bin/uuid.cmd on Windows if invoked via `npm run`
-let result = await spawnPromise('uuid');
-```
-
-
-## What's Jobber?
-
-Jobber is a Windows executable that will execute a command in a process group,
-and if signaled via a named pipe, will terminate that process group. It's used
-in the implementation of `spawnDetached`.
-
-## Spawn output
-
-By default spawn will merge stdout and stderr into the returned observable.
-You can exclude one or the other by passing `ignore` in the `stdio` option of spawn.
-
-Alternatively if you call it with `{ split: true }` option, the observable output
- will be an object `{ source: 'stdout', text: '...' }` so you can distinguish
- the outputs.
-
-## Stdin support
-
-If you provide an `observable<string>` in `opts.stdin`, it'll be subscribed upon
- and fed into the child process stdin. Its completion will terminate stdin stream.
-
-## Methods
-
-```js
-/**
- * Spawns a process attached as a child of the current process. 
- * 
- * @param  {string} exe               The executable to run
- * @param  {Array<string>} params     The parameters to pass to the child
- * @param  {Object} opts              Options to pass to spawn.
- *
- * @return {Observable<string>}       Returns an Observable that when subscribed
- *                                    to, will create a child process. The
- *                                    process output will be streamed to this
- *                                    Observable, and if unsubscribed from, the
- *                                    process will be terminated early. If the
- *                                    process terminates with a non-zero value,
- *                                    the Observable will terminate with onError.
- */
-function spawn(exe, params=[], opts=null)
-```
-
-```js
-/**
- * Spawns a process but detached from the current process. The process is put 
- * into its own Process Group that can be killed by unsubscribing from the 
- * return Observable.
- * 
- * @param  {string} exe               The executable to run
- * @param  {Array<string>} params     The parameters to pass to the child
- * @param  {Object} opts              Options to pass to spawn.
- *
- * @return {Observable<string>}       Returns an Observable that when subscribed
- *                                    to, will create a detached process. The
- *                                    process output will be streamed to this
- *                                    Observable, and if unsubscribed from, the
- *                                    process will be terminated early. If the
- *                                    process terminates with a non-zero value,
- *                                    the Observable will terminate with onError.
- */
-function spawnDetached(exe, params, opts=null)
-```
-
-```js
-/**
- * Spawns a process as a child process.
- * 
- * @param  {string} exe               The executable to run
- * @param  {Array<string>} params     The parameters to pass to the child
- * @param  {Object} opts              Options to pass to spawn.
- *
- * @return {Promise<string>}       Returns an Promise that represents a child
- *                                 process. The value returned is the process 
- *                                 output. If the process terminates with a 
- *                                 non-zero value, the Promise will resolve with 
- *                                 an Error.
- */
-function spawnPromise(exe, params, opts=null)
-```
-
-```js
-/**
- * Spawns a process but detached from the current process. The process is put 
- * into its own Process Group.
- * 
- * @param  {string} exe               The executable to run
- * @param  {Array<string>} params     The parameters to pass to the child
- * @param  {Object} opts              Options to pass to spawn.
- *
- * @return {Promise<string>}       Returns an Promise that represents a detached 
- *                                 process. The value returned is the process 
- *                                 output. If the process terminates with a 
- *                                 non-zero value, the Promise will resolve with 
- *                                 an Error.
- */
-function spawnDetachedPromise(exe, params, opts=null)
-```
-
-```js
-/**
- * Finds the actual executable and parameters to run on Windows. This method 
- * mimics the POSIX behavior of being able to run scripts as executables by 
- * replacing the passed-in executable with the script runner, for PowerShell, 
- * CMD, and node scripts.
- *
- * This method also does the work of running down PATH, which spawn on Windows
- * also doesn't do, unlike on POSIX.
- * 
- * @param  {string} exe           The executable to run
- * @param  {Array<string>} args   The arguments to run
- *
- * @return {Object}               The cmd and args to run
- * @property {string} cmd         The command to pass to spawn
- * @property {Array<string>} args The arguments to pass to spawn
- */
-function findActualExecutable(exe, args)
-```
+# spawn-rx: A better version of spawn
+
+| Linux/OSX | Windows |
+| --- | --- |
+| [![Build Status](https://travis-ci.org/tools-rx/spawn-rx.svg?branch=master)](https://travis-ci.org/tools-rx/spawn-rx) | [![Build status](https://ci.appveyor.com/api/projects/status/xm9xpgma4jwy3xns?svg=true)](https://ci.appveyor.com/project/dfbaskin/spawn-rx) |
+
+`spawn-rx` is a package that adds an Observable as well as a Promise version of 
+the `child_process.spawn` API, and fixes some deficiencies in `spawn` that come 
+up especially on Windows. For example:
+
+* `spawn` searches PATH on POSIX platforms but will not on Windows, you need to
+  provide an exact path. spawn-rx makes Windows act like other platforms.
+  
+* On Windows, `{detached: true}` doesn't actually create a process group properly.
+  `spawn-rx` provides a `spawnDetached` method that allows you to spawn a detached
+  process and kill the entire process group if needed.
+  
+* POSIX platforms allow you to directly execute scripts that have a shebang at 
+  the top of the file, whereas Windows can only natively `spawn` EXE files, which
+  makes executing npm binaries annoying. `spawn-rx` automatically rewrites your
+  `cmd` and `args` parameters for CMD scripts, PowerShell scripts, and node.js
+  files.
+
+## Examples
+
+spawn-as-promise:
+
+```js
+// Will run down path to find C:\Windows\System32\wmic.exe, whereas normal 
+// 'spawn' would require an absolute path.
+spawnPromise('wmic', [])
+  .then((result) => console.log(result));
+```
+
+Handle failed processes as errors:
+
+```js
+try {
+  await spawnPromise('exit', ['-1']);
+} catch (e) {
+  console.log("Processes that return non-zero exit codes throw")
+}
+```
+
+Kill running process trees:
+
+```js
+let disp = spawnDetached('takesALongTime', []).subscribe();
+await Promise.delay(1000);
+
+// Kill the process and its children by unsubscribing.
+disp.dispose();
+```
+
+Stream process output:
+
+```js
+spawn('ls', ['-r'])
+  .subscribe(
+    (x) => console.log(x), 
+    (e) => console.log("Process exited with an error"));
+```
+
+Execute scripts:
+
+```js
+// Executes ./node_modules/.bin/uuid.cmd on Windows if invoked via `npm run`
+let result = await spawnPromise('uuid');
+```
+
+
+## What's Jobber?
+
+Jobber is a Windows executable that will execute a command in a process group,
+and if signaled via a named pipe, will terminate that process group. It's used
+in the implementation of `spawnDetached`.
+
+## Spawn output
+
+By default spawn will merge stdout and stderr into the returned observable.
+You can exclude one or the other by passing `ignore` in the `stdio` option of spawn.
+
+Alternatively if you call it with `{ split: true }` option, the observable output
+ will be an object `{ source: 'stdout', text: '...' }` so you can distinguish
+ the outputs.
+
+## Stdin support
+
+If you provide an `observable<string>` in `opts.stdin`, it'll be subscribed upon
+ and fed into the child process stdin. Its completion will terminate stdin stream.
+
+## Methods
+
+```js
+/**
+ * Spawns a process attached as a child of the current process. 
+ * 
+ * @param  {string} exe               The executable to run
+ * @param  {Array<string>} params     The parameters to pass to the child
+ * @param  {Object} opts              Options to pass to spawn.
+ *
+ * @return {Observable<string>}       Returns an Observable that when subscribed
+ *                                    to, will create a child process. The
+ *                                    process output will be streamed to this
+ *                                    Observable, and if unsubscribed from, the
+ *                                    process will be terminated early. If the
+ *                                    process terminates with a non-zero value,
+ *                                    the Observable will terminate with onError.
+ */
+function spawn(exe, params=[], opts=null)
+```
+
+```js
+/**
+ * Spawns a process but detached from the current process. The process is put 
+ * into its own Process Group that can be killed by unsubscribing from the 
+ * return Observable.
+ * 
+ * @param  {string} exe               The executable to run
+ * @param  {Array<string>} params     The parameters to pass to the child
+ * @param  {Object} opts              Options to pass to spawn.
+ *
+ * @return {Observable<string>}       Returns an Observable that when subscribed
+ *                                    to, will create a detached process. The
+ *                                    process output will be streamed to this
+ *                                    Observable, and if unsubscribed from, the
+ *                                    process will be terminated early. If the
+ *                                    process terminates with a non-zero value,
+ *                                    the Observable will terminate with onError.
+ */
+function spawnDetached(exe, params, opts=null)
+```
+
+```js
+/**
+ * Spawns a process as a child process.
+ * 
+ * @param  {string} exe               The executable to run
+ * @param  {Array<string>} params     The parameters to pass to the child
+ * @param  {Object} opts              Options to pass to spawn.
+ *
+ * @return {Promise<string>}       Returns an Promise that represents a child
+ *                                 process. The value returned is the process 
+ *                                 output. If the process terminates with a 
+ *                                 non-zero value, the Promise will resolve with 
+ *                                 an Error.
+ */
+function spawnPromise(exe, params, opts=null)
+```
+
+```js
+/**
+ * Spawns a process but detached from the current process. The process is put 
+ * into its own Process Group.
+ * 
+ * @param  {string} exe               The executable to run
+ * @param  {Array<string>} params     The parameters to pass to the child
+ * @param  {Object} opts              Options to pass to spawn.
+ *
+ * @return {Promise<string>}       Returns an Promise that represents a detached 
+ *                                 process. The value returned is the process 
+ *                                 output. If the process terminates with a 
+ *                                 non-zero value, the Promise will resolve with 
+ *                                 an Error.
+ */
+function spawnDetachedPromise(exe, params, opts=null)
+```
+
+```js
+/**
+ * Finds the actual executable and parameters to run on Windows. This method 
+ * mimics the POSIX behavior of being able to run scripts as executables by 
+ * replacing the passed-in executable with the script runner, for PowerShell, 
+ * CMD, and node scripts.
+ *
+ * This method also does the work of running down PATH, which spawn on Windows
+ * also doesn't do, unlike on POSIX.
+ * 
+ * @param  {string} exe           The executable to run
+ * @param  {Array<string>} args   The arguments to run
+ *
+ * @return {Object}               The cmd and args to run
+ * @property {string} cmd         The command to pass to spawn
+ * @property {Array<string>} args The arguments to pass to spawn
+ */
+function findActualExecutable(exe, args)
+```

package/build.cmd

@@ -1 +1 @@
-npm i && npm t
+npm i && npm t

package/build.sh

@@ -1,2 +1,2 @@
-#!/bin/bash
-npm i && npm t
+#!/bin/bash
+npm i && npm t

package/esdoc.json

@@ -1,26 +1,26 @@
-{
-  "source": "./src",
-  "destination": "./docs",
-  "includes": ["\\.(js|es6)$"],
-  "excludes": ["\\.config\\.(js|es6)$"],
-  "access": ["public", "protected"],
-  "autoPrivate": true,
-  "unexportIdentifier": false,
-  "undocumentIdentifier": true,
-  "builtinExternal": true,
-  "index": "./README.md",
-  "package": "./package.json",
-  "coverage": true,
-  "includeSource": true,
-  "title": "electron-compilers",
-  "plugins": [
-    {"name": "esdoc-es7-plugin"},
-    {"name": "esdoc-plugin-async-to-sync"}
-  ],
-  "test": {
-    "type": "mocha",
-    "source": "./test",
-    "includes": ["\\.(js|es6)$"]
-  },
-  "lint": true
-}
+{
+  "source": "./src",
+  "destination": "./docs",
+  "includes": ["\\.(js|es6)$"],
+  "excludes": ["\\.config\\.(js|es6)$"],
+  "access": ["public", "protected"],
+  "autoPrivate": true,
+  "unexportIdentifier": false,
+  "undocumentIdentifier": true,
+  "builtinExternal": true,
+  "index": "./README.md",
+  "package": "./package.json",
+  "coverage": true,
+  "includeSource": true,
+  "title": "electron-compilers",
+  "plugins": [
+    {"name": "esdoc-es7-plugin"},
+    {"name": "esdoc-plugin-async-to-sync"}
+  ],
+  "test": {
+    "type": "mocha",
+    "source": "./test",
+    "includes": ["\\.(js|es6)$"]
+  },
+  "lint": true
+}

package/eslint.config.mjs

@@ -0,0 +1,88 @@
+import typescriptEslint from "@typescript-eslint/eslint-plugin";
+import prettier from "eslint-plugin-prettier";
+import tsParser from "@typescript-eslint/parser";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import js from "@eslint/js";
+import { FlatCompat } from "@eslint/eslintrc";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+  recommendedConfig: js.configs.recommended,
+  allConfig: js.configs.all,
+});
+
+export default [
+  ...compat.extends(
+    "eslint:recommended",
+    "prettier",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended",
+  ),
+  {
+    files: ["./src/*.{ts,tsx}", "./test/*.{ts,tsx}"],
+    plugins: {
+      "@typescript-eslint": typescriptEslint,
+      prettier,
+    },
+
+    languageOptions: {
+      globals: {},
+      parser: tsParser,
+      ecmaVersion: 5,
+      sourceType: "script",
+
+      parserOptions: {
+        project: "./tsconfig.json",
+      },
+    },
+
+    rules: {
+      "prettier/prettier": "warn",
+
+      "spaced-comment": [
+        "error",
+        "always",
+        {
+          markers: ["/"],
+        },
+      ],
+
+      "no-fallthrough": "error",
+      "@typescript-eslint/ban-ts-comment": "warn",
+
+      "@typescript-eslint/consistent-type-imports": [
+        "error",
+        {
+          prefer: "type-imports",
+        },
+      ],
+
+      "@typescript-eslint/no-inferrable-types": [
+        "error",
+        {
+          ignoreParameters: false,
+          ignoreProperties: false,
+        },
+      ],
+
+      "@typescript-eslint/no-non-null-assertion": "off",
+      "@typescript-eslint/no-floating-promises": "error",
+
+      "@typescript-eslint/no-unused-vars": [
+        "warn",
+        {
+          args: "after-used",
+          argsIgnorePattern: "^_",
+          varsIgnorePattern: "^_",
+          ignoreRestSiblings: true,
+        },
+      ],
+
+      "@typescript-eslint/no-empty-function": ["error"],
+      "@typescript-eslint/restrict-template-expressions": "off",
+    },
+  },
+];