@lvce-editor/pty-host 0.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022-present, Le Vivilet
+
+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

@@ -0,0 +1,9 @@
+# pty-host
+
+Like in VSCode, the `pty-host` is NodeJS process that is used for spawning terminal processes (pty's).
+
+It is a separate process, because the application should still
+
+Even though pty's could be spawned from the shared-process, the application
+will be more error tolerant with a separate pty-host process.
+For example, when node-pty cannot be installed, or when there is a native exception, the application will still work (without terminals).

package/bin/ptyHost.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+import '../src/ptyHostMain.js'

package/index.js

@@ -0,0 +1,6 @@
+import { dirname, join } from 'path'
+import { fileURLToPath } from 'url'
+
+const __dirname = dirname(fileURLToPath(import.meta.url))
+
+export const ptyHostPath = join(__dirname, 'src', 'ptyHostMain.js')

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@lvce-editor/pty-host",
+  "version": "0.0.2",
+  "description": "",
+  "main": "index.js",
+  "type": "module",
+  "scripts": {
+    "test": "node --unhandled-rejections=warn --experimental-vm-modules ../../node_modules/jest/bin/jest.js --detectOpenHandles --forceExit",
+    "test:watch": "node --unhandled-rejections=warn --experimental-vm-modules ../../node_modules/jest/bin/jest.js --watch"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "debug": "^4.3.4",
+    "verror": "^1.10.1"
+  },
+  "devDependencies": {
+    "@types/verror": "^1.10.5"
+  },
+  "optionalDependencies": {
+    "node-pty": "^0.10.1"
+  },
+  "xo": {
+    "rules": {
+      "unicorn/filename-case": "off",
+      "indent": "off",
+      "semi": "off",
+      "no-unused-vars": "off",
+      "unicorn/numeric-separators-style": "off",
+      "no-extra-semi": "off",
+      "arrow-body-style": "off",
+      "padded-blocks": "off",
+      "capitalized-comments": "off",
+      "padding-line-between-statements": "off",
+      "arrow-parens": "off",
+      "no-warning-comments": "off",
+      "array-bracket-spacing": "off",
+      "comma-spacing": "off",
+      "unicorn/no-array-callback-reference": "off",
+      "comma-dangle": "off",
+      "operator-linebreak": "off",
+      "no-case-declarations": "off",
+      "no-undef": "off",
+      "object-curly-spacing": "off",
+      "object-shorthand": "off",
+      "complexity": "off",
+      "no-labels": "off",
+      "no-multi-assign": "off",
+      "max-params": "off",
+      "no-bitwise": "off",
+      "unicorn/prefer-math-trunc": "off",
+      "no-await-in-loop": "off",
+      "unicorn/prefer-add-event-listener": "off",
+      "no-unused-expressions": "off",
+      "node/prefer-global/process": "off",
+      "unicorn/no-for-loop": "off",
+      "unicorn/prevent-abbreviations": "off"
+    },
+    "ignores": [
+      "distmin"
+    ]
+  }
+}

package/src/parts/Assert/Assert.js

@@ -0,0 +1,57 @@
+const getType = (value) => {
+  switch (typeof value) {
+    case 'number':
+      return 'number'
+    case 'function':
+      return 'function'
+    case 'string':
+      return 'string'
+    case 'object':
+      if (value === null) {
+        return 'null'
+      }
+      if (Array.isArray(value)) {
+        return 'array'
+      }
+      return 'object'
+    case 'boolean':
+      return 'boolean'
+    default:
+      return 'unknown'
+  }
+}
+
+export const object = (value) => {
+  const type = getType(value)
+  if (type !== 'object') {
+    throw new Error('expected value to be of type object')
+  }
+}
+
+export const number = (value) => {
+  const type = getType(value)
+  if (type !== 'number') {
+    throw new Error('expected value to be of type number')
+  }
+}
+
+export const array = (value) => {
+  const type = getType(value)
+  if (type !== 'array') {
+    throw new Error('expected value to be of type array')
+  }
+}
+
+export const string = (value) => {
+  const type = getType(value)
+  if (type !== 'string') {
+    throw new Error('expected value to be of type string')
+  }
+}
+
+export const boolean = (value) => {
+  const type = getType(value)
+  if (type !== 'boolean') {
+    throw new Error('expected value to be of type boolean')
+  }
+}

