first-base 1.5.1 → 1.6.0

package/.node-version

@@ -1 +1 @@
-v20.11.1
+v24.13.0

package/.npm-version

@@ -1 +1 @@
-10.2.4
+11.6.2

package/README.md

@@ -137,6 +137,39 @@ run.kill(); // Kill with SIGINT
 run.kill("SIGKILL"); // Kill with SIGKILL
 ```
 
+### `RunContext#cleanResult()`
+
+A function which returns a new object with the same shape as `RunContext#result` but with its stdout/stderr passed through the `sanitizers` Array (see below).
+
+Unlike `result`, this object does NOT get updated over time as the process runs.
+
+### `sanitizers: Array<(string) => string>`
+
+An array of functions that will be run on stdout/stderr when calling
+`RunContext#cleanResult()`.
+
+By default, it contains 5 functions, which are run in order:
+
+- `stripAnsi`: Removes ANSI control characters
+- `replaceRootDir`: Replaces eg `/home/suchipi/Code/first-base/src/index.js` with `<rootDir>/src/index.js`
+  - This function searches upwards for the root dir using a heuristic, and caches results in the {@link Map} `replaceRootDir.cache`.
+  - The heuristic is:
+    - Look upwards for a folder containing `.git` or `.hg`
+    - if none is found, look upwards for a folder containing `package-lock.json`, `.gitignore` or `.hgignore`,
+    - if none is found, look upwards for a folder containing `package.json` or `README.md`
+    - if none is found, consider the present working directory to be the root dir.
+- `replaceCwd`: Replaces the current working directory with `<cwd>`
+- `collapseStackTrace`: For Node.JS-style stack traces, replaces the long chain of "at ..." lines with a single "at somewhere" line
+- `omitThrowLineNumber`: For Node.JS error source display, removes the line number
+
+You can remove them or replace them or add to them by mutating the `sanitizers` Array.
+
+### `allInflightRunContexts: Set<RunContext>`
+
+All runs that have been spawned which haven't reached completion (see `RunContext#completion`).
+
+It may be beneficial to clean these up in a test timeout handler or etc.
+
 ## License
 
 MIT

package/dist/find-root-dir.js

@@ -1,8 +1,8 @@
 "use strict";
 
-function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it["return"] != null) it["return"](); } finally { if (didErr) throw err; } } }; }
-function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
-function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t["return"] || t["return"](); } finally { if (u) throw o; } } }; }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
 var fs = require("fs");
 var _require = require("nice-path"),
   Path = _require.Path;

package/dist/index.d.ts

@@ -64,3 +64,10 @@ export const spawn: ((cmd: string) => RunContext) &
  * You can remove them or replace them or add to them by mutating the `sanitizers` Array.
  */
 export const sanitizers: Array<(str: string) => string>;
+
+/**
+ * All runs that have been spawned which haven't reached completion.
+ *
+ * It may be beneficial to clean these up in a test timeout handler or etc.
+ */
+export const allInflightRunContexts: Set<RunContext>;

package/dist/index.js

@@ -5,6 +5,7 @@ var normalSpawn = require("child_process").spawn;
 var stripAnsi = require("strip-ansi");
 var _require = require("./sanitizers"),
   sanitizers = _require.sanitizers;
+var allInflightRunContexts = new Set();
 
 // Run a child process and return a "run context" object
 // to interact with it. Function signature is the same as
@@ -147,6 +148,7 @@ var spawn = function spawn(cmd, argsOrOptions, passedOptions) {
     unreffable = child;
   }
   running = true;
+  allInflightRunContexts.add(runContext);
   var checkForPendingOutputRequestsToResolve = function checkForPendingOutputRequestsToResolve() {
     pendingOutputContainsRequests.forEach(function (request) {
       if (typeof request.value === "string") {
@@ -191,6 +193,7 @@ var spawn = function spawn(cmd, argsOrOptions, passedOptions) {
       debugLog("Process ".concat(reason));
       debugLog(runContext.result);
       running = false;
+      allInflightRunContexts["delete"](runContext);
       resolve();
       pendingOutputContainsRequests.forEach(function (request) {
         request.reject(new Error("Child process ".concat(reason, " before its output contained the requested content: ").concat(request.value)));
@@ -209,5 +212,6 @@ var spawn = function spawn(cmd, argsOrOptions, passedOptions) {
 };
 module.exports = {
   spawn: spawn,
-  sanitizers: sanitizers
+  sanitizers: sanitizers,
+  allInflightRunContexts: allInflightRunContexts
 };

package/dist/index.js.flow

@@ -35,6 +35,8 @@ interface Exports {
   spawn(cmd: string, args: Array<string>, options: Options): RunContext;
 
   sanitizers: Array<(str: string) => string>;
+
+  allInflightRunContexts: Set<RunContext>;
 }
 
 declare module.exports: Exports;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "first-base",
-  "version": "1.5.1",
+  "version": "1.6.0",
   "description": "Integration testing for CLI applications",
   "main": "dist/index.js",
   "repository": {
@@ -10,21 +10,23 @@
   "author": "Lily Skye <me@suchipi.com>",
   "license": "MIT",
   "dependencies": {
-    "node-pty": "^1.0.0",
     "strip-ansi": "^5.0.0",
-    "nice-path": "^2.0.0"
+    "nice-path": "^3.2.2"
+  },
+  "optionalDependencies": {
+    "node-pty": "^1.0.0"
   },
   "devDependencies": {
-    "@babel/cli": "^7.23.4",
-    "@babel/core": "^7.23.7",
-    "@babel/preset-env": "^7.23.8",
+    "@babel/cli": "^7.28.6",
+    "@babel/core": "^7.29.0",
+    "@babel/preset-env": "^7.29.0",
     "babel-core": "^7.0.0-bridge.0",
-    "babel-jest": "^29.7.0",
+    "babel-jest": "^30.2.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"
+    "jest": "^30.2.0",
+    "prettier": "^3.8.1"
   },
   "scripts": {
     "build": "mkdir -p dist; rm -rf dist/*; babel src --out-dir dist && cp src/index.js.flow dist/ && cp src/index.d.ts dist/",