Example how to use it in an Electron app

[stoffeastrom]

When I try to fork or spawn in an Electron app I get

Error: Could not call remote function 'fork'. Check that the function signature is correct. Underlying error: Path must be a string. Received [Function: callIntoRenderer]

[Tyriar]

Looks like you're passing in the wrong arguments somehow? I'd need to see the specific call.

On explaining how to use, I try to do this on the README by suggesting a project I also maintain xterm.js:

Writing a terminal emulator (eg. via xterm.js)

Which contains a usage example as a demo https://github.com/sourcelair/xterm.js, could probably also do something here to show how to make a simple Electron terminal app using node-pty and xterm.js.

[stoffeastrom]

This is what I'm trying

const pty = remote.require('node-pty');
pty.spawn('C:/Program Files/Git/bin/bash.exe', [], {
  name: 'xterm-color',
  cols: 80,
  rows: 30,
  cwd: process.cwd,
  env: process.env
});

I have it working with spawning a childProcess and bind it to xterm.js Terminal. However I can't get colors to work since It needs to masquerade as a pty/tty which led me to this project :)

[Tyriar]

You can check out exactly how I do it in VS Code here https://github.com/Microsoft/vscode/blob/master/src/vs/workbench/parts/terminal/electron-browser/terminalProcess.js

Note that terminalProcess.js is being launched as its own process in order to work around the following Electron bug electron/electron#38, terminalProcess.js is launched like this https://github.com/Microsoft/vscode/blob/master/src/vs/workbench/parts/terminal/electron-browser/terminalInstance.ts#L38

Nothing looks particularly bad with your current setup, maybe something is going wrong in the way you're transferring the data between node-pty and xterm.js? I expect something like this:

xterm.on('data', (data) => {
  pty.write(data);
});
pty.on('data', function (data) {
  xterm.write(data);
});

[stoffeastrom]

Cool, I will have a look!

[stoffeastrom]

Holy moly! it just worked 🚀

[stoffeastrom]

I saw that you used the form

import cp = require('child_process');

So I changed my so suddenly I got typescript help and I had ofc an error

process.cwd vs process.cwd() hence the error message.

Thank for this great library!

[Tyriar]

Great! 😄

[Tyriar]

@stoffeastrom while making an electron example I ran into exactly what you hit with process.cwd so I added an exception to give a better error 😛 4ad2860

[Tyriar]

@stoffeastrom thanks for the suggestion, added the example to https://github.com/Tyriar/node-pty/tree/master/examples/electron