refactor: implement new History and CursorText class

Author: fraxken

.gitignore

@@ -60,3 +60,5 @@ typings/
 # JSDoc
 docs/
 jsdoc/
+
+/temp

README.md

@@ -14,7 +14,7 @@ Node.js light and interactive standard input (stdin) crafted for REPL (like) exp
 </p>
 
 ## Requirements
-- [Node.js](https://nodejs.org/en/) v14 or higher
+- [Node.js](https://nodejs.org/en/) v22 or higher
 
 ## Getting Started
 

index.js

@@ -1,11 +1,12 @@
 // Import Node.js Dependencies
-import { emitKeypressEvents } from "readline";
+import { emitKeypressEvents } from "node:readline";
 
 // Import Third-party Dependencies
 import strLength from "string-length";
 
 // Import Internal Dependencies
 import { localMatchOf } from "./src/utils.js";
+import { History } from "./src/history.js";
 
 /**
  * @async
@@ -25,9 +26,7 @@ export default async function stdin(query = "question", options = {}) {
   }
 
   const { history = [], autocomplete = [] } = options;
-  if (!Array.isArray(history)) {
-    throw new TypeError("history must be an Array Object");
-  }
+  const histo = new History(history);
 
   emitKeypressEvents(process.stdin);
   if (!process.stdin.isTTY) {
@@ -46,26 +45,21 @@ export default async function stdin(query = "question", options = {}) {
   return new Promise((resolve) => {
     let rawStr = "";
     let currentCursorPosition = 0;
-    let currentHistoryIndex = history.length;
     let isOriginalStr = true;
-    let autoCompletionActivated = false;
-    let autoCompletionStr = "";
-    let realCompletionStr = "";
+    let completionHint = "";
+    let completionHintStripped = "";
 
-    // eslint-disable-next-line
     function clearAutoCompletion(forceClean = false) {
-      if (autoCompletionActivated) {
+      if (completionHint.length > 0) {
         process.stdout.clearLine(1);
 
-        autoCompletionActivated = false;
-        autoCompletionStr = "";
+        completionHint = "";
       }
       else if (forceClean) {
         process.stdout.clearLine(1);
       }
     }
 
-    // eslint-disable-next-line
     function searchForCompletion(str, forceNextMatch = false) {
       if (noRefComplete.length === 0) {
         return true;
@@ -74,11 +68,10 @@ export default async function stdin(query = "question", options = {}) {
 
       clearAutoCompletion();
       if (localMatch !== null && localMatch !== "") {
-        realCompletionStr = localMatch;
-        autoCompletionStr = `\x1b[90m${localMatch}\x1b[39m`;
-        autoCompletionActivated = true;
-        process.stdout.write(typeof str === "undefined" ? autoCompletionStr : `${str}${autoCompletionStr}`);
-        process.stdout.moveCursor(-strLength(autoCompletionStr), 0);
+        completionHintStripped = localMatch;
+        completionHint = `\x1b[90m${localMatch}\x1b[39m`;
+        process.stdout.write(typeof str === "undefined" ? completionHint : `${str}${completionHint}`);
+        process.stdout.moveCursor(-strLength(completionHint), 0);
 
         return false;
       }
@@ -93,18 +86,12 @@ export default async function stdin(query = "question", options = {}) {
         process.stdin.pause();
         process.stdout.write("\n");
         process.stdin.removeListener("keypress", listener);
-        const uniqueHistorySet = new Set(history);
 
         const trimedRawStr = rawStr.trim();
-        const result = trimedRawStr === "" ? null : trimedRawStr;
-
-        if (result !== null) {
-          uniqueHistorySet.add(rawStr);
+        if (trimedRawStr !== "") {
+          histo.push(trimedRawStr);
         }
-        history.splice(0, history.length);
-        history.push(...uniqueHistorySet);
-
-        resolve(result);
+        resolve(trimedRawStr);
       }
       else if (key.name === "left") {
         if (currentCursorPosition <= 0) {
@@ -122,45 +109,45 @@ export default async function stdin(query = "question", options = {}) {
           return;
         }
 
-        if (!autoCompletionActivated) {
+        if (completionHint.length === 0) {
           return;
         }
 
         clearAutoCompletion();
-        process.stdout.write(realCompletionStr);
-        rawStr += realCompletionStr;
-        currentCursorPosition += realCompletionStr.length;
-        realCompletionStr = "";
+        process.stdout.write(completionHintStripped);
+        rawStr += completionHintStripped;
+        currentCursorPosition += completionHintStripped.length;
+        completionHintStripped = "";
         searchForCompletion(void 0, true);
       }
       else if (key.name === "up" || key.name === "down") {
-        const moveIndexValue = key.name === "up" ? -1 : 1;
-        const nextIndex = currentHistoryIndex + moveIndexValue;
         const rawStrCopy = rawStr;
 
-        if (history.length === 0) {
+        if (histo.length === 0) {
           if (isOriginalStr && rawStrCopy.trim() !== "") {
-            history.push(rawStrCopy);
+            histo.push(rawStrCopy);
+
             isOriginalStr = false;
           }
 
           return;
         }
-        if (nextIndex < 0 || nextIndex >= history.length) {
+
+        const hasSwitchedHistory = key.name === "up" ? histo.up() : histo.down();
+        if (!hasSwitchedHistory) {
           return;
         }
 
         clearAutoCompletion();
-        rawStr = history[nextIndex];
+        rawStr = histo.current;
         process.stdout.moveCursor(-rawStrCopy.length, 0);
         process.stdout.clearLine(1);
         process.stdout.write(rawStr);
 
         currentCursorPosition = rawStr.length;
-        currentHistoryIndex = nextIndex;
 
         if (isOriginalStr && rawStrCopy.trim() !== "") {
-          history.push(rawStrCopy);
+          histo.push(rawStrCopy);
           isOriginalStr = false;
         }
       }

package.json

@@ -6,7 +6,7 @@
   "exports": "./index.js",
   "scripts": {
     "prepublishOnly": "pkg-ok",
-    "test": "node --test test/",
+    "test": "node --test test/**/*.test.js",
     "coverage": "c8 -r html npm test",
     "lint": "eslint ."
   },
@@ -43,12 +43,11 @@
     "string-length": "^6.0.0"
   },
   "devDependencies": {
-    "@nodesecure/eslint-config": "^1.7.0",
-    "c8": "^8.0.0",
-    "eslint": "^8.39.0",
+    "@openally/config.eslint": "^2.1.0",
+    "c8": "^10.1.3",
     "pkg-ok": "^3.0.0"
   },
   "engines": {
-    "node": ">=14"
+    "node": ">=22"
   }
 }

