first-base 1.3.0 → 1.5.0

package/.node-version

@@ -0,0 +1 @@
+v20.11.1

package/.npm-version

@@ -0,0 +1 @@
+10.2.4

package/dist/find-root-dir.js

@@ -0,0 +1,84 @@
+"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; }
+var fs = require("fs");
+var _require = require("nice-path"),
+  Path = _require.Path;
+var strongRootDirIndicators = [".git", ".hg"];
+var weakRootDirIndicators = ["package-lock.json", ".gitignore", ".hgignore"];
+var veryWeakRootDirIndicators = ["package.json", "README.md"];
+function hasFile(dir, filename) {
+  var fullPath = dir.concat(filename).toString();
+  console.log("checking for ".concat(fullPath));
+  try {
+    return fs.existsSync(fullPath);
+  } catch (err) {
+    return false;
+  }
+}
+function findRootDir(startingDir) {
+  var start = new Path(startingDir).normalize();
+  var searchDirs = [start];
+  var currentPath = start.replaceLast([]);
+  while (currentPath.segments.length > 0) {
+    searchDirs.push(currentPath);
+    currentPath = currentPath.replaceLast([]);
+  }
+  for (var _i = 0, _searchDirs = searchDirs; _i < _searchDirs.length; _i++) {
+    var dir = _searchDirs[_i];
+    var _iterator = _createForOfIteratorHelper(strongRootDirIndicators),
+      _step;
+    try {
+      for (_iterator.s(); !(_step = _iterator.n()).done;) {
+        var indicator = _step.value;
+        if (hasFile(dir, indicator)) {
+          return dir.toString();
+        }
+      }
+    } catch (err) {
+      _iterator.e(err);
+    } finally {
+      _iterator.f();
+    }
+  }
+  for (var _i2 = 0, _searchDirs2 = searchDirs; _i2 < _searchDirs2.length; _i2++) {
+    var _dir = _searchDirs2[_i2];
+    var _iterator2 = _createForOfIteratorHelper(weakRootDirIndicators),
+      _step2;
+    try {
+      for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+        var _indicator = _step2.value;
+        if (hasFile(_dir, _indicator)) {
+          return _dir.toString();
+        }
+      }
+    } catch (err) {
+      _iterator2.e(err);
+    } finally {
+      _iterator2.f();
+    }
+  }
+  for (var _i3 = 0, _searchDirs3 = searchDirs; _i3 < _searchDirs3.length; _i3++) {
+    var _dir2 = _searchDirs3[_i3];
+    var _iterator3 = _createForOfIteratorHelper(veryWeakRootDirIndicators),
+      _step3;
+    try {
+      for (_iterator3.s(); !(_step3 = _iterator3.n()).done;) {
+        var _indicator2 = _step3.value;
+        if (hasFile(_dir2, _indicator2)) {
+          return _dir2.toString();
+        }
+      }
+    } catch (err) {
+      _iterator3.e(err);
+    } finally {
+      _iterator3.f();
+    }
+  }
+  return start.toString();
+}
+module.exports = {
+  findRootDir: findRootDir
+};

package/dist/index.d.ts

@@ -8,6 +8,7 @@ export type Options = {
   shell?: boolean | string;
   windowsVerbatimArguments?: boolean;
   windowsHide?: boolean;
+  pty?: boolean;
 };
 
 export type RunContext = {
@@ -17,6 +18,16 @@ export type RunContext = {
     code: null | number;
     error: boolean;
   };
+  /**
+   * Same as {@link RunContext.result}, but with {@link sanitizers} run on
+   * stdout/stderr.
+   */
+  cleanResult(): {
+    stdout: string;
+    stderr: string;
+    code: null | number;
+    error: boolean;
+  };
   completion: Promise<void>;
   debug(): RunContext;
   outputContains(value: string | RegExp): Promise<void>;
@@ -31,3 +42,25 @@ export const spawn: ((cmd: string) => RunContext) &
   ((cmd: string, args: Array<string>) => RunContext) &
   ((cmd: string, options: Options) => RunContext) &
   ((cmd: string, args: Array<string>, options: Options) => RunContext);
+
+/**
+ * An array of functions that will be run on stdout/stderr when calling
+ * {@link 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.
+ */
+export const sanitizers: Array<(str: string) => string>;

package/dist/index.js

@@ -1,37 +1,33 @@
 "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 _require = require("./sanitizers"),
+  sanitizers = _require.sanitizers;
 
-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 +37,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.
@@ -60,6 +53,17 @@ var spawn = function spawn(cmd, argsOrOptions, passedOptions) {
       // true if the process errored out
       error: false
     },
+    // Return a version of result which has had the string sanitizers run on it
+    cleanResult: function cleanResult() {
+      return Object.assign({}, runContext.result, {
+        stdout: sanitizers.reduce(function (str, transformFn) {
+          return transformFn(str);
+        }, runContext.result.stdout),
+        stderr: sanitizers.reduce(function (str, transformFn) {
+          return transformFn(str);
+        }, runContext.result.stderr)
+      });
+    },
     // Promise that gets resolved when the child process completes.
     completion: null,
     debug: function debug() {
@@ -75,17 +79,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);
       });
     },
