first-base 0.2.0 → 1.4.0

package/README.md

@@ -111,6 +111,19 @@ run.write("2 + 2\n"); // Write 2 + 2 then press enter
 await run.outputContains("4");
 ```
 
+### `RunContext#close(stream: 'stdin' | 'stdout' | 'stderr')`
+
+Close one of the processes's associated stdio streams.
+
+#### Usage
+
+```js
+const run = spawn("node", ["-i"]); // start Node.js REPL
+await run.outputContains("> "); // Wait until prompt appears
+run.close("stdin"); // Like pressing Ctrl+D; sends EOF
+await run.completion;
+```
+
 ### `RunContext#kill(signal?: string)`
 
 Kills the process. If no signal is specified, it defaults to `"SIGINT"`.

package/dist/index.d.ts

@@ -8,6 +8,7 @@ export type Options = {
   shell?: boolean | string;
   windowsVerbatimArguments?: boolean;
   windowsHide?: boolean;
+  pty?: boolean;
 };
 
 export type RunContext = {
@@ -23,6 +24,7 @@ export type RunContext = {
   clearOutputContainsBuffer(): void;
   // TODO: Should be string | Buffer, but idk how to use Buffer since they might not be using node types
   write(data: any): void;
+  close(stream: "stdin" | "stdout" | "stderr"): void;
   kill(signal?: string): void;
 };
 

package/dist/index.js

@@ -1,37 +1,31 @@
 "use strict";
 
-function _typeof(obj) { if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
-
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
 var normalSpawn = require("child_process").spawn;
+var ptySpawn = require("node-pty").spawn;
+var stripAnsi = require("strip-ansi");
 
-var stripAnsi = require("strip-ansi"); // Run a child process and return a "run context" object
+// Run a child process and return a "run context" object
 // to interact with it. Function signature is the same as
 // child_process spawn, except you can pass `pty: true` in
 // options to run the process in a psuedo-tty.
-
-
 var spawn = function spawn(cmd, argsOrOptions, passedOptions) {
   var args;
   var options;
-
   if (Array.isArray(argsOrOptions)) {
     args = argsOrOptions;
   } else if (_typeof(argsOrOptions) === "object") {
     options = argsOrOptions;
   }
-
   if (passedOptions && !options) {
     options = passedOptions;
   }
-
   if (!args) {
     args = [];
   }
-
   if (!options) {
     options = {};
   }
-
   var child;
   var stdin;
   var stdout;
@@ -41,15 +35,12 @@ var spawn = function spawn(cmd, argsOrOptions, passedOptions) {
   var _debug = false;
   var outputContainsBuffer = "";
   var pendingOutputContainsRequests = new Set();
-
   var debugLog = function debugLog() {
     if (_debug) {
       var _console;
-
       (_console = console).log.apply(_console, arguments);
     }
   };
-
   var runContext = {
     result: {
       // All of the stdout and stderr the process has written so far.
@@ -75,17 +66,14 @@ var spawn = function spawn(cmd, argsOrOptions, passedOptions) {
         var request = {
           value: value
         };
-
         request.resolve = function () {
-          pendingOutputContainsRequests.delete(request);
+          pendingOutputContainsRequests["delete"](request);
           resolve();
         };
-
         request.reject = function () {
-          pendingOutputContainsRequests.delete(request);
+          pendingOutputContainsRequests["delete"](request);
           reject();
         };
-
         pendingOutputContainsRequests.add(request);
       });
     },
@@ -96,23 +84,48 @@ var spawn = function spawn(cmd, argsOrOptions, passedOptions) {
     write: function write(data) {
       stdin.write(data);
     },
+    // Call this function to close stdin, stdout, or stderr.
+    close: function close(stream) {
+      switch (String(stream).toLowerCase()) {
+        case "stdin":
+          {
+            stdin.end();
+            break;
+          }
+        case "stdout":
+          {
+            stdout.end();
+            break;
+          }
+        case "stderr":
+          {
+            stderr.end();
+            break;
+          }
+        default:
+          {
+            throw new Error("Invalid stream name: '".concat(stream, "'. Valid names are 'stdin', 'stdout', or 'stderr'."));
+          }
+      }
+    },
     // Call this function to send a signal to the child process.
     // You can pass "SIGTERM", "SIGKILL", etc. Defaults to "SIGINT".
     kill: function kill() {
       var signal = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : "SIGINT";
-
       if (running) {
         child.kill(signal);
       }
-
       if (unreffable) {
         unreffable.unref();
       }
     }
   };
-
   if (options.pty) {
-    throw new Error("pty mode is no longer supported due to lack of support for new node.js versions in the node-pty module");
+    child = ptySpawn(cmd, args, options);
+    stdin = child;
+    stdout = child;
+    stderr = null; // no way to tell between stdout and stderr with pty
+    unreffable = child.socket;
   } else {
     child = normalSpawn(cmd, args, options);
     stdin = child.stdin;
@@ -120,9 +133,7 @@ var spawn = function spawn(cmd, argsOrOptions, passedOptions) {
     stderr = child.stderr;
     unreffable = child;
   }
-
   running = true;
-
   var checkForPendingOutputRequestsToResolve = function checkForPendingOutputRequestsToResolve() {
     pendingOutputContainsRequests.forEach(function (request) {
       if (typeof request.value === "string") {
@@ -136,16 +147,13 @@ var spawn = function spawn(cmd, argsOrOptions, passedOptions) {
       }
     });
   };
-
   stdout.setEncoding("utf-8");
-
   var handleStdoutData = function handleStdoutData(data) {
     runContext.result.stdout += data;
     outputContainsBuffer += data;
     debugLog("STDOUT: ".concat(data.toString()));
     checkForPendingOutputRequestsToResolve();
   };
-
   if (stdout.onData) {
     // the pty instance returned by node-pty
     // requires attaching handlers differently
@@ -153,11 +161,11 @@ var spawn = function spawn(cmd, argsOrOptions, passedOptions) {
   } else {
     stdout.on("data", handleStdoutData);
   }
-
   if (stderr) {
-    stderr.setEncoding("utf-8"); // this is never a pty instance,
-    // so we don't need to deal with onData here:
+    stderr.setEncoding("utf-8");
 
+    // this is never a pty instance,
+    // so we don't need to deal with onData here:
     stderr.on("data", function (data) {
       runContext.result.stderr += data;
       outputContainsBuffer += data;
@@ -165,7 +173,6 @@ var spawn = function spawn(cmd, argsOrOptions, passedOptions) {
       checkForPendingOutputRequestsToResolve();
     });
   }
-
   runContext.completion = new Promise(function (resolve) {
     var finish = function finish(reason) {
       debugLog("Process ".concat(reason));
@@ -176,7 +183,6 @@ var spawn = function spawn(cmd, argsOrOptions, passedOptions) {
         request.reject(new Error("Child process ".concat(reason, " before its output contained the requested content: ").concat(request.value)));
       });
     };
-
     child.once("exit", function (code) {
       runContext.result.code = code;
       finish("exited");
@@ -188,7 +194,6 @@ var spawn = function spawn(cmd, argsOrOptions, passedOptions) {
   });
   return runContext;
 };
-
 module.exports = {
   spawn: spawn
 };

package/dist/index.js.flow

@@ -9,6 +9,7 @@ export type Options = {
   shell?: ?boolean | string,
   windowsVerbatimArguments?: ?boolean,
   windowsHide?: ?boolean,
+  pty?: ?boolean,
 };
 
 export type RunContext = {
@@ -23,6 +24,7 @@ export type RunContext = {
   outputContains(value: string | RegExp): Promise<void>,
   clearOutputContainsBuffer(): void,
   write(data: string | Buffer): void,
+  close(stream: "stdin" | "stdout" | "stderr"): void,
   kill(signal?: string): void,
 };
 

package/package.json

@@ -1,25 +1,26 @@
 {
   "name": "first-base",
-  "version": "0.2.0",
+  "version": "1.4.0",
   "description": "Integration testing for CLI applications",
   "main": "dist/index.js",
   "repository": "https://github.com/suchipi/first-base",
-  "author": "Lily Scott <me@suchipi.com>",
+  "author": "Lily Skye <me@suchipi.com>",
   "license": "MIT",
   "dependencies": {
+    "node-pty": "^1.0.0",
     "strip-ansi": "^5.0.0"
   },
   "devDependencies": {
-    "@babel/cli": "^7.2.3",
-    "@babel/core": "^7.2.2",
-    "@babel/preset-env": "^7.2.3",
+    "@babel/cli": "^7.23.4",
+    "@babel/core": "^7.23.7",
+    "@babel/preset-env": "^7.23.8",
     "babel-core": "^7.0.0-bridge.0",
-    "babel-jest": "^23.6.0",
-    "eslint": "^5.11.1",
-    "eslint-config-unobtrusive": "^1.2.2",
-    "eslint-plugin-import": "^2.14.0",
-    "jest": "^23.6.0",
-    "prettier": "^1.15.3"
+    "babel-jest": "^29.7.0",
+    "eslint": "^8.56.0",
+    "eslint-config-unobtrusive": "^1.2.5",
+    "eslint-plugin-import": "^2.29.1",
+    "jest": "^29.7.0",
+    "prettier": "^3.2.4"
   },
   "scripts": {
     "build": "mkdir -p dist; rm -rf dist/*; babel src/index.js --out-dir dist && cp src/index.js.flow dist/ && cp src/index.d.ts dist/",