package/src/parts/Debug/Debug.js

@@ -0,0 +1,3 @@
+import debugModule from 'debug'
+
+export const debug = debugModule('pty-host')

package/src/parts/Platform/Platform.js

@@ -0,0 +1 @@
+export const isWindows = process.platform === 'win32'

package/src/parts/Pty/Pty.js

@@ -0,0 +1,48 @@
+import { spawn } from 'node-pty'
+import * as Platform from '../Platform/Platform.js'
+import * as Assert from '../Assert/Assert.js'
+
+const getSpawnOptions = () => {
+  if (Platform.isWindows) {
+    return {
+      command: 'powershell.exe',
+      args: [],
+    }
+  }
+  return {
+    command: 'bash',
+    args: ['-i'],
+  }
+}
+
+export const create = ({ env = {}, cwd } = {}) => {
+  const spawnOptions = getSpawnOptions()
+  const pty = spawn(spawnOptions.command, spawnOptions.args, {
+    encoding: null,
+    cwd,
+    // cols: 10,
+    // rows: 10,
+  })
+  return pty
+}
+
+export const onData = (pty, fn) => {
+  Assert.object(pty)
+  pty.onData(fn)
+}
+
+export const write = (pty, data) => {
+  Assert.object(pty)
+  pty.write(data)
+}
+
+export const resize = (pty, columns, rows) => {
+  Assert.object(pty)
+  Assert.number(columns)
+  Assert.number(rows)
+  pty.resize(columns, rows)
+}
+
+export const dispose = (pty) => {
+  pty.kill()
+}

package/src/parts/PtyController/PtyController.js

@@ -0,0 +1,40 @@
+import * as Pty from '../Pty/Pty.js'
+import * as Debug from '../Debug/Debug.js'
+
+export const state = {
+  ptyMap: Object.create(null),
+}
+
+// TODO maybe merge pty and pty controller
+export const create = (id, cwd) => {
+  Debug.debug(`create ${id} ${cwd}`)
+  const pty = Pty.create({ cwd })
+  const handleData = (data) => {
+    if (process.send) {
+      process.send({
+        jsonrpc: '2.0',
+        method: 'Terminal.handleData',
+        params: [id, data],
+      })
+    }
+  }
+  Pty.onData(pty, handleData)
+  state.ptyMap[id] = pty
+}
+
+export const write = (id, data) => {
+  const pty = state.ptyMap[id]
+  Pty.write(pty, data)
+}
+
+export const dispose = (id) => {
+  const pty = state.ptyMap[id]
+  Pty.dispose(pty)
+  delete state.ptyMap[id]
+}
+
+export const disposeAll = () => {
+  for (const id in state.ptyMap) {
+    dispose(id)
+  }
+}

package/src/ptyHostMain.js

@@ -0,0 +1,26 @@
+import * as PtyController from './parts/PtyController/PtyController.js'
+import * as Debug from './parts/Debug/Debug.js'
+
+const handleMessage = (message) => {
+  switch (message.method) {
+    case 'Terminal.create':
+      Debug.debug('create terminal')
+      PtyController.create(...message.params)
+      break
+    case 'Terminal.write':
+      PtyController.write(...message.params)
+      break
+    default:
+      console.warn('unknown message', message)
+      break
+  }
+}
+
+const main = async () => {
+  process.on('message', handleMessage)
+  if (process.send) {
+    process.send('ready')
+  }
+}
+
+main()