@basthon/console-react 0.5.5 → 0.5.8

package/lib/gui/terminal.d.ts

@@ -27,14 +27,20 @@ export default class Terminal {
      * Force waiting for input to end.
      */
     private _stopWaitInput;
+    /**
+     * Mask user input and keep it out of the history
+     * (password input).
+     */
+    private _setPasswordMode;
     /**
      * Print a string in the terminal.
+     * If `className` is provided, the text is wrapped in a span with this class.
      */
-    echo(message: string): void;
+    echo(message: string, className?: string): void;
     /**
      * Print error in terminal (in red).
      */
-    error(message: string): JQueryTerminal<HTMLElement>;
+    error(message: string): void;
     /**
      * Pause the terminal execution (usefull to wait for event or promise).
      */

package/lib/gui/terminal.js

@@ -25,6 +25,21 @@ export default class Terminal {
                 await kernel.ready();
                 return (await kernel.complete(command))?.[0] ?? [];
             },
+            keymap: {
+                // JQuery.terminal's CTRL+C copies echoed commands twice (they share
+                // role="presentation" with the command line) so we copy the
+                // selected text ourselves (like right click > copy)
+                "CTRL+C": (e, original) => {
+                    const text = window.getSelection()?.toString();
+                    if (!text)
+                        return original(e);
+                    // without clipboard API, fallback to browser's native copy
+                    if (navigator.clipboard == null)
+                        return true;
+                    navigator.clipboard.writeText(text.replace(/\xA0/g, " "));
+                    return false;
+                },
+            },
         });
         // this prevents JQuery Terminal to redraw terminal and remove
         // script wrapping feature
