pty-shell 1.0.6 → 1.1.1

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 xiaobaidadada
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2025 xiaobaidadada
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,30 +1,30 @@
-# pty-shell
-This is a virtual PTY shell that can be used to filter or log executable commands. It can also be used in a browser environment. Currently, it does not support features like piping. It supports the use of `node-pty`. For more usage examples, you can refer to the code in the [filecat](https://github.com/xiaobaidadada/filecat) project.
-It needs to be used in combination with projects similar to xterm.js.
-这是一个虚拟的pty shell ，可以用来过滤或者记录可执行命令， 并可以用于浏览器环境， 目前并不支持管道等功能，支持使用 node-pty ，更多使用例子目前可以参考 filecat(https://github.com/xiaobaidadada/filecat)项目中的代码 。 
-需要配合  xterm.js 类似的项目组合使用
-# Sample Example
-```js
-import {PtyShell} from "pty-shell";
-
-const ptyShell = new PtyShell({
-    cols: 200,
-    rows: 300,
-    cwd: __dirname,
-    node_pty:undefined,
-    node_pty_shell_list: [],
-    env:{},
-    on_call:(data)=>{
-        console.log(data)
-    }
-});
-ptyShell.write("cd .. \r");
-
-```
-
-# supports
-1. commands auto-completion 
-2. command and parameter interception and filtering
-3. browser environment
-4. use node-pty 
+# pty-shell
+This is a virtual PTY shell that can be used to filter or log executable commands. It can also be used in a browser environment. Currently, it does not support features like piping. It supports the use of `node-pty`. For more usage examples, you can refer to the code in the [filecat](https://github.com/xiaobaidadada/filecat) project.
+It needs to be used in combination with projects similar to xterm.js.
+这是一个虚拟的pty shell ，可以用来过滤或者记录可执行命令， 并可以用于浏览器环境， 目前并不支持管道等功能，支持使用 node-pty ，更多使用例子目前可以参考 filecat(https://github.com/xiaobaidadada/filecat)项目中的代码 。 
+需要配合  xterm.js 类似的项目组合使用
+# Sample Example
+```js
+import {PtyShell} from "pty-shell";
+
+const ptyShell = new PtyShell({
+    cols: 200,
+    rows: 300,
+    cwd: __dirname,
+    node_pty:undefined,
+    node_pty_shell_list: [],
+    env:{},
+    on_call:(data)=>{
+        console.log(data)
+    }
+});
+ptyShell.write("cd .. \r");
+
+```
+
+# supports
+1. commands auto-completion 
+2. command and parameter interception and filtering
+3. browser environment
+4. use node-pty 
 5. operations such as command, select all, move, select, etc., similar to those in PowerShell.

package/dist/index.d.ts

@@ -38,6 +38,8 @@ interface Param extends Partial<PtyShellUserMethod> {
     rows?: number;
     env?: any;
     node_pty_shell_list?: string[];
+    history_line?: string[];
+    history_line_max?: number;
 }
 type CmdHandler = (params: string[], send_prompt?: (data: string) => void) => void;
 export declare class PtyShell implements PtyShellUserMethod {
@@ -53,6 +55,7 @@ export declare class PtyShell implements PtyShellUserMethod {
         char_num: number;
     };
     on_call: (data: string) => void;
+    on_call_child_raw?: (data: string) => void;
     on_control_cmd: (type: exec_cmd_type, data?: string) => void;
     on_child_kill?: (code: number, pid?: number) => void;
     check_exe_cmd: any;
@@ -75,6 +78,7 @@ export declare class PtyShell implements PtyShellUserMethod {
     private select_end;
     private history_line;
     private history_line_index;
+    private history_line_max;
     /**
      * public method
      */

package/dist/index.js

@@ -99,6 +99,7 @@ class PtyShell {
         this.select_end = -2;
         this.history_line = [];
         this.history_line_index = -1;
+        this.history_line_max = 20;
         this.next_not_enter = false;
         this.reset_option(param);
         if (!this.not_use_node_pre_cmd_exec) {
@@ -712,7 +713,7 @@ class PtyShell {
             return; // 和最后的一样就不插入了
         }
         this.history_line.push(line);
-        if (this.history_line.length > 20) {
+        if (this.history_line.length > this.history_line_max) {
             this.history_line.shift(); // 删除最前面的
         }
         this.history_line_index = -1;
@@ -832,6 +833,9 @@ class PtyShell {
             this.child = this.node_pty.spawn(exe, params, Object.assign({ name: 'xterm-color', cols: this.cols, rows: this.rows, cwd: this.cwd, useConptyDll: false, useConpty: process.env.NODE_ENV !== "production" ? false : undefined, env: Object.assign(Object.assign({}, process.env), this.env) }, spawn_option));
             this.child.onData((data) => {
                 this.on_call(data.toString());
+                if (this.on_call_child_raw) {
+                    this.on_call_child_raw(data);
+                }
             });
             this.child.onExit(({ exitCode, signal }) => {
                 this.close_child(exitCode);
@@ -855,11 +859,17 @@ class PtyShell {
             this.child.stdout.on('data', (data) => {
                 // const v = data.toString(); // 子程序没有换行等符号不会立即输出 有缓冲区
                 this.send_and_enter(data.toString());
+                if (this.on_call_child_raw) {
+                    this.on_call_child_raw(data);
+                }
             });
             this.child.stderr.on('data', (data) => {
                 // const v = data.toString();
                 this.send_and_enter(data.toString());
                 this.next_not_enter = false; // 下一次的换行输出 上一次没有换行
+                if (this.on_call_child_raw) {
+                    this.on_call_child_raw(data);
+                }
             });
             this.child.on('exit', (code) => {
                 this.close_child(code);

package/package.json

@@ -1,39 +1,39 @@
-{
-  "name": "pty-shell",
-  "version": "1.0.6",
-  "description": "a virtual PTY shell for javaScript",
-  "author": "xiaobaidadada",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "repository": {
-    "type": "git",
-    "url": "git@github.com:xiaobaidadada/pty-shell.git"
-  },
-  "homepage": "https://github.com/xiaobaidadada/pty-shell",
-  "bugs": {
-    "url": "https://github.com/xiaobaidadada/pty-shell/issues"
-  },
-  "scripts": {
-    "build": "tsc"
-  },
-  "devDependencies": {
-    "@types/node": "^22.13.10",
-    "typescript": "^5.5.3"
-  },
-  "files": [
-    "dist/**/*",
-    "LICENSE.txt",
-    "README.md",
-    "package.json"
-  ],
-  "keywords":[
-    "pty",
-    "shell",
-    "tty",
-    "terminal",
-    "browser",
-    "web",
-    "virtual",
-    "command intercept"
-  ]
-}
+{
+  "name": "pty-shell",
+  "version": "1.1.1",
+  "description": "a virtual PTY shell for javaScript",
+  "author": "xiaobaidadada",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:xiaobaidadada/pty-shell.git"
+  },
+  "homepage": "https://github.com/xiaobaidadada/pty-shell",
+  "bugs": {
+    "url": "https://github.com/xiaobaidadada/pty-shell/issues"
+  },
+  "scripts": {
+    "build": "tsc"
+  },
+  "devDependencies": {
+    "@types/node": "^22.13.10",
+    "typescript": "^5.5.3"
+  },
+  "files": [
+    "dist/**/*",
+    "LICENSE.txt",
+    "README.md",
+    "package.json"
+  ],
+  "keywords":[
+    "pty",
+    "shell",
+    "tty",
+    "terminal",
+    "browser",
+    "web",
+    "virtual",
+    "command intercept"
+  ]
+}