@inquirer/testing 0.1.0 → 1.0.0

package/README.md

@@ -0,0 +1,61 @@
+# `@inquirer/testing`
+
+The `@inquirer/testing` package is Inquirer's answer to testing prompts [built with `@inquirer/core`](https://github.com/SBoudrias/Inquirer.js/tree/master/packages/core).
+
+# Installation
+
+```sh
+npm install @inquirer/testing
+
+yarn add @inquirer/testing
+```
+
+# Example
+
+Here's an example of a test running with Jest (though `@inquirer/testing` will work with any runners).
+
+```ts
+import { render } from '@inquirer/testing';
+import input from './src/index.mjs';
+
+describe('input prompt', () => {
+  it('handle simple use case', async () => {
+    const { answer, events, getScreen } = await render(input, {
+      message: 'What is your name',
+    });
+
+    expect(getScreen()).toMatchInlineSnapshot(`"? What is your name"`);
+
+    events.type('J');
+    expect(getScreen()).toMatchInlineSnapshot(`"? What is your name J"`);
+
+    events.type('ohn');
+    events.keypress('enter');
+
+    await expect(answer).resolves.toEqual('John');
+    expect(getScreen()).toMatchInlineSnapshot(`"? What is your name John"`);
+  });
+});
+```
+
+# Usage
+
+The core utility of `@inquirer/testing` is the `render()` function. This `render` function will create and instrument a command line like interface.
+
+`render` takes 2 arguments:
+
+1. The Inquirer prompt to test (the return value of `createPrompt()`)
+2. The prompt configuration (the first prompt argument)
+
+`render` then returns a promise that will resolve once the prompt is rendered and the test environment up and running. This promise returns the utilities we'll use to interact with our tests:
+
+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.
+
+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.
+
+# License
+
+Copyright (c) 2022 Simon Boudrias (twitter: [@vaxilart](https://twitter.com/Vaxilart))
+Licensed under the MIT license.

package/dist/cjs/index.js

@@ -8,15 +8,42 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    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 __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
+var _BufferedStream__chunks;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.render = exports.log = void 0;
 const mute_stream_1 = __importDefault(require("mute-stream"));
 const strip_ansi_1 = __importDefault(require("strip-ansi"));
 const node_stream_1 = require("node:stream");
 const logStore = [];
+class BufferedStream extends node_stream_1.Stream.Writable {
+    constructor() {
+        super(...arguments);
+        _BufferedStream__chunks.set(this, []);
+    }
+    _write(chunk, _encoding, callback) {
+        const str = chunk.toString();
+        // 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());
+        }
+        callback();
+    }
+    getLastChunk() {
+        const lastChunk = __classPrivateFieldGet(this, _BufferedStream__chunks, "f")[__classPrivateFieldGet(this, _BufferedStream__chunks, "f").length - 1];
+        return lastChunk !== null && lastChunk !== void 0 ? lastChunk : '';
+    }
+}
+_BufferedStream__chunks = new WeakMap();
 beforeEach(() => {
     logStore.length = 0;
 });
@@ -30,39 +57,30 @@ exports.log = log;
 function render(prompt, props, options) {
     return __awaiter(this, void 0, void 0, function* () {
         const input = new mute_stream_1.default();
-        const buffer = [];
-        const data = [];
-        const output = new node_stream_1.Stream.Writable({
-            write(chunk, _encoding, next) {
-                buffer.push(chunk.toString());
-                next();
-            },
-        });
-        const processScreen = () => {
-            if (buffer.length > 0) {
-                const prevScreen = buffer.join('');
-                data.push((0, strip_ansi_1.default)(prevScreen));
-                buffer.length = 0;
-            }
-        };
+        input.unmute();
+        const output = new BufferedStream();
         const answer = prompt(props, Object.assign({ input, output }, options));
         // Wait for event listeners to be ready
         yield Promise.resolve();
         yield Promise.resolve();
         const events = {
             keypress(name) {
-                processScreen();
                 input.emit('keypress', null, { name });
             },
+            type(text) {
+                input.write(text);
+                for (const char of text) {
+                    input.emit('keypress', null, { name: char });
+                }
+            },
         };
         return {
             answer,
             input,
             events,
-            getScreen() {
-                var _a;
-                processScreen();
-                return (_a = data[data.length - 1]) !== null && _a !== void 0 ? _a : '';
+            getScreen({ raw } = {}) {
+                const lastScreen = output.getLastChunk();
+                return raw ? lastScreen : (0, strip_ansi_1.default)(lastScreen).trim();
             },
         };
     });

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

@@ -6,6 +6,9 @@ export declare function render<TestedPrompt extends Prompt<any, any>>(prompt: Te
     input: MuteStream;
     events: {
         keypress(name: string): void;
+        type(text: string): void;
     };
-    getScreen(): string;
+    getScreen({ raw }?: {
+        raw?: boolean | undefined;
+    }): string;
 }>;

package/dist/esm/index.mjs

@@ -2,6 +2,23 @@ import MuteStream from 'mute-stream';
 import stripAnsi from 'strip-ansi';
 import { Stream } from 'node:stream';
 const logStore = [];
+class BufferedStream extends Stream.Writable {
+    #_chunks = [];
+    _write(chunk, _encoding, callback) {
+        const str = chunk.toString();
+        // 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());
+        }
+        callback();
+    }
+    getLastChunk() {
+        const lastChunk = this.#_chunks[this.#_chunks.length - 1];
+        return lastChunk ?? '';
+    }
+}
 beforeEach(() => {
     logStore.length = 0;
 });
@@ -13,38 +30,30 @@ export function log(...line) {
 }
 export async function render(prompt, props, options) {
     const input = new MuteStream();
-    const buffer = [];
-    const data = [];
-    const output = new Stream.Writable({
-        write(chunk, _encoding, next) {
-            buffer.push(chunk.toString());
-            next();
-        },
-    });
-    const processScreen = () => {
-        if (buffer.length > 0) {
-            const prevScreen = buffer.join('');
-            data.push(stripAnsi(prevScreen));
-            buffer.length = 0;
-        }
-    };
+    input.unmute();
+    const output = new BufferedStream();
     const answer = prompt(props, { input, output, ...options });
     // Wait for event listeners to be ready
     await Promise.resolve();
     await Promise.resolve();
     const events = {
         keypress(name) {
-            processScreen();
             input.emit('keypress', null, { name });
         },
+        type(text) {
+            input.write(text);
+            for (const char of text) {
+                input.emit('keypress', null, { name: char });
+            }
+        },
     };
     return {
         answer,
         input,
         events,
-        getScreen() {
-            processScreen();
-            return data[data.length - 1] ?? '';
+        getScreen({ raw } = {}) {
+            const lastScreen = output.getLastChunk();
+            return raw ? lastScreen : stripAnsi(lastScreen).trim();
         },
     };
 }

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

@@ -6,6 +6,9 @@ export declare function render<TestedPrompt extends Prompt<any, any>>(prompt: Te
     input: MuteStream;
     events: {
         keypress(name: string): void;
+        type(text: string): void;
     };
-    getScreen(): string;
+    getScreen({ raw }?: {
+        raw?: boolean | undefined;
+    }): string;
 }>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inquirer/testing",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "engines": {
     "node": ">=14.18.0"
   },
@@ -60,7 +60,7 @@
   "license": "MIT",
   "homepage": "https://github.com/SBoudrias/Inquirer.js/blob/master/packages/testing/README.md",
   "dependencies": {
-    "@inquirer/type": "^0.1.0",
+    "@inquirer/type": "^1.0.0",
     "mute-stream": "^1.0.0",
     "strip-ansi": "^7.0.1"
   },
@@ -83,5 +83,5 @@
       }
     }
   },
-  "gitHead": "bd58130dd8204945a31b062070b829003b8385fc"
+  "gitHead": "e93c4cb14f0c35ebd1efb065776b90f48899b075"
 }