@@ -55,6 +70,7 @@ export default class Terminal {
             },
             "eval.input": (data) => {
                 this._inputMode = true;
+                this._setPasswordMode(data?.content?.password === true);
                 const prompt = data?.content?.prompt;
                 if (prompt != null)
                     this.echo(prompt);
@@ -90,6 +106,7 @@ export default class Terminal {
         if (this._inputMode) {
             this._term.set_prompt("");
             this._inputMode = false;
+            this._setPasswordMode(false);
             this.pause();
             this._inputResolve?.(command);
             return;
@@ -114,14 +131,29 @@ export default class Terminal {
             return;
         this._inputResolve?.();
         this._inputMode = false;
+        this._setPasswordMode(false);
+    }
+    /**
+     * Mask user input and keep it out of the history
+     * (password input).
+     */
+    _setPasswordMode(on) {
+        this._term.set_mask(on);
+        if (on)
+            this._term.history().disable();
+        else
+            this._term.history().enable();
     }
     /**
      * Print a string in the terminal.
+     * If `className` is provided, the text is wrapped in a span with this class.
      */
-    echo(message) {
+    echo(message, className) {
         // JQuery.terminal adds a trailing newline that is not easy
         // to remove with the current API. Doing our best here.
-        message = message.toString();
+        // escape brackets to prevent JQuery.terminal from interpreting
+        // [[...]] (e.g. Python's nested lists) as formatting or commands
+        message = $.terminal.escape_brackets(message.toString());
         // prompt can be polluted with previous echo
         // _prompt_tail is the line part just before the prompt
         const term = this._term;
@@ -132,14 +164,17 @@ export default class Terminal {
         else
             prompt_tail = "";
         // here, prompt and _prompt_tail should be correctly isolated
-        const lines = message.split("\n");
+        let lines = message.split("\n");
+        // formatting is applied line by line (empty formatting is avoided)
+        if (className != null)
+            lines = lines.map((l) => (l ? `[[;;;${className}]${l}]` : l));
         lines[0] = prompt_tail + lines[0];
         prompt_tail = lines.pop() ?? "";
         term.set_prompt(prompt_tail + prompt);
         if (lines.length) {
             // term.echo("") does not display blank line
             // so we replace this call with term.echo('\b')
-            term.echo(lines.join("\n") || "\b");
+            term.echo(lines.join("\n") || "\b", { exec: false });
         }
         this._prompt_tail = prompt_tail;
     }
@@ -147,10 +182,9 @@ export default class Terminal {
      * Print error in terminal (in red).
      */
     error(message) {
-        // JQuery.terminal adds a trailing newline that is not easy
-        // to remove with the current API. Doing our best here.
-        message = message.toString();
-        return this._term.error(message.replace(/\n+$/, ""));
+        // stderr can be written in several chunks (not always ending with
+        // a newline) so we rely on echo to handle partial lines
+        this.echo(message, "terminal-error");
     }
     /**
      * Pause the terminal execution (usefull to wait for event or promise).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@basthon/console-react",
-  "version": "0.5.5",
+  "version": "0.5.8",
   "description": "Basthon - Console React Component",
   "homepage": "https://basthon.fr",
   "bugs": {
@@ -15,12 +15,10 @@
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "directories": {
-    "lib": "lib/",
-    "patches": "patches/"
+    "lib": "lib/"
   },
   "files": [
-    "lib",
-    "patches"
+    "lib"
   ],
   "exports": {
     ".": {
@@ -55,7 +53,7 @@
     "clean": "rimraf lib/"
   },
   "dependencies": {
-    "@basthon/gui-react": "0.78.5",
+    "@basthon/gui-react": "0.78.6",
     "@fontsource/open-sans": "^5.2.7",
     "@fortawesome/fontawesome-svg-core": "7.3.0",
     "@fortawesome/free-regular-svg-icons": "7.3.0",
@@ -65,7 +63,7 @@
     "constants-browserify": "^1.0.0",
     "immer": "10.2.0",
     "jquery": "^3.6.4",
-    "jquery.terminal": "patch:jquery.terminal@npm%3A2.45.2#./patches/jquery.terminal-npm-2.45.2-065beff1cb.patch",
+    "jquery.terminal": "2.45.2",
     "notie": "^4.3.1",
     "react-ace": "^13.0.0",
     "tty-browserify": "^0.0.1",

package/patches/jquery.terminal-npm-2.45.2-065beff1cb.patch

@@ -1,13 +0,0 @@
-diff --git a/js/jquery.terminal.js b/js/jquery.terminal.js
-index ed30f14fac229448c2b5b4ce8ed5437567723805..4aef6feaac0ba5a8ffc0dc34ac4e92e1ea725db5 100644
---- a/js/jquery.terminal.js
-+++ b/js/jquery.terminal.js
-@@ -1286,7 +1286,7 @@
-     var command_re = /((?:"[^"\\]*(?:\\[\S\s][^"\\]*)*"|'[^'\\]*(?:\\[\S\s][^'\\]*)*'|`[^`\\]*(?:\\[\S\s][^`\\]*)*`|\/[^\/\\]*(?:\\[\S\s][^\/\\]*)*\/[gimsuy]*(?=\s|$)|(?:\\\s|\S))+)(?=\s|$)/gi;
-     var extended_command_re = /^\s*((terminal|cmd)::([a-z_]+)\(([\s\S]*)\))\s*$/;
-     var format_exec_split_re = /(\[\[(?:-?[@!gbiusor])*;[^\]]+\](?:\\[[\]]|[^\]])*\]|\[\[[\s\S]+?\]\])/;
--    var format_exec_re = /(\[\[[\s\S]+?\]\])/;
-+    var format_exec_re = /(\[\[(?:[^\][]|\\\])+\]\])/;
-     var float_re = /^[-+]?[0-9]*\.?[0-9]+([eE][-+]?[0-9]+)?$/;
-     var re_re = /^\/((?:\\\/|[^/]|\[[^\]]*\/[^\]]*\])+)\/([gimsuy]*)$/;
-     var string_re = /("(?:[^"\\]|\\(?:\\\\)*"|\\\\)*"|'(?:[^'\\]|\\(?:\\\\)*'|\\\\)*'|`(?:[^`\\]|\\(?:\\\\)*`|\\\\)*`)/;