first-base 1.5.1 → 1.5.2

package/.node-version

@@ -1 +1 @@
-v20.11.1
+v20.11.1

package/.npm-version

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

package/README.md

@@ -1,142 +1,142 @@
-# `first-base`
-
-Integration testing for CLI applications.
-
-## Usage Example
-
-```js
-const { spawn } = require("first-base");
-
-test("something", async () => {
-  const run = spawn("node", ["-i"]); // launch node REPL
-  await run.outputContains("> "); // wait until `> ` is logged
-  run.write("2 + 2\n"); // enter `2 + 2` and press enter
-  await run.outputContains("4"); // wait until `4` is logged
-  run.kill(); // Ctrl+C
-  await run.completion; // Wait until process exits
-});
-```
-
-## API
-
-### `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).
-
-Returns a `RunContext` object; see below.
-
-### `RunContext#result`
-
-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`
-
-This object gets updated over time as the process runs.
-
-#### Usage
-
-```js
-const run = spawn("ls", { cwd: __dirname });
-console.log(run.result); // { stdout: '', stderr: '', code: null, error: false }
-await run.completion;
-console.log(run.result); // { stdout: 'README.md\npackage.json\nindex.js\n', stderr: '', code: 0, error: false }
-```
-
-### `RunContext#completion`
-
-A Promise that gets resolved when the process completes. You can `await` it in your tests.
-
-#### Usage
-
-```js
-const run = spawn("ls", { cwd: __dirname });
-await run.completion; // Waits until the `ls` process finishes
-```
-
-### `RunContext#debug() => RunContext`
-
-Enables debug logging for the `RunContext` and returns it. Useful when your tests are failing and you want to understand what's going on.
-
-Returns itself so you can add it to a variable declaration easily.
-
-#### Usage
-
-```js
-const run = spawn("ls", { cwd: __dirname }).debug();
-// The following messages are logged to the console over time:
-//
-// STDOUT: README.md\npackage.json\nindex.js
-// Process exited
-// { stdout: 'README.md\npackage.json\nindex.js', stderr: '', code: 0, error: false }
-```
-
-### `RunContext#outputContains(value: string | RegExp) => Promise<void>`
-
-Returns a Promise that will resolve once the process's output (combined STDOUT/STDERR) contains either the specified string or matches the specified RegExp. Ignores ANSI control characters.
-
-#### Usage
-
-```js
-const run = spawn("node", ["-i"]); // start Node.js REPL
-await run.outputContains("> "); // Wait until prompt appears
-```
-
-### `RunContext#clearOutputContainsBuffer()`
-
-Clears the buffer of "seen" output as far as the `outputContains` method is concerned. Useful if the output already contains the specified value, and you want to wait until it appears a second time.
-
-#### Usage
-
-```js
-const run = spawn("node", ["-i"]); // start Node.js REPL
-await run.outputContains("> "); // Wait until prompt appears
-run.write("2 + 2\n"); // Write 2 + 2 then press enter
-run.clearOutputContainsBuffer();
-await run.outputContains("> "); // Wait until prompt appears a second time. If we hadn't cleared the buffer, this would resolve immediately.
-```
-
-### `RunContext#write(data: string | Buffer)`
-
-Write some data into the process's STDIN stream.
-
-#### Usage
-
-```js
-const run = spawn("node", ["-i"]); // start Node.js REPL
-await run.outputContains("> "); // Wait until prompt appears
-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"`.
-
-#### Usage
-
-```js
-const run = spawn("node", ["-i"]);
-run.kill(); // Kill with SIGINT
-// OR:
-run.kill("SIGKILL"); // Kill with SIGKILL
-```
-
-## License
-
-MIT
+# `first-base`
+
+Integration testing for CLI applications.
+
+## Usage Example
+
+```js
+const { spawn } = require("first-base");
+
+test("something", async () => {
+  const run = spawn("node", ["-i"]); // launch node REPL
+  await run.outputContains("> "); // wait until `> ` is logged
+  run.write("2 + 2\n"); // enter `2 + 2` and press enter
+  await run.outputContains("4"); // wait until `4` is logged
+  run.kill(); // Ctrl+C
+  await run.completion; // Wait until process exits
+});
+```
+
+## API
+
+### `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).
+
+Returns a `RunContext` object; see below.
+
+### `RunContext#result`
+
+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`
+
+This object gets updated over time as the process runs.
+
+#### Usage
+
+```js
+const run = spawn("ls", { cwd: __dirname });
+console.log(run.result); // { stdout: '', stderr: '', code: null, error: false }
+await run.completion;
+console.log(run.result); // { stdout: 'README.md\npackage.json\nindex.js\n', stderr: '', code: 0, error: false }
+```
+
+### `RunContext#completion`
+
+A Promise that gets resolved when the process completes. You can `await` it in your tests.
+
+#### Usage
+
+```js
+const run = spawn("ls", { cwd: __dirname });
+await run.completion; // Waits until the `ls` process finishes
+```
+
+### `RunContext#debug() => RunContext`
+
+Enables debug logging for the `RunContext` and returns it. Useful when your tests are failing and you want to understand what's going on.
+
+Returns itself so you can add it to a variable declaration easily.
+
+#### Usage
+
+```js
+const run = spawn("ls", { cwd: __dirname }).debug();
+// The following messages are logged to the console over time:
+//
+// STDOUT: README.md\npackage.json\nindex.js
+// Process exited
+// { stdout: 'README.md\npackage.json\nindex.js', stderr: '', code: 0, error: false }
+```
+
+### `RunContext#outputContains(value: string | RegExp) => Promise<void>`
+
+Returns a Promise that will resolve once the process's output (combined STDOUT/STDERR) contains either the specified string or matches the specified RegExp. Ignores ANSI control characters.
+
+#### Usage
+
+```js
+const run = spawn("node", ["-i"]); // start Node.js REPL
+await run.outputContains("> "); // Wait until prompt appears
+```
+
+### `RunContext#clearOutputContainsBuffer()`
+
+Clears the buffer of "seen" output as far as the `outputContains` method is concerned. Useful if the output already contains the specified value, and you want to wait until it appears a second time.
+
+#### Usage
+
+```js
+const run = spawn("node", ["-i"]); // start Node.js REPL
+await run.outputContains("> "); // Wait until prompt appears
+run.write("2 + 2\n"); // Write 2 + 2 then press enter
+run.clearOutputContainsBuffer();
+await run.outputContains("> "); // Wait until prompt appears a second time. If we hadn't cleared the buffer, this would resolve immediately.
+```
+
+### `RunContext#write(data: string | Buffer)`
+
+Write some data into the process's STDIN stream.
+
+#### Usage
+
+```js
+const run = spawn("node", ["-i"]); // start Node.js REPL
+await run.outputContains("> "); // Wait until prompt appears
+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"`.
+
+#### Usage
+
+```js
+const run = spawn("node", ["-i"]);
+run.kill(); // Kill with SIGINT
+// OR:
+run.kill("SIGKILL"); // Kill with SIGKILL
+```
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -1,66 +1,66 @@
-export type Options = {
-  cwd?: string;
-  env?: { [varName: string]: any };
-  argv0?: string;
-  detached?: boolean;
-  uid?: number;
-  gid?: number;
-  shell?: boolean | string;
-  windowsVerbatimArguments?: boolean;
-  windowsHide?: boolean;
-  pty?: boolean;
-};
-
-export type RunContext = {
-  result: {
-    stdout: string;
-    stderr: string;
-    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>;
-  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;
-};
-
-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>;
+export type Options = {
+  cwd?: string;
+  env?: { [varName: string]: any };
+  argv0?: string;
+  detached?: boolean;
+  uid?: number;
+  gid?: number;
+  shell?: boolean | string;
+  windowsVerbatimArguments?: boolean;
+  windowsHide?: boolean;
+  pty?: boolean;
+};
+
+export type RunContext = {
+  result: {
+    stdout: string;
+    stderr: string;
+    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>;
+  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;
+};
+
+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.flow

@@ -1,40 +1,40 @@
-// @flow
-export type Options = {
-  cwd?: ?string,
-  env?: ?{ [varName: string]: any },
-  argv0?: ?string,
-  detached?: ?boolean,
-  uid?: ?number,
-  gid?: ?number,
-  shell?: ?boolean | string,
-  windowsVerbatimArguments?: ?boolean,
-  windowsHide?: ?boolean,
-  pty?: ?boolean,
-};
-
-export type RunContext = {
-  result: {
-    stdout: string,
-    stderr: string,
-    code: null | number,
-    error: boolean,
-  },
-  completion: Promise<void>,
-  debug(): RunContext,
-  outputContains(value: string | RegExp): Promise<void>,
-  clearOutputContainsBuffer(): void,
-  write(data: string | Buffer): void,
-  close(stream: "stdin" | "stdout" | "stderr"): void,
-  kill(signal?: string): void,
-};
-
-interface Exports {
-  spawn(cmd: string): RunContext;
-  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;
+// @flow
+export type Options = {
+  cwd?: ?string,
+  env?: ?{ [varName: string]: any },
+  argv0?: ?string,
+  detached?: ?boolean,
+  uid?: ?number,
+  gid?: ?number,
+  shell?: ?boolean | string,
+  windowsVerbatimArguments?: ?boolean,
+  windowsHide?: ?boolean,
+  pty?: ?boolean,
+};
+
+export type RunContext = {
+  result: {
+    stdout: string,
+    stderr: string,
+    code: null | number,
+    error: boolean,
+  },
+  completion: Promise<void>,
+  debug(): RunContext,
+  outputContains(value: string | RegExp): Promise<void>,
+  clearOutputContainsBuffer(): void,
+  write(data: string | Buffer): void,
+  close(stream: "stdin" | "stdout" | "stderr"): void,
+  kill(signal?: string): void,
+};
+
+interface Exports {
+  spawn(cmd: string): RunContext;
+  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/package.json

@@ -1,36 +1,38 @@
-{
-  "name": "first-base",
-  "version": "1.5.1",
-  "description": "Integration testing for CLI applications",
-  "main": "dist/index.js",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/suchipi/first-base.git"
-  },
-  "author": "Lily Skye <me@suchipi.com>",
-  "license": "MIT",
-  "dependencies": {
-    "node-pty": "^1.0.0",
-    "strip-ansi": "^5.0.0",
-    "nice-path": "^2.0.0"
-  },
-  "devDependencies": {
-    "@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": "^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 --out-dir dist && cp src/index.js.flow dist/ && cp src/index.d.ts dist/",
-    "test": "jest"
-  },
-  "jest": {
-    "prettierPath": null
-  }
-}
+{
+  "name": "first-base",
+  "version": "1.5.2",
+  "description": "Integration testing for CLI applications",
+  "main": "dist/index.js",
+  "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",
+    "nice-path": "^2.0.0"
+  },
+  "optionalDependencies": {
+    "node-pty": "^1.0.0"
+  },
+  "devDependencies": {
+    "@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": "^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 --out-dir dist && cp src/index.js.flow dist/ && cp src/index.d.ts dist/",
+    "test": "jest"
+  },
+  "jest": {
+    "prettierPath": null
+  }
+}