first-base 0.1.3 → 1.3.0

package/README.md

@@ -21,7 +21,7 @@ test("something", async () => {
 
 ### `spawn(command: string, args?: Array<string>, options?: Object) => RunContext`
 
-`args` and `options` are the same as [child_process.spawn](https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options), except you can also put `pty: true` in `options` to launch the process using a psuedoterminal (useful for testing color output).
+`args` and `options` are the same as [child_process.spawn](https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options).
 
 Returns a `RunContext` object; see below.
 
@@ -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,7 +8,6 @@ export type Options = {
   shell?: boolean | string;
   windowsVerbatimArguments?: boolean;
   windowsHide?: boolean;
-  pty?: boolean;
 };
 
 export type RunContext = {
@@ -24,6 +23,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

@@ -4,8 +4,6 @@ function _typeof(obj) { if (typeof Symbol === "function" && typeof Symbol.iterat
 
 var normalSpawn = require("child_process").spawn;
 
-var ptySpawn = require("node-pty").spawn;
-
 var stripAnsi = require("strip-ansi"); // 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
@@ -98,6 +96,33 @@ 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() {
@@ -114,12 +139,7 @@ var spawn = function spawn(cmd, argsOrOptions, passedOptions) {
   };
 
   if (options.pty) {
-    child = ptySpawn(cmd, args, options);
-    stdin = child;
-    stdout = child;
-    stderr = null; // no way to tell between stdout and stderr with pty
-
-    unreffable = child.socket;
+    throw new Error("pty mode is no longer supported due to lack of support for new node.js versions in the node-pty module");
   } else {
     child = normalSpawn(cmd, args, options);
     stdin = child.stdin;
@@ -158,7 +178,7 @@ var spawn = function spawn(cmd, argsOrOptions, passedOptions) {
     // requires attaching handlers differently
     stdout.onData(handleStdoutData);
   } else {
-    stdout.on('data', handleStdoutData);
+    stdout.on("data", handleStdoutData);
   }
 
   if (stderr) {

package/dist/index.js.flow

@@ -9,7 +9,6 @@ export type Options = {
   shell?: ?boolean | string,
   windowsVerbatimArguments?: ?boolean,
   windowsHide?: ?boolean,
-  pty?: ?boolean,
 };
 
 export type RunContext = {
@@ -24,6 +23,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,13 +1,12 @@
 {
   "name": "first-base",
-  "version": "0.1.3",
+  "version": "1.3.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": "^0.9.0",
     "strip-ansi": "^5.0.0"
   },
   "devDependencies": {