utilium 0.7.10 → 0.8.0

package/dist/shell.d.ts

@@ -0,0 +1,37 @@
+import type { Terminal } from '@xterm/xterm';
+export interface ShellOptions {
+    /**
+     * The terminal associated with the context
+     */
+    terminal: Terminal;
+    /**
+     * The prompt to use, can be a getter.
+     */
+    readonly prompt?: string;
+    /**
+     * The handler for when a line is parsed
+     */
+    onLine?(this: void, line: string): unknown;
+}
+export interface ShellContext extends Required<ShellOptions> {
+    /**
+     * The input currently being shown
+     */
+    input: string;
+    /**
+     * The index for which input is being shown
+     */
+    index: number;
+    /**
+     * The current, uncached input
+     */
+    currentInput: string;
+    /**
+     * array of previous inputs
+     */
+    inputs: string[];
+}
+/**
+ * Creates a new shell using the provided options
+ */
+export declare function createShell({ terminal, prompt, onLine }: ShellOptions): ShellContext;

package/dist/shell.js

@@ -0,0 +1,79 @@
+function handleData($, data) {
+    if ($.index == -1) {
+        $.currentInput = $.input;
+    }
+    function clear() {
+        $.terminal.write('\x1b[2K\r' + $.prompt);
+    }
+    const x = $.terminal.buffer.active.cursorX - $.prompt.length;
+    switch (data) {
+        case 'ArrowUp':
+        case '\x1b[A':
+            clear();
+            if ($.index < $.inputs.length - 1) {
+                $.input = $.inputs[++$.index];
+            }
+            $.terminal.write($.input);
+            break;
+        case 'ArrowDown':
+        case '\x1b[B':
+            clear();
+            if ($.index >= 0) {
+                $.input = $.index-- == 0 ? $.currentInput : $.inputs[$.index];
+            }
+            $.terminal.write($.input);
+            break;
+        case '\x1b[D':
+            if (x > 0) {
+                $.terminal.write(data);
+            }
+            break;
+        case '\x1b[C':
+            if (x < $.currentInput.length) {
+                $.terminal.write(data);
+            }
+            break;
+        case '\x1b[F':
+            $.terminal.write(`\x1b[${$.prompt.length + $.currentInput.length + 1}G`);
+            break;
+        case '\x1b[H':
+            $.terminal.write(`\x1b[${$.prompt.length + 1}G`);
+            break;
+        case '\x7f':
+            if (x <= 0) {
+                return;
+            }
+            $.terminal.write('\b\x1b[P');
+            $.input = $.input.slice(0, x - 1) + $.input.slice(x);
+            break;
+        case '\r':
+            if ($.input != $.inputs[0]) {
+                $.inputs.unshift($.input);
+            }
+            $.index = -1;
+            $.input = '';
+            $.terminal.write('\r\n');
+            $.onLine($.currentInput);
+            $.terminal.write($.prompt);
+            break;
+        default:
+            $.terminal.write(data);
+            $.input = $.input.slice(0, x) + data + $.input.slice(x);
+    }
+}
+/**
+ * Creates a new shell using the provided options
+ */
+export function createShell({ terminal, prompt = '', onLine = () => { } }) {
+    const context = {
+        terminal,
+        prompt,
+        onLine,
+        input: '',
+        index: -1,
+        currentInput: '',
+        inputs: [],
+    };
+    terminal.onData(data => handleData(context, data));
+    return context;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "utilium",
-	"version": "0.7.10",
-	"description": "Typescript utilies",
+	"version": "0.8.0",
+	"description": "Typescript utilities",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
 	"type": "module",
@@ -49,5 +49,8 @@
 	},
 	"dependencies": {
 		"eventemitter3": "^5.0.1"
+	},
+	"optionalDependencies": {
+		"@xterm/xterm": "^5.5.0"
 	}
 }

package/readme.md

@@ -10,3 +10,4 @@ A bunch of utilies for Typescript. This includes:
 -   `List`, a class that combines the best aspects of `Set` and arrays
 -   `JSONFileMap` and `FolderMap`
 -   Version utilities
+-   Xterm.js shell handling (arrows, home/end, prompting, etc.)

package/src/shell.ts

@@ -0,0 +1,123 @@
+/* A simple wrapper for xterm.js that makes implementing shells easier */
+import type { Terminal } from '@xterm/xterm';
+
+export interface ShellOptions {
+	/**
+	 * The terminal associated with the context
+	 */
+	terminal: Terminal;
+
+	/**
+	 * The prompt to use, can be a getter.
+	 */
+	readonly prompt?: string;
+
+	/**
+	 * The handler for when a line is parsed
+	 */
+	onLine?(this: void, line: string): unknown;
+}
+
+export interface ShellContext extends Required<ShellOptions> {
+	/**
+	 * The input currently being shown
+	 */
+	input: string;
+
+	/**
+	 * The index for which input is being shown
+	 */
+	index: number;
+
+	/**
+	 * The current, uncached input
+	 */
+	currentInput: string;
+
+	/**
+	 * array of previous inputs
+	 */
+	inputs: string[];
+}
+
+function handleData($: ShellContext, data: string) {
+	if ($.index == -1) {
+		$.currentInput = $.input;
+	}
+
+	function clear(): void {
+		$.terminal.write('\x1b[2K\r' + $.prompt);
+	}
+	const x = $.terminal.buffer.active.cursorX - $.prompt.length;
+	switch (data) {
+		case 'ArrowUp':
+		case '\x1b[A':
+			clear();
+			if ($.index < $.inputs.length - 1) {
+				$.input = $.inputs[++$.index];
+			}
+			$.terminal.write($.input);
+			break;
+		case 'ArrowDown':
+		case '\x1b[B':
+			clear();
+			if ($.index >= 0) {
+				$.input = $.index-- == 0 ? $.currentInput : $.inputs[$.index];
+			}
+			$.terminal.write($.input);
+			break;
+		case '\x1b[D':
+			if (x > 0) {
+				$.terminal.write(data);
+			}
+			break;
+		case '\x1b[C':
+			if (x < $.currentInput.length) {
+				$.terminal.write(data);
+			}
+			break;
+		case '\x1b[F':
+			$.terminal.write(`\x1b[${$.prompt.length + $.currentInput.length + 1}G`);
+			break;
+		case '\x1b[H':
+			$.terminal.write(`\x1b[${$.prompt.length + 1}G`);
+			break;
+		case '\x7f':
+			if (x <= 0) {
+				return;
+			}
+			$.terminal.write('\b\x1b[P');
+			$.input = $.input.slice(0, x - 1) + $.input.slice(x);
+			break;
+		case '\r':
+			if ($.input != $.inputs[0]) {
+				$.inputs.unshift($.input);
+			}
+			$.index = -1;
+			$.input = '';
+			$.terminal.write('\r\n');
+			$.onLine($.currentInput);
+			$.terminal.write($.prompt);
+			break;
+		default:
+			$.terminal.write(data);
+			$.input = $.input.slice(0, x) + data + $.input.slice(x);
+	}
+}
+
+/**
+ * Creates a new shell using the provided options
+ */
+export function createShell({ terminal, prompt = '', onLine = () => {} }: ShellOptions): ShellContext {
+	const context: ShellContext = {
+		terminal,
+		prompt,
+		onLine,
+		input: '',
+		index: -1,
+		currentInput: '',
+		inputs: [],
+	};
+	terminal.onData(data => handleData(context, data));
+	return context;
+}