@@ -104,19 +105,16 @@ var spawn = function spawn(cmd, argsOrOptions, passedOptions) {
             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'."));
@@ -127,19 +125,20 @@ var spawn = function spawn(cmd, argsOrOptions, passedOptions) {
     // 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;
@@ -147,9 +146,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") {
@@ -163,16 +160,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
@@ -180,11 +174,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;
@@ -192,7 +186,6 @@ var spawn = function spawn(cmd, argsOrOptions, passedOptions) {
       checkForPendingOutputRequestsToResolve();
     });
   }
-
   runContext.completion = new Promise(function (resolve) {
     var finish = function finish(reason) {
       debugLog("Process ".concat(reason));
@@ -203,7 +196,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");
@@ -215,7 +207,7 @@ var spawn = function spawn(cmd, argsOrOptions, passedOptions) {
   });
   return runContext;
 };
-
 module.exports = {
-  spawn: spawn
+  spawn: spawn,
+  sanitizers: sanitizers
 };

package/dist/index.js.flow

@@ -9,6 +9,7 @@ export type Options = {
   shell?: ?boolean | string,
   windowsVerbatimArguments?: ?boolean,
   windowsHide?: ?boolean,
+  pty?: ?boolean,
 };
 
 export type RunContext = {
@@ -32,6 +33,8 @@ interface Exports {
   spawn(cmd: string, args: Array<string>): RunContext;
   spawn(cmd: string, options: Options): RunContext;
   spawn(cmd: string, args: Array<string>, options: Options): RunContext;
+
+  sanitizers: Array<(str: string) => string>;
 }
 
 declare module.exports: Exports;

package/dist/sanitizers.js

@@ -0,0 +1,32 @@
+"use strict";
+
+var stripAnsi = require("strip-ansi");
+var _require = require("./find-root-dir"),
+  findRootDir = _require.findRootDir;
+function escapeRegex(str) {
+  return str.replace(/[/\-\\^$*+?.()|[\]{}]/g, "\\$&");
+}
+var sanitizers = [stripAnsi, Object.assign(function replaceRootDir(str) {
+  var here = process.cwd();
+  var rootDir = replaceRootDir.cache.get(here) || findRootDir(here);
+  replaceRootDir.cache.set(here, rootDir);
+  return str.replace(new RegExp(escapeRegex(rootDir), "g"), "<rootDir>");
+}, {
+  cache: new Map()
+}), function replaceCwd(str) {
+  return str.replace(new RegExp(escapeRegex(process.cwd()), "g"), "<cwd>");
+}, function collapseStackTrace(str) {
+  return str
+  // replace stack trace lines with a single "at somewhere" line
+  // explanation of regexp:
+  //   newline, optional ansi escape, zero or more whitespace(s), "at",
+  //   whitespace(s), several non-newline characters... and that whole
+  //   thing can happen more than once
+  .replaceAll(/(?:\n(?:\x1B\[\d+m)?(\s*)at\s+[^\n]+)+/g, "\n$1at somewhere");
+}, function omitThrowLineNumber(str) {
+  // omit line number from eg. "<rootDir>/dist/match.js:57\n\t\t\t\tthrow"
+  return str.replaceAll(/(\.js):\d+(\s+throw)/g, "$1$2");
+}];
+module.exports = {
+  sanitizers: sanitizers
+};

package/package.json

@@ -1,28 +1,36 @@
 {
   "name": "first-base",
-  "version": "1.3.0",
+  "version": "1.5.0",
   "description": "Integration testing for CLI applications",
   "main": "dist/index.js",
-  "repository": "https://github.com/suchipi/first-base",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/suchipi/first-base.git"
+  },
   "author": "Lily Skye <me@suchipi.com>",
   "license": "MIT",
   "dependencies": {
-    "strip-ansi": "^5.0.0"
+    "node-pty": "^1.0.0",
+    "strip-ansi": "^5.0.0",
+    "nice-path": "^2.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/",
+    "build": "mkdir -p dist; rm -rf dist/*; babel src --out-dir dist && cp src/index.js.flow dist/ && cp src/index.d.ts dist/",
     "test": "jest"
+  },
+  "jest": {
+    "prettierPath": null
   }
 }

package/.eslintignore

@@ -1 +0,0 @@
-*.flow