src/cursortext.js

@@ -0,0 +1,40 @@
+export class CursorText {
+  #cursor = 0;
+  #str = "";
+
+  add(char) {
+    this.#str += char;
+
+    return this;
+  }
+
+  remove() {
+    if (this.#str.length > 0) {
+      this.#str = this.#str.slice(0, this.#str.length - 1);
+    }
+
+    return this;
+  }
+
+  synchronize() {
+    this.#cursor = this.#str.length;
+
+    return this;
+  }
+
+  left() {
+    this.#cursor--;
+  }
+
+  right() {
+    this.#cursor++;
+  }
+
+  get cursor() {
+    return this.#cursor;
+  }
+
+  toString() {
+    return this.#str.trim();
+  }
+}

src/history.js

@@ -0,0 +1,55 @@
+
+export class History {
+  #commands = [];
+  #index = 0;
+
+  /**
+   * @param {!string[]} commands
+   */
+  constructor(commands) {
+    if (!Array.isArray(commands)) {
+      throw new TypeError("commands must be an Array");
+    }
+
+    this.#commands = commands;
+    this.#index = this.#commands.length;
+  }
+
+  push(command, noDuplicateCheck = false) {
+    if (noDuplicateCheck || !this.#commands.includes(command)) {
+      this.#commands.push(command);
+    }
+  }
+
+  get current() {
+    if (this.#index === this.#commands.length) {
+      return "";
+    }
+
+    return this.#commands[this.#index];
+  }
+
+  get length() {
+    return this.#commands.length;
+  }
+
+  down() {
+    if (this.#index < this.#commands.length) {
+      this.#index++;
+
+      return true;
+    }
+
+    return false;
+  }
+
+  up() {
+    if (this.#index > 0) {
+      this.#index--;
+
+      return true;
+    }
+
+    return false;
+  }
+}