@inquirer/testing 1.0.6 → 2.1.0

package/README.md

@@ -52,6 +52,7 @@ The core utility of `@inquirer/testing` is the `render()` function. This `render
 1. `answer` (`Promise`) This is the promise that'll be resolved once an answer is provided and valid.
 2. `getScreen` (`({ raw: boolean }) => string`) This function returns the state of what is printed on the command line screen at any given time. You can use its return value to validate your prompt is properly rendered. By default this function will strip the ANSI codes (used for colors.)
 3. `events` (`{ keypress: (name) => void, type: (string) => void }`) Is the utilities allowing you to interact with the prompt. Use it to trigger keypress events, or typing any input.
+4. `getFullOutput` (`() => string`) Return a raw dump of everything that got sent on the output stream.
 
 You can refer to [the `@inquirer/input` prompt test suite](https://github.com/SBoudrias/Inquirer.js/blob/master/packages/input/test.mts) as a practical example.
 

package/dist/cjs/index.js

@@ -13,36 +13,56 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-var _BufferedStream__chunks;
+var _BufferedStream__fullOutput, _BufferedStream__chunks, _BufferedStream__rawChunks;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.render = void 0;
 const mute_stream_1 = __importDefault(require("mute-stream"));
 const strip_ansi_1 = __importDefault(require("strip-ansi"));
+const ansi_escapes_1 = __importDefault(require("ansi-escapes"));
 const node_stream_1 = require("node:stream");
+const ignoredAnsi = new Set([ansi_escapes_1.default.cursorHide, ansi_escapes_1.default.cursorShow]);
 class BufferedStream extends node_stream_1.Stream.Writable {
     constructor() {
         super(...arguments);
+        _BufferedStream__fullOutput.set(this, '');
         _BufferedStream__chunks.set(this, []);
+        _BufferedStream__rawChunks.set(this, []);
     }
     _write(chunk, _encoding, callback) {
         const str = chunk.toString();
+        __classPrivateFieldSet(this, _BufferedStream__fullOutput, __classPrivateFieldGet(this, _BufferedStream__fullOutput, "f") + str, "f");
+        // There's some ANSI Inquirer just send to keep state of the terminal clear; we'll ignore those since they're
+        // unlikely to be used by end users or part of prompt code.
+        if (!ignoredAnsi.has(str)) {
+            __classPrivateFieldGet(this, _BufferedStream__rawChunks, "f").push(str);
+        }
         // Stripping the ANSI codes here because Inquirer will push commands ANSI (like cursor move.)
         // This is probably fine since we don't care about those for testing; but this could become
         // an issue if we ever want to test for those.
         if ((0, strip_ansi_1.default)(str).trim().length > 0) {
-            __classPrivateFieldGet(this, _BufferedStream__chunks, "f").push(chunk.toString());
+            __classPrivateFieldGet(this, _BufferedStream__chunks, "f").push(str);
         }
         callback();
     }
-    getLastChunk() {
-        const lastChunk = __classPrivateFieldGet(this, _BufferedStream__chunks, "f")[__classPrivateFieldGet(this, _BufferedStream__chunks, "f").length - 1];
+    getLastChunk({ raw }) {
+        const chunks = raw ? __classPrivateFieldGet(this, _BufferedStream__rawChunks, "f") : __classPrivateFieldGet(this, _BufferedStream__chunks, "f");
+        const lastChunk = chunks[chunks.length - 1];
         return lastChunk !== null && lastChunk !== void 0 ? lastChunk : '';
     }
+    getFullOutput() {
+        return __classPrivateFieldGet(this, _BufferedStream__fullOutput, "f");
+    }
 }
-_BufferedStream__chunks = new WeakMap();
+_BufferedStream__fullOutput = new WeakMap(), _BufferedStream__chunks = new WeakMap(), _BufferedStream__rawChunks = new WeakMap();
 function render(prompt, props, options) {
     return __awaiter(this, void 0, void 0, function* () {
         const input = new mute_stream_1.default();
@@ -68,9 +88,12 @@ function render(prompt, props, options) {
             input,
             events,
             getScreen({ raw } = {}) {
-                const lastScreen = output.getLastChunk();
+                const lastScreen = output.getLastChunk({ raw });
                 return raw ? lastScreen : (0, strip_ansi_1.default)(lastScreen).trim();
             },
+            getFullOutput() {
+                return output.getFullOutput();
+            },
         };
     });
 }

package/dist/cjs/types/index.d.cts

@@ -1,7 +1,7 @@
 import MuteStream from 'mute-stream';
 import type { Prompt } from '@inquirer/type';
 export declare function render<TestedPrompt extends Prompt<any, any>>(prompt: TestedPrompt, props: Parameters<TestedPrompt>[0], options?: Parameters<TestedPrompt>[1]): Promise<{
-    answer: Promise<any>;
+    answer: import("@inquirer/type").CancelablePromise<any>;
     input: MuteStream;
     events: {
         keypress(name: string): void;
@@ -10,4 +10,5 @@ export declare function render<TestedPrompt extends Prompt<any, any>>(prompt: Te
     getScreen({ raw }?: {
         raw?: boolean | undefined;
     }): string;
+    getFullOutput(): string;
 }>;

package/dist/esm/index.mjs

@@ -1,22 +1,36 @@
 import MuteStream from 'mute-stream';
 import stripAnsi from 'strip-ansi';
+import ansiEscapes from 'ansi-escapes';
 import { Stream } from 'node:stream';
+const ignoredAnsi = new Set([ansiEscapes.cursorHide, ansiEscapes.cursorShow]);
 class BufferedStream extends Stream.Writable {
+    #_fullOutput = '';
     #_chunks = [];
+    #_rawChunks = [];
     _write(chunk, _encoding, callback) {
         const str = chunk.toString();
+        this.#_fullOutput += str;
+        // There's some ANSI Inquirer just send to keep state of the terminal clear; we'll ignore those since they're
+        // unlikely to be used by end users or part of prompt code.
+        if (!ignoredAnsi.has(str)) {
+            this.#_rawChunks.push(str);
+        }
         // Stripping the ANSI codes here because Inquirer will push commands ANSI (like cursor move.)
         // This is probably fine since we don't care about those for testing; but this could become
         // an issue if we ever want to test for those.
         if (stripAnsi(str).trim().length > 0) {
-            this.#_chunks.push(chunk.toString());
+            this.#_chunks.push(str);
         }
         callback();
     }
-    getLastChunk() {
-        const lastChunk = this.#_chunks[this.#_chunks.length - 1];
+    getLastChunk({ raw }) {
+        const chunks = raw ? this.#_rawChunks : this.#_chunks;
+        const lastChunk = chunks[chunks.length - 1];
         return lastChunk ?? '';
     }
+    getFullOutput() {
+        return this.#_fullOutput;
+    }
 }
 export async function render(prompt, props, options) {
     const input = new MuteStream();
@@ -42,8 +56,11 @@ export async function render(prompt, props, options) {
         input,
         events,
         getScreen({ raw } = {}) {
-            const lastScreen = output.getLastChunk();
+            const lastScreen = output.getLastChunk({ raw });
             return raw ? lastScreen : stripAnsi(lastScreen).trim();
         },
+        getFullOutput() {
+            return output.getFullOutput();
+        },
     };
 }

package/dist/esm/types/index.d.mts

@@ -1,7 +1,7 @@
 import MuteStream from 'mute-stream';
 import type { Prompt } from '@inquirer/type';
 export declare function render<TestedPrompt extends Prompt<any, any>>(prompt: TestedPrompt, props: Parameters<TestedPrompt>[0], options?: Parameters<TestedPrompt>[1]): Promise<{
-    answer: Promise<any>;
+    answer: import("@inquirer/type").CancelablePromise<any>;
     input: MuteStream;
     events: {
         keypress(name: string): void;
@@ -10,4 +10,5 @@ export declare function render<TestedPrompt extends Prompt<any, any>>(prompt: Te
     getScreen({ raw }?: {
         raw?: boolean | undefined;
     }): string;
+    getFullOutput(): string;
 }>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inquirer/testing",
-  "version": "1.0.6",
+  "version": "2.1.0",
   "engines": {
     "node": ">=14.18.0"
   },
@@ -60,7 +60,8 @@
   "license": "MIT",
   "homepage": "https://github.com/SBoudrias/Inquirer.js/blob/master/packages/testing/README.md",
   "dependencies": {
-    "@inquirer/type": "^1.0.5",
+    "@inquirer/type": "^1.1.0",
+    "ansi-escapes": "^4.3.2",
     "mute-stream": "^1.0.0",
     "strip-ansi": "^6.0.1"
   },
@@ -83,5 +84,5 @@
       }
     }
   },
-  "gitHead": "235c18f13650735b201a8853b28eda001f953d0f"
+  "gitHead": "4c139f50414bd538eae1d48e61fd2586581d3e70"
 }