initial useKeypress

[jedahan]

first draft of #138

todo

• fix typescript definition (never written typescript before)
• run npm test
  - [ ] write documentation
• write example
• write some tests

[sindresorhus]

This needs to handle the case if raw mode is already enabled when this hook is used, it should not be disabled when this hook ends.

[vadimdemedes]

That's actually going to be handled by setRawMode() itself, so hook doesn't need to re-implement that logic :)

[jedahan]

So I got stuck on my test - it would be cool if ava could allow you to get a handle to stdin/stdout or the subprocess when running tests so we can simulate keypresses etc.

[vadimdemedes]

See https://yarnpkg.com/en/package/node-pty on how you can write to stdin of the process created by node-pty (which is used in test/exit.js) ;)

[vadimdemedes]

Hey @jedahan, do you have time to finish this PR? Totally ok if not ;)

[jedahan]

Unfortunately I cannot get master to npm install on my laptop now. Which is weird because a fresh checkout of node-pty 0.8.1 does npm install correctly, but thats where its erroring

[vadimdemedes]

Try using Node.js v10.x.

[sindresorhus]

@jedahan Did you manage to get it to npm install?

[jedahan]

npx -p node@10 npm install && npx -p node@10 npm test passes

[jedahan]

Working on fixing the test now

[jedahan]

I'm rebasing

[jedahan]

I think I've made all the requested changes

[vadimdemedes]

Hey @jedahan, I've tried running node examples/usekeypress and process exits right away, after rendering the output. It doesn't wait for user input.

[vadimdemedes]

I digged deeper and was able to fix it by replacing useEffect with useLayoutEffect. The problem with useEffect is that it fires the handler after rendering is finished, so setRawMode isn't called fast enough. Process sees that there are no more tasks left and exits.

I also decided to switch from using keypress to data event, because when user pastes text into terminal, multiple keypress events are emitted for each character. This is not as convenient as using data event, which contains the whole string in one event.

I'll open another PR, which includes your changes and fixes these things. I will make sure to mention you, of course. Thank you for all your work!

[vadimdemedes]

Opened #227 to take this PR further. I would've asked @jedahan, but I want to release it asap.