Readline paste bracket mode

[jcubic]

What is the problem this feature will solve?

Found recently about paste bracket mode that would help solve the issue with auto-indentation in NodeJS-based REPLs.

I've asked on StackOveflow but no one answered because I think no one uses such a feature, because no one knows that this exists.

How to use terminal bracket paste mode in Nodejs REPL?

You can read about paste bracket mode on Wikipedia.

What is the feature you are proposing to solve the problem?

Add paste bracket mode to NodeJS readline.

What alternatives have you considered?

The alternatives are flaky hacks.

[jcubic]

Aditional notes

A quick intro to how paste brackets work:

You print this escape sequence:

process.stdout.write('\x1b[?2004h');

and terminal will include \x1b[200~ and \x1b[201~ at the end and the beginning of the pasting text. This allows for the addition of proper indentation to the code if you have language REPL.

If your REPL is a programming language and you auto-indent the user input when copy-paste long code you can skip the auto-indentation if the input text is in paste brackets.

I have an application when I was testing this but the line event removes the escape sequence \x1b[200 and \x1b[201 and only ~ is left which is of no use since the user may add this to the text.

There is a need for some kind of API (like a flag) to turn on paste brackets and send it with a line event so it can be processed. It can even be always sent since to turn this on you need to write the \x1b[?2004h escape sequence.

Without this, you need to use hacks to fix the auto-indentation, but I was not able to create a proper hack for my REPL.

[bnoordhuis]

@jcubic seems like a reasonable thing to support. PR welcome.

[jcubic]

I was looking at the code for readline and I have no idea where ANSI escapes codes are removed.

[bnoordhuis]

Probably emitKeys() in lib/internal/readline/utils.js.

[jcubic]

@bnoordhuis I will try to see what I can do.

One question can you build Node and run it without installation, I don't want to mess up NVM and my local Node installation (I use Fedora GNU/Linux).

Edit:
I'm building right now

[bnoordhuis]

@jcubic yes, the binary ends up in out/Release and you can run it from there.

[jcubic]

I've created a PR, it was testing it with my REPL, and it works much better. I can have a proper auto-indentation without any effort.

I can also update documentation for Node 20 if the feature will be included with that version.

[jcubic]

@bnoordhuis how long it takes for CI/CD to run? I'm waiting 3 weeks for triggering the GitHub action.

[bnoordhuis]

@jcubic can you link me to the pull request?