update

Author: kermanx

package-lock.json

@@ -29,14 +29,14 @@
     "@babel/plugin-transform-typescript": "7.16.7",
     "@babel/preset-env": "7.16.7",
     "@types/jest": "27.4.0",
-    "@types/node": "17.0.0",
     "cross-env": "7.0.3",
     "jest": "27.4.5",
     "node-dev": "7.1.0",
     "ts-node": "10.4.0",
     "typescript": "4.5.4"
   },
   "dependencies": {
+    "@types/node": "^17.0.8",
     "strip-ansi": "^7.0.1",
     "utty": "^1.0.0"
   },

package.json

@@ -1,9 +1,26 @@
-import UStdTty, { StdTty } from "./index";
-
-class FakeStdTty implements StdTty {
+import UNodeTty, { NodeLikeTty } from "./index";
+class FakeNodeTty implements NodeLikeTty {
   lines: string[] = [""];
   y = 0;
   x = 0;
+  resizeListeners: (() => void)[] = [];
+  _columns: number = 100;
+  set columns(col: number) {
+    this._columns = col;
+    this.resizeListeners.forEach((value) => value());
+  }
+  _rows: number = 100;
+  set rows(row: number) {
+    this._rows = row;
+    this.resizeListeners.forEach((value) => value());
+  }
+  on(_event: "resize", listener: () => void): this {
+    this.resizeListeners.push(listener);
+    return this;
+  }
+  getColorDepth(): number {
+    return 24;
+  }
   write(buffer: Uint8Array | string, cb?: (err?: Error) => void): boolean {
     for (let c of buffer) {
       if (c === "\n") {
@@ -33,11 +50,12 @@ class FakeStdTty implements StdTty {
     return true;
   }
 }
-const fake = new FakeStdTty();
-const t = new UStdTty(fake);
+
+const fake = new FakeNodeTty();
+const t = new UNodeTty(fake);
 let lines: string[] = [];
 
-describe("Test UStdTty", () => {
+describe("Test UNodeTty", () => {
   it("should be able to push line correctly", () => {
     for (let i = 0; i < 10; i++) {
       t.pushLine("L" + i);
@@ -58,4 +76,13 @@ describe("Test UStdTty", () => {
     lines[4] = "";
     expect(fake.lines).toEqual(lines);
   });
+  it("should be able to be resized correctly", () => {
+    let called = false;
+    let fn = () => {
+      called = true;
+    };
+    t.onResize(fn);
+    fake.rows++;
+    expect(called).toBeTruthy();
+  });
 });

src/index.test.ts

@@ -1,22 +1,82 @@
 import UTty from "utty";
 import stripAnsi from "strip-ansi";
+import { Direction } from "tty";
 
-export interface StdTty {
+export interface NodeLikeTty {
   write(buffer: Uint8Array | string): boolean;
-  clearLine(dir: -1 | 0 | 1): boolean;
-  moveCursor(dx: number, dy: number): boolean;
+  on(event: "resize", listener: () => void): this;
+  /**
+   * `writeStream.clearLine()` clears the current line of this `WriteStream` in a
+   * direction identified by `dir`.
+   */
+  clearLine(dir: Direction): boolean;
+  /**
+   * `writeStream.cursorTo()` moves this `WriteStream`'s cursor to the specified
+   * position.
+   * @since v0.7.7
+   * @param callback Invoked once the operation completes.
+   * @return `false` if the stream wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`.
+   */
   cursorTo(x: number, y?: number): boolean;
+  /**
+   * `writeStream.moveCursor()` moves this `WriteStream`'s cursor _relative_ to its
+   * current position.
+   * @since v0.7.7
+   * @param callback Invoked once the operation completes.
+   * @return `false` if the stream wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`.
+   */
+  moveCursor(dx: number, dy: number): boolean;
+  /**
+   * Returns:
+   *
+   * * `1` for 2,
+   * * `4` for 16,
+   * * `8` for 256,
+   * * `24` for 16,777,216 colors supported.
+   *
+   * Use this to determine what colors the terminal supports. Due to the nature of
+   * colors in terminals it is possible to either have false positives or false
+   * negatives. It depends on process information and the environment variables that
+   * may lie about what terminal is used.
+   * It is possible to pass in an `env` object to simulate the usage of a specific
+   * terminal. This can be useful to check how specific environment settings behave.
+   *
+   * To enforce a specific color support, use one of the below environment settings.
+   *
+   * * 2 colors: `FORCE_COLOR = 0` (Disables colors)
+   * * 16 colors: `FORCE_COLOR = 1`
+   * * 256 colors: `FORCE_COLOR = 2`
+   * * 16,777,216 colors: `FORCE_COLOR = 3`
+   *
+   * Disabling color support is also possible by using the `NO_COLOR` and`NODE_DISABLE_COLORS` environment variables.
+   * @since v9.9.0
+   * @param [env=process.env] An object containing the environment variables to check. This enables simulating the usage of a specific terminal.
+   */
+  getColorDepth(): number;
+  /**
+   * A `number` specifying the number of columns the TTY currently has. This property
+   * is updated whenever the `'resize'` event is emitted.
+   * @since v0.7.7
+   */
+  columns: number;
+  /**
+   * A `number` specifying the number of rows the TTY currently has. This property
+   * is updated whenever the `'resize'` event is emitted.
+   * @since v0.7.7
+   */
+  rows: number;
 }
 
-export default class UStdTty implements UTty {
-  constructor(tty: StdTty) {
+export default class UNodeTty implements UTty {
+  constructor(tty: NodeLikeTty) {
     this.tty = tty;
+    process.env;
   }
 
   /**
-   * The output stream.
+   * The node lick tty.
    */
-  tty: StdTty;
+  tty: NodeLikeTty;
 
   /**
    * Curent line in terminal (start by 0).
@@ -111,4 +171,9 @@ export default class UStdTty implements UTty {
     return stripAnsi(str).length;
     //return str.length;
   }
+
+  onResize(listener: () => void): boolean {
+    this.tty.on("resize", listener);
+    return true;
+  }
 }