repl: add possibility to edit multiline commands while adding them #58003

puskin · 2025-04-24T12:10:53Z

Summary

This PR builds upon the multiline editing support added to the REPL history in #57400, enhancing it with the ability to edit multiline input as you're writing it, before it even reaches the history.

Key Features

Inline Multiline Editing: You can now insert, delete, edit, and split lines while composing a REPL command. This brings a more fluid editing experience, similar to what you'd expect from a basic code editor. See the GIF below for a demo.
TTY-only Support: This feature makes heavy use of cursor movement to efficiently draw and clear parts of the current input. As a result, it currently only works in TTY environments.
Unchanged Execution Behavior: Pressing Enter behaves as usual:
- If the current input is a complete and valid command, it executes.
- If not, a new line is added, continuing multiline input.
Limitations:
- If you want to insert a new line in the middle of a complete multiline command, you’ll need to first make the command incomplete (e.g. by removing a closing } or `).
- The logic for inserting new lines in complete commands is in place, but I ran into trouble capturing a reliable shortcut like Shift + Enter. I’ve left a TODO to revisit this and debug further.

EDIT

Implemented vertical cursor movement as well

codecov · 2025-04-24T13:01:07Z

Codecov Report

Attention: Patch coverage is 99.54751% with 1 line in your changes missing coverage. Please review.

Project coverage is 90.22%. Comparing base (c11c7be) to head (1030ce5).
Report is 455 commits behind head on main.

Files with missing lines	Patch %	Lines
lib/internal/readline/interface.js	99.48%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #58003      +/-   ##
==========================================
- Coverage   90.24%   90.22%   -0.02%     
==========================================
  Files         630      630              
  Lines      185788   186589     +801     
  Branches    36429    36639     +210     
==========================================
+ Hits       167659   168358     +699     
- Misses      11004    11051      +47     
- Partials     7125     7180      +55

Files with missing lines	Coverage Δ
lib/internal/readline/utils.js	`98.33% <100.00%> (+0.06%)`	⬆️
lib/repl.js	`94.98% <100.00%> (-0.05%)`	⬇️
lib/internal/readline/interface.js	`97.25% <99.48%> (+0.45%)`	⬆️

... and 95 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

BridgeAR

This is great work and almost LGTM! I would just like to have some more tests for positions pressing enter before the end.

One behavior that I noticed that could be improved after landing is the cursor positioning while moving upwards. Imagine line 12\n1\n123 UP, UP. The cursor should actually be at the end of line 1 (12) instead of in the middle. It is a typical behavior when moving the cursor up, so keeping that would be nice.

Fixing faulty entries does not work fully anymore for multiline entries. Those do show up in my history after editing the former part. That does not have to block this PR though, since it's a nice to have.

lib/internal/readline/interface.js

BridgeAR · 2025-04-30T17:11:06Z

test/parallel/test-repl-multiline-navigation-while-adding.js

+const repl = require('internal/repl');
+const stream = require('stream');
+
+class ActionStream extends stream.Stream {


We repeat this in pretty much all REPL tests. Maybe it's time for a helper method? :)
I am a bit uncertain where to place that though. Mostly common is a place for helpers but this is very specific for the REPL, so maybe somewhere else.

This is not blocking.

test/parallel/test-repl-multiline-navigation-while-adding.js

lib/repl.js

lib/internal/readline/interface.js

puskin · 2025-04-30T19:23:58Z

Fixing faulty entries does not work fully anymore for multiline entries. Those do show up in my history after editing the former part. That does not have to block this PR though, since it's a nice to have.

interesting, I cannot replicate the issue (we also have a specific test for this).
What I am doing to test the behavior is to paste this

let lineWithMistake = `I have some
problem with` my syntax'

and then fixing it editing the history, and it is working just fine. What are you typing to make the functionality break?

BridgeAR · 2025-04-30T23:13:36Z

interesting, I cannot replicate the issue (we also have a specific test for this).
What I am doing to test the behavior is to paste this

I just had another look and it and it is actually working! I created a ReferenceError, not a SyntaxError. We could probably handle it identically but that is something for another PR as further improvement :)

lib/internal/readline/interface.js

BridgeAR

LGTM with my last comment addressed. This is really good work!

nodejs-github-bot · 2025-04-30T23:31:33Z

CI: https://ci.nodejs.org/job/node-test-pull-request/66521/

lib/internal/readline/interface.js

nodejs-github-bot · 2025-05-02T17:19:52Z

CI: https://ci.nodejs.org/job/node-test-pull-request/66548/

nodejs-github-bot · 2025-05-02T21:50:50Z

CI: https://ci.nodejs.org/job/node-test-pull-request/66551/

nodejs-github-bot · 2025-05-03T07:06:31Z

CI: https://ci.nodejs.org/job/node-test-pull-request/66556/

nodejs-github-bot · 2025-05-03T14:17:08Z

CI: https://ci.nodejs.org/job/node-test-pull-request/66562/

nodejs-github-bot · 2025-05-03T17:10:12Z

CI: https://ci.nodejs.org/job/node-test-pull-request/66567/

nodejs-github-bot · 2025-05-04T17:35:22Z

CI: https://ci.nodejs.org/job/node-test-pull-request/66590/

nodejs-github-bot · 2025-05-04T18:13:31Z

Commit Queue failed

- Loading data for nodejs/node/pull/58003 ✔ Done loading data for nodejs/node/pull/58003 ----------------------------------- PR info ------------------------------------ Title repl: add possibility to edit multiline commands while adding them (#58003) ⚠ Could not retrieve the email or name of the PR author's from user's GitHub profile! Branch puskin:repl-multiline-refactor-and-while-typing -> nodejs:main Labels readline, repl, author ready, needs-ci Commits 2 - repl: add possibility to edit multiline commands while adding them - repl: add proper vertical cursor movements Committers 1 - Giovanni <github@puskin.it> PR-URL: https://github.com/nodejs/node/pull/58003 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Pietro Marchini <pietro.marchini94@gmail.com> ------------------------------ Generated metadata ------------------------------ PR-URL: https://github.com/nodejs/node/pull/58003 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Pietro Marchini <pietro.marchini94@gmail.com> -------------------------------------------------------------------------------- ℹ This PR was created on Thu, 24 Apr 2025 12:10:53 GMT ✔ Approvals: 2 ✔ - Ruben Bridgewater (@BridgeAR) (TSC): https://github.com/nodejs/node/pull/58003#pullrequestreview-2812512679 ✔ - Pietro Marchini (@pmarchini): https://github.com/nodejs/node/pull/58003#pullrequestreview-2813299994 ✔ Last GitHub CI successful ℹ Last Full PR CI on 2025-05-04T17:35:22Z: https://ci.nodejs.org/job/node-test-pull-request/66590/ - Querying data for job/node-test-pull-request/66590/ ✔ Last Jenkins CI successful -------------------------------------------------------------------------------- ✔ No git cherry-pick in progress ✔ No git am in progress ✔ No git rebase in progress -------------------------------------------------------------------------------- - Bringing origin/main up to date... From https://github.com/nodejs/node * branch main -> FETCH_HEAD ✔ origin/main is now up-to-date - Downloading patch for 58003 From https://github.com/nodejs/node * branch refs/pull/58003/merge -> FETCH_HEAD ✔ Fetched commits as 5fb879c4584c..1030ce5cbc8a -------------------------------------------------------------------------------- [main 745059a9c5] repl: add possibility to edit multiline commands while adding them Author: Giovanni <github@puskin.it> Date: Wed Apr 23 15:05:56 2025 +0200 7 files changed, 506 insertions(+), 53 deletions(-) create mode 100644 test/parallel/test-repl-multiline-navigation-while-adding.js [main 48af18f664] repl: add proper vertical cursor movements Author: Giovanni <github@puskin.it> Date: Thu May 1 10:20:17 2025 +0200 3 files changed, 121 insertions(+), 38 deletions(-) ✔ Patches applied There are 2 commits in the PR. Attempting autorebase. Rebasing (2/4) Executing: git node land --amend --yes --------------------------------- New Message ---------------------------------- repl: add possibility to edit multiline commands while adding them

PR-URL: #58003
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Pietro Marchini <pietro.marchini94@gmail.com>

[detached HEAD 62eef37ac7] repl: add possibility to edit multiline commands while adding them
Author: Giovanni <github@puskin.it>
Date: Wed Apr 23 15:05:56 2025 +0200
7 files changed, 506 insertions(+), 53 deletions(-)
create mode 100644 test/parallel/test-repl-multiline-navigation-while-adding.js
Rebasing (3/4)
Rebasing (4/4)
Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
repl: add proper vertical cursor movements

PR-URL: #58003
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Pietro Marchini <pietro.marchini94@gmail.com>

[detached HEAD 7b279215aa] repl: add proper vertical cursor movements
Author: Giovanni <github@puskin.it>
Date: Thu May 1 10:20:17 2025 +0200
3 files changed, 121 insertions(+), 38 deletions(-)
Successfully rebased and updated refs/heads/main.

ℹ Add commit-queue-squash label to land the PR as one commit, or commit-queue-rebase to land as separate commits.

https://github.com/nodejs/node/actions/runs/14823896908

nodejs-github-bot · 2025-05-04T18:42:09Z

Landed in 5fb879c...995ad2b

PR-URL: #58003 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Pietro Marchini <pietro.marchini94@gmail.com>

aduh95 · 2025-06-10T14:23:13Z

This does not land cleanly on v22.x-staging, and would require a manual backport PR if we want it on the 22.x line.

nodejs-github-bot added needs-ci PRs that need a full CI run. readline Issues and PRs related to the built-in readline module. repl Issues and PRs related to the REPL subsystem. labels Apr 24, 2025

puskin force-pushed the repl-multiline-refactor-and-while-typing branch from 7353efd to 9aca5ed Compare April 24, 2025 12:12

puskin force-pushed the repl-multiline-refactor-and-while-typing branch 6 times, most recently from fe64915 to 4088f89 Compare April 30, 2025 14:24

BridgeAR reviewed Apr 30, 2025

View reviewed changes

puskin force-pushed the repl-multiline-refactor-and-while-typing branch from 4088f89 to 7b3c67f Compare April 30, 2025 19:32

BridgeAR reviewed Apr 30, 2025

View reviewed changes

lib/internal/readline/interface.js Outdated Show resolved Hide resolved

BridgeAR approved these changes Apr 30, 2025

View reviewed changes

BridgeAR added the request-ci Add this label to start a Jenkins CI on a PR. label Apr 30, 2025

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Apr 30, 2025

repl: add possibility to edit multiline commands while adding them

ff4639e

puskin force-pushed the repl-multiline-refactor-and-while-typing branch from 7b3c67f to ff4639e Compare May 1, 2025 06:07

BridgeAR reviewed May 1, 2025

View reviewed changes

lib/internal/readline/interface.js Outdated Show resolved Hide resolved

BridgeAR reviewed May 1, 2025

View reviewed changes

lib/internal/readline/interface.js Outdated Show resolved Hide resolved

repl: add proper vertical cursor movements

1030ce5

puskin force-pushed the repl-multiline-refactor-and-while-typing branch from 210b0da to 1030ce5 Compare May 1, 2025 17:31

BridgeAR approved these changes May 2, 2025

View reviewed changes

BridgeAR added the request-ci Add this label to start a Jenkins CI on a PR. label May 2, 2025

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label May 2, 2025

BridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label May 3, 2025

pmarchini approved these changes May 3, 2025

View reviewed changes

BridgeAR added the commit-queue Add this label to land a pull request using GitHub Actions. label May 3, 2025

nodejs-github-bot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels May 4, 2025

nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label May 4, 2025

nodejs-github-bot pushed a commit that referenced this pull request May 4, 2025

repl: add possibility to edit multiline commands while adding them

96be783

PR-URL: #58003 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Pietro Marchini <pietro.marchini94@gmail.com>

nodejs-github-bot pushed a commit that referenced this pull request May 4, 2025

repl: add proper vertical cursor movements

995ad2b

PR-URL: #58003 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Pietro Marchini <pietro.marchini94@gmail.com>

nodejs-github-bot closed this May 4, 2025

targos pushed a commit that referenced this pull request May 16, 2025

repl: add possibility to edit multiline commands while adding them

629a954

PR-URL: #58003 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Pietro Marchini <pietro.marchini94@gmail.com>

targos pushed a commit that referenced this pull request May 16, 2025

repl: add proper vertical cursor movements

714b706

PR-URL: #58003 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Pietro Marchini <pietro.marchini94@gmail.com>

github-actions bot mentioned this pull request May 20, 2025

2025-05-21, Version 24.1.0 (Current) #58406

Merged

aduh95 added the backport-requested-v22.x PRs awaiting manual backport to the v22.x-staging branch. label Jun 10, 2025

aduh95 mentioned this pull request Jun 10, 2025

readline: add stricter validation for functions called after closed (second attempt) #58283

Merged

Uh oh!

repl: add possibility to edit multiline commands while adding them #58003

repl: add possibility to edit multiline commands while adding them #58003

Uh oh!

Conversation

puskin commented Apr 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Key Features

EDIT

Uh oh!

codecov bot commented Apr 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

BridgeAR left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BridgeAR Apr 30, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

puskin commented Apr 30, 2025

Uh oh!

BridgeAR commented Apr 30, 2025

Uh oh!

Uh oh!

BridgeAR left a comment

Choose a reason for hiding this comment

Uh oh!

nodejs-github-bot commented Apr 30, 2025

Uh oh!

Uh oh!

Uh oh!

nodejs-github-bot commented May 2, 2025

Uh oh!

nodejs-github-bot commented May 2, 2025

Uh oh!

nodejs-github-bot commented May 3, 2025

Uh oh!

nodejs-github-bot commented May 3, 2025

Uh oh!

nodejs-github-bot commented May 3, 2025

Uh oh!

nodejs-github-bot commented May 4, 2025

Uh oh!

nodejs-github-bot commented May 4, 2025

PR-URL: #58003 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Pietro Marchini <pietro.marchini94@gmail.com>

PR-URL: #58003 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Pietro Marchini <pietro.marchini94@gmail.com>

[detached HEAD 7b279215aa] repl: add proper vertical cursor movements Author: Giovanni <github@puskin.it> Date: Thu May 1 10:20:17 2025 +0200 3 files changed, 121 insertions(+), 38 deletions(-) Successfully rebased and updated refs/heads/main.

Uh oh!

nodejs-github-bot commented May 4, 2025

Uh oh!

aduh95 commented Jun 10, 2025

Uh oh!

Uh oh!

puskin commented Apr 24, 2025 •

edited

Loading

codecov bot commented Apr 24, 2025 •

edited

Loading

PR-URL: #58003
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Pietro Marchini <pietro.marchini94@gmail.com>

PR-URL: #58003
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Pietro Marchini <pietro.marchini94@gmail.com>

[detached HEAD 7b279215aa] repl: add proper vertical cursor movements
Author: Giovanni <github@puskin.it>
Date: Thu May 1 10:20:17 2025 +0200
3 files changed, 121 insertions(+), 38 deletions(-)
Successfully rebased and updated refs/heads/main.