@gjsify/tty 0.0.2

package/README.md

@@ -0,0 +1,8 @@
+# @gjsify/tty
+
+## Inspirations
+- https://github.com/geut/brode/blob/main/packages/browser-node-core/src/tty.js
+- https://github.com/browserify/tty-browserify
+- https://github.com/denoland/deno_std/blob/main/node/tty.ts
+- https://github.com/jvilk/bfs-process/blob/master/ts/tty.ts
+- https://nodejs.org/api/tty.html

package/lib/cjs/index.js

@@ -0,0 +1,123 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var src_exports = {};
+__export(src_exports, {
+  ReadStream: () => ReadStream,
+  WriteStream: () => WriteStream,
+  default: () => src_default,
+  isatty: () => isatty
+});
+module.exports = __toCommonJS(src_exports);
+var import_stream = require("stream");
+var import_utils = require("@gjsify/utils");
+class ReadStream extends import_stream.Readable {
+  isRaw = false;
+  get isTTY() {
+    return true;
+  }
+  setRawMode(mode) {
+    if (this.isRaw !== mode) {
+      this.isRaw = mode;
+      this.emit("modeChange");
+    }
+  }
+}
+class WriteStream extends import_stream.Writable {
+  isRaw = false;
+  columns = 80;
+  rows = 120;
+  // TODO stdout / stderr
+  _print = console.log;
+  // TODO fd
+  constructor(fd) {
+    super();
+  }
+  get isTTY() {
+    return true;
+  }
+  clearLine(dir, callback) {
+    (0, import_utils.warnNotImplemented)("WriteStream.clearLine");
+    if (callback)
+      callback();
+    return true;
+  }
+  clearScreenDown(callback) {
+    (0, import_utils.warnNotImplemented)("WriteStream.clearScreenDown");
+    if (callback)
+      callback();
+    return true;
+  }
+  cursorTo(x, y, callback) {
+    (0, import_utils.warnNotImplemented)("WriteStream.cursorTo");
+    if (callback)
+      callback();
+    return true;
+  }
+  getColorDepth(env) {
+    (0, import_utils.warnNotImplemented)("WriteStream.getColorDepth");
+    return 8;
+  }
+  getWindowSize() {
+    (0, import_utils.warnNotImplemented)("WriteStream.getWindowSize");
+    return [this.columns, this.rows];
+  }
+  hasColors(count = 16, env) {
+    switch (this.getColorDepth(env)) {
+      case 1:
+        return count >= 2;
+      case 4:
+        return count >= 16;
+      case 8:
+        return count >= 256;
+      case 24:
+        return count >= 16777216;
+      default:
+        return false;
+    }
+  }
+  setRawMode(mode) {
+    if (this.isRaw !== mode) {
+      this.isRaw = mode;
+      this.emit("modeChange");
+    }
+  }
+  _write(chunk, enc, cb) {
+    this._print(enc === "buffer" ? chunk.toString("utf-8") : chunk);
+    cb(null);
+  }
+  _changeColumns(columns) {
+    if (columns !== this.columns) {
+      this.columns = columns;
+      this.emit("resize");
+    }
+  }
+  _changeRows(rows) {
+    if (rows !== this.rows) {
+      this.rows = rows;
+      this.emit("resize");
+    }
+  }
+}
+const isatty = (fd) => {
+  return fd && (fd instanceof ReadStream || fd instanceof WriteStream);
+};
+var src_default = {
+  isatty,
+  WriteStream,
+  ReadStream
+};

package/lib/esm/index.js

@@ -0,0 +1,104 @@
+import { Writable, Readable } from "stream";
+import { warnNotImplemented } from "@gjsify/utils";
+class ReadStream extends Readable {
+  isRaw = false;
+  get isTTY() {
+    return true;
+  }
+  setRawMode(mode) {
+    if (this.isRaw !== mode) {
+      this.isRaw = mode;
+      this.emit("modeChange");
+    }
+  }
+}
+class WriteStream extends Writable {
+  isRaw = false;
+  columns = 80;
+  rows = 120;
+  // TODO stdout / stderr
+  _print = console.log;
+  // TODO fd
+  constructor(fd) {
+    super();
+  }
+  get isTTY() {
+    return true;
+  }
+  clearLine(dir, callback) {
+    warnNotImplemented("WriteStream.clearLine");
+    if (callback)
+      callback();
+    return true;
+  }
+  clearScreenDown(callback) {
+    warnNotImplemented("WriteStream.clearScreenDown");
+    if (callback)
+      callback();
+    return true;
+  }
+  cursorTo(x, y, callback) {
+    warnNotImplemented("WriteStream.cursorTo");
+    if (callback)
+      callback();
+    return true;
+  }
+  getColorDepth(env) {
+    warnNotImplemented("WriteStream.getColorDepth");
+    return 8;
+  }
+  getWindowSize() {
+    warnNotImplemented("WriteStream.getWindowSize");
+    return [this.columns, this.rows];
+  }
+  hasColors(count = 16, env) {
+    switch (this.getColorDepth(env)) {
+      case 1:
+        return count >= 2;
+      case 4:
+        return count >= 16;
+      case 8:
+        return count >= 256;
+      case 24:
+        return count >= 16777216;
+      default:
+        return false;
+    }
+  }
+  setRawMode(mode) {
+    if (this.isRaw !== mode) {
+      this.isRaw = mode;
+      this.emit("modeChange");
+    }
+  }
+  _write(chunk, enc, cb) {
+    this._print(enc === "buffer" ? chunk.toString("utf-8") : chunk);
+    cb(null);
+  }
+  _changeColumns(columns) {
+    if (columns !== this.columns) {
+      this.columns = columns;
+      this.emit("resize");
+    }
+  }
+  _changeRows(rows) {
+    if (rows !== this.rows) {
+      this.rows = rows;
+      this.emit("resize");
+    }
+  }
+}
+const isatty = (fd) => {
+  return fd && (fd instanceof ReadStream || fd instanceof WriteStream);
+};
+var src_default = {
+  isatty,
+  WriteStream,
+  ReadStream
+};
+export {
+  ReadStream,
+  WriteStream,
+  src_default as default,
+  isatty
+};

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@gjsify/tty",
+  "version": "0.0.2",
+  "description": "Node.js tty module for Gjs",
+  "main": "lib/cjs/index.js",
+  "module": "lib/esm/index.js",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./lib/types/index.d.ts",
+        "default": "./lib/esm/index.js"
+      },
+      "require": {
+        "types": "./lib/types/index.d.ts",
+        "default": "./lib/cjs/index.js"
+      }
+    }
+  },
+  "scripts": {
+    "clear": "rm -rf lib tsconfig.tsbuildinfo tsconfig.types.tsbuildinfo || exit 0",
+    "print:name": "echo '@gjsify/tty'",
+    "build": "yarn print:name && yarn build:gjsify",
+    "build:gjsify": "gjsify build --library 'src/**/*.{ts,js}' --exclude 'src/**/*.spec.{mts,ts}' 'src/test.{mts,ts}'",
+    "build:test": "yarn build:test:gjs && yarn build:test:node",
+    "build:test:gjs": "gjsify build src/test.mts --app gjs --outfile test.gjs.mjs",
+    "build:test:node": "gjsify build src/test.mts --app node --outfile test.node.mjs",
+    "test": "yarn print:name && yarn build:gjsify && yarn build:test && yarn test:node && yarn test:gjs",
+    "test:gjs": "gjs -m test.gjs.mjs",
+    "test:node": "node test.node.mjs"
+  },
+  "keywords": [
+    "gjs",
+    "node",
+    "tty"
+  ],
+  "devDependencies": {
+    "@gjsify/cli": "^0.0.2",
+    "@types/node": "^20.3.1"
+  },
+  "dependencies": {
+    "@gjsify/utils": "^0.0.2"
+  }
+}

