first-base 1.6.1 → 2.0.0

package/README.md

@@ -32,7 +32,7 @@ An object with the following properties on it:
 - `stdout` (`string`): All the data the process has written to STDOUT so far
 - `stderr` (`string`): All the data the process has written to STDERR so far
 - `code` (`number | null`): Exit status code, if the process has finished
-- `error` (`boolean`): If the process errored out, this is `true`
+- `error` (`null | Error`): If the process errored out, this is the Error
 
 This object gets updated over time as the process runs.
 
@@ -40,9 +40,9 @@ This object gets updated over time as the process runs.
 
 ```js
 const run = spawn("ls", { cwd: __dirname });
-console.log(run.result); // { stdout: '', stderr: '', code: null, error: false }
+console.log(run.result); // { stdout: '', stderr: '', code: null, error: null }
 await run.completion;
-console.log(run.result); // { stdout: 'README.md\npackage.json\nindex.js\n', stderr: '', code: 0, error: false }
+console.log(run.result); // { stdout: 'README.md\npackage.json\nindex.js\n', stderr: '', code: 0, error: null }
 ```
 
 ### `RunContext#completion`
@@ -70,7 +70,7 @@ const run = spawn("ls", { cwd: __dirname }).debug();
 //
 // STDOUT: README.md\npackage.json\nindex.js
 // Process exited
-// { stdout: 'README.md\npackage.json\nindex.js', stderr: '', code: 0, error: false }
+// { stdout: 'README.md\npackage.json\nindex.js', stderr: '', code: 0, error: null }
 ```
 
 ### `RunContext#outputContains(value: string | RegExp) => Promise<void>`
@@ -173,3 +173,13 @@ It may be beneficial to clean these up in a test timeout handler or etc.
 ## License
 
 MIT
+
+## Upgrading from 1.x
+
+The only things that changed between 1.x and 2.0 are:
+
+- The `error` property of a `RunContext` changed from `boolean` to `null | Error`
+- We switched node-pty fork to a prebuilt one instead of an install-time compiled node-gyp one, which has the side-effect that we only support the following platforms:
+  - Linux arm64 and x86_64
+  - macOS arm64 and x86_64
+  - Windows arm64 and x86_64

package/dist/index.d.ts

@@ -16,7 +16,7 @@ export type RunContext = {
     stdout: string;
     stderr: string;
     code: null | number;
-    error: boolean;
+    error: null | Error;
   };
   /**
    * Same as {@link RunContext.result}, but with {@link sanitizers} run on
@@ -26,7 +26,7 @@ export type RunContext = {
     stdout: string;
     stderr: string;
     code: null | number;
-    error: boolean;
+    error: null | Error;
   };
   completion: Promise<void>;
   debug(): RunContext;

package/dist/index.js

@@ -50,8 +50,8 @@ var spawn = function spawn(cmd, argsOrOptions, passedOptions) {
       stderr: "",
       // Exit status code, if the process has finished.
       code: null,
-      // true if the process errored out
-      error: false
+      // if the process errored out, this will be the Error
+      error: null
     },
     // Return a version of result which has had the string sanitizers run on it
     cleanResult: function cleanResult() {
@@ -134,7 +134,7 @@ var spawn = function spawn(cmd, argsOrOptions, passedOptions) {
     }
   };
   if (options.pty) {
-    var ptySpawn = require("node-pty").spawn;
+    var ptySpawn = require("@lydell/node-pty").spawn;
     child = ptySpawn(cmd, args, options);
     stdin = child;
     stdout = child;
@@ -203,8 +203,8 @@ var spawn = function spawn(cmd, argsOrOptions, passedOptions) {
       runContext.result.code = code;
       finish("exited");
     });
-    child.once("error", function () {
-      runContext.result.error = true;
+    child.once("error", function (error) {
+      runContext.result.error = error;
       finish("errored");
     });
   });

package/dist/index.js.flow

@@ -17,7 +17,7 @@ export type RunContext = {
     stdout: string,
     stderr: string,
     code: null | number,
-    error: boolean,
+    error: null | Error,
   },
   completion: Promise<void>,
   debug(): RunContext,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "first-base",
-  "version": "1.6.1",
+  "version": "2.0.0",
   "description": "Integration testing for CLI applications",
   "main": "dist/index.js",
   "repository": {
@@ -10,11 +10,9 @@
   "author": "Lily Skye <me@suchipi.com>",
   "license": "MIT",
   "dependencies": {
-    "strip-ansi": "^5.0.0",
-    "nice-path": "^3.2.2"
-  },
-  "optionalDependencies": {
-    "node-pty": "^1.0.0"
+    "@lydell/node-pty": "^1.2.0-beta.3",
+    "nice-path": "^3.2.2",
+    "strip-ansi": "^5.0.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.28.6",