Skip to content

Releases: microsoft/node-pty

v1.0.0

10 Jul 21:10
d01f07d
Compare
Choose a tag to compare

This is the initial v1.0 release.

See the PR list including all changes below, the latest API is available here.

0.10.0

04 Feb 17:20
c5ccb80
Compare
Choose a tag to compare

🚀 Features

  • Expose IPty.pause(), IPty.resume() APIs to pause and resume the socket respectively (#452) via @meganrogge, this can be used to implement flow control by blocking the process output

🐞 Bug fixes

  • Don't resolve symlinks when launching shell by setting $PWD (#156) via @vvavrychuk
  • Temporarily block signals during forking (#218) via @jerch
  • Throw when args is not a string | string[] (#396) via @Tyriar
  • Fix process name returning garbled text sometimes on macOS (#401) via @Tyriar

📝 Documentation and internal improvements

🎉 New real-world use cases

0.9.0

22 Oct 17:59
beac2b8
Compare
Choose a tag to compare

🚀 Features / API

  • New events API that is easier to use and plays nicer with TypeScript (#283) via @Tyriar
    pty.onData(d => console.log(d));
    pty.onExit(e => console.log(e.exitCode, e.signal));
  • cols and rows are now exposed on IPty (#290) via @Tyriar
    console.log(pty.cols, pty.rows)
  • Experimental flow control APIs are available (#304, #364) via @jerch. Note that they may be removed in the future, see node-pty.d.ts for details and xtermjs/xterm.js#2077 for discussion
  • Promoted conpty support to stable and removed experimental from name (#365) via @Tyriar
    // before
    const pty = spawn(file, args, { experimentalUseConpty: true });
    
    // after
    const pty = spawn(file, args, { useConpty: true });
  • Allow specifying the PSEUDOCONSOLE_INHERIT_CURSOR conpty flag with IWindowsPtyForkOptions.conptyInheritCursor (#309) via @Tyriar

⬆️ Dependencies

🐞 Bug fixes

  • Fix passing null as encoding to use raw buffers (#273, #362) via @anszom, @Tyriar
  • Provide better error message when ioctl fails (#285) via @Tyriar
  • Restore default ctrl+c handler in conpty support (#287) via @Tyriar
  • Mark several APIs as readonly (#308) via @Tyriar
  • Fix crash when using conpty on 32-bit Windows (#314) via @ZoeyR
  • Fix handle inheritance for shells (#334) via @ZoeyR
  • Re-throw release binary require exception when debug require fails (#340) via @Tyriar
  • Avoid specifying /usr/*/lib under libraries (#343) via @deepak1556
  • Fix compilation when VWERASE/VDISCARD are named differently (#358) via @ThePrez
  • Protect calling resize with invalid values from crashing winpty (#363) via @Tyriar

📝 Documentation and internal improvements

⚠️ Deprecations

  • The on event format is now deprecated and will be removed in v1 (#283) via @Tyriar
    // deprecated
    pty.on('data', d => console.log(d));
    
    // recommended
    pty.onData(d => console.log(d));

🎉 New real-world use cases

0.8.1

20 Jan 19:29
Compare
Choose a tag to compare

Bug fixes

  • Fixed IPty.kill when using ConPTY (#262, #263) via @Tyriar
  • Changed ConPTY to be enabled by default on Windows build number 18309+ due to stability concerns (was previously 17692+) (#262) via @Tyriar

0.8.0

21 Dec 20:39
6a385f9
Compare
Choose a tag to compare

Features

Documentation and internal improvements

  • Setup Azure Pipelines CI (#237) via @Tyriar
  • Add section to README about thread safety (#233) via @Gotham13121997
  • Document Ubuntu build dependencies in README (#228) via @Tyriar

0.7.8

28 Sep 18:07
Compare
Choose a tag to compare

Bug fixes

  • Fix Windows quoting of arguments when an argument contains both a space and non-surrounding quotes (#232) via @alexr00

Documentation and internal improvements

  • Added a note to the README about security/containers (#231) via @Tyriar
  • Documented the fact that terminal creation can throw on Windows when the shell path doesn't exist (#227) via @alexr00
  • Improved debugging documentation (#226) via @Tyriar
  • Updated the version of Electron the example works on (#225) via @Tyriar

0.7.7

05 Sep 22:25
Compare
Choose a tag to compare

Bug fixes

  • Fix handling of quote escapes on Windows (#222) via @alexr00, arguments that contain spaces that are not surrounded in quotes are now correctly quoted
  • Fixed an issue where kill didn't work anymore when used with a signal (#206) via @Tyriar, reverting the change in 0.7.5 to deliver signal to all slave processes

0.7.6

25 Jun 18:12
Compare
Choose a tag to compare

Bug fixes

0.7.5

21 Jun 19:05
Compare
Choose a tag to compare

Bug fixes

Internal improvements

Documentation

0.7.4

09 Dec 00:17
50adadc
Compare
Choose a tag to compare

Bug fixes

  • Fixed an issue where the socket would sometimes not properly close on macOS High Sierra 10.13.2 (beta) #164 via @Tyriar