package/src/index.spec.ts

@@ -0,0 +1,9 @@
+import { describe, it, expect } from '@gjsify/unit';
+
+export default async () => {
+	await describe('true', async () => {
+		await it('should be true', async () => {
+			expect(true).toBeTruthy();
+		});
+	});
+}

package/src/index.ts

@@ -0,0 +1,122 @@
+/**
+ * based on:
+ * - https://github.com/jvilk/bfs-process/blob/master/ts/tty.ts
+ * - https://github.com/geut/brode/blob/main/packages/browser-node-core/src/tty.js
+ */
+// import '@gjsify/node-globals';
+import { Writable, Readable } from 'stream';
+import { warnNotImplemented } from '@gjsify/utils';
+export class ReadStream extends Readable {
+  isRaw = false;
+
+  get isTTY() {
+    return true
+  }
+
+  setRawMode(mode: boolean) {
+    if (this.isRaw !== mode) {
+      this.isRaw = mode
+      this.emit('modeChange')
+    }
+  }
+}
+
+export class WriteStream extends Writable {
+
+  isRaw = false;
+  columns = 80;
+  rows = 120;
+
+  // TODO stdout / stderr
+  protected _print = console.log;
+
+  // TODO fd
+  constructor(fd: number) {
+    super();
+  }
+
+  get isTTY() {
+    return true
+  }
+
+  clearLine(dir: number, callback?: () => void): boolean {
+    warnNotImplemented("WriteStream.clearLine");
+    if (callback) callback();
+    return true;
+  }
+
+
+  clearScreenDown(callback?: () => void): boolean {
+    warnNotImplemented("WriteStream.clearScreenDown");
+    if (callback) callback();
+    return true;
+  }
+
+  cursorTo(x: number, y: number, callback?: () => void): boolean {
+    warnNotImplemented("WriteStream.cursorTo");
+    if (callback) callback();
+    return true;
+  }
+
+  getColorDepth(env: Record<string, string>) {
+    warnNotImplemented("WriteStream.getColorDepth");
+    return 8;
+  }
+
+  getWindowSize() {
+    warnNotImplemented("WriteStream.getWindowSize");
+    return [this.columns, this.rows]
+  }
+
+  hasColors(count = 16, env?: Record<string, string>) {
+    switch (this.getColorDepth(env)) {
+      case 1:
+        return count >= 2
+      case 4:
+        return count >= 16
+      case 8:
+        return count >= 256
+      case 24:
+        return count >= 16777216
+      default:
+        return false
+    }
+  }
+
+  setRawMode(mode: boolean) {
+    if (this.isRaw !== mode) {
+      this.isRaw = mode
+      this.emit('modeChange')
+    }
+  }
+
+  override _write (chunk, enc: string, cb: Function) {
+    // TODO stderr / stdout
+    this._print(enc === 'buffer' ? chunk.toString('utf-8') : chunk)
+    cb(null)
+  }
+
+  _changeColumns(columns: number) {
+    if (columns !== this.columns) {
+      this.columns = columns
+      this.emit('resize')
+    }
+  }
+
+  _changeRows(rows: number) {
+    if (rows !== this.rows) {
+      this.rows = rows
+      this.emit('resize')
+    }
+  }
+}
+
+export const isatty = (fd: ReadStream | WriteStream) => {
+  return fd && (fd instanceof ReadStream || fd instanceof WriteStream)
+}
+
+export default {
+  isatty,
+  WriteStream,
+  ReadStream
+}

package/src/test.mts

@@ -0,0 +1,4 @@
+
+import { run } from '@gjsify/unit';
+import testSuite from './index.spec.js';
+run({